Skip to content

Commit

Permalink
Document rubyfmtignore and gitignore behavior (#357)
Browse files Browse the repository at this point in the history
  • Loading branch information
reese authored Nov 14, 2022
1 parent ed99cc4 commit a65b40b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Rubyfmt supports the following CLI invocations:
* `rubyfmt --header-opt-in -- files or directories` to format files only with a `# rubyfmt: true` comment at the top of the file
* `rubyfmt --header-opt-out -- files or directories` to skip formatting files with a `# rubyfmt: false` comment at the top of the file

`rubyfmt` also supports ignoring files with a `.rubyfmtignore` file when present in the root of the working directory.
`.rubyfmtignore` uses the same syntax as `.gitignore`, so you can choose to ignore whole directories or use globs as needed.
By default, `rubyfmt` also ignores files in `.gitignore` during file traversal, but you can force these files to be formatted by using the `--include-gitignored` flag.

## Editor Support

### Vim
Expand Down

0 comments on commit a65b40b

Please sign in to comment.