Skip to content

Commit

Permalink
README: added note about --use-script-input-files
Browse files Browse the repository at this point in the history
This was introduced in realm#193, now it's documented! I also added `autocorrect` to the list of available commands in the `README`.

Closes realm#334.
  • Loading branch information
NachoSoto committed Jan 11, 2016
1 parent ea11269 commit 222dcae
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,21 @@ APM.
$ swiftlint help
Available commands:
help Display general or command-specific help
lint Print lint warnings and errors for the Swift files in the current directory (default command)
rules Display the list of rules and their identifiers
version Display the current version of SwiftLint
autocorrect Automatically correct warnings and errors
help Display general or command-specific help
lint Print lint warnings and errors for the Swift files in the current directory (default command)
rules Display the list of rules and their identifiers
version Display the current version of SwiftLint
```

Run `swiftlint` in the directory containing the Swift files to lint. Directories
will be searched recursively.

If you want to specify a list of files when using `lint` or `autocorrect`
(like modified files in the working tree based on `git ls-files -m`)
you can do so by passing the option `--use-script-input-files` and setting
the `SCRIPT_INPUT_FILE_COUNT` environment variable.

## Rules

There are only a small number of rules currently implemented, but we hope the
Expand Down

0 comments on commit 222dcae

Please sign in to comment.