Skip to content

Commit

Permalink
Adding wokeignore example file (#115)
Browse files Browse the repository at this point in the history
* Expanding to include generated files

* Limiting ignores to common files, remove * ignores

* Adding readme documentation to reference example

* Adding readme documentation to reference example

* Adding additional doc comments
  • Loading branch information
kevinleung23 authored Jul 27, 2021
1 parent 98db9d7 commit 4c894f2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .wokeignore.example
Original file line number Diff line number Diff line change
@@ -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/
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4c894f2

Please sign in to comment.