diff --git a/.wokeignore.example b/.wokeignore.example new file mode 100644 index 00000000..8c6b3230 --- /dev/null +++ b/.wokeignore.example @@ -0,0 +1,27 @@ +# Dependencies and locks # +########################## +vendor/ +node_modules/ +.node_modules/ +yarn.lock +package-lock.json +Pipfile.lock +Cargo.lock +Gemfile.lock +Packages/ +Package.pins +Package.resolved + +# Test and debug output # +######################### +fastlane/report.xml +fastlane/test_output +hs_err_pid* +htmlcov/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +.hypothesis/ +.pytest_cache/ diff --git a/README.md b/README.md index 060d9e29..b3ad4d03 100644 --- a/README.md +++ b/README.md @@ -278,6 +278,8 @@ ignore_files: You may also specify a `.wokeignore` file at the root of the directory to add additional ignore files. This also follows the [gitignore](https://git-scm.com/docs/gitignore) convention. +See [.wokeignore.example](.wokeignore.example) for a collection of common files and directories that may contain generated [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithms) and [GUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s. Dependency directories are also shown in the example as the linter will parse dependency source code and possibly find errors. + #### In-line ignoring There may be times where you don't want to ignore an entire file.