Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Fix the format option name in the document #13770

Merged
merged 1 commit into from Oct 20, 2020
Merged

Docs: Fix the format option name in the document #13770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/developer-guide/working-with-custom-formatters.md
View file
Open in desktop
Expand Up @@ -11,7 +11,7 @@ module.exports = function(results) {
};
```

To run ESLint with this formatter, you can use the `-f` (or `--formatter`) command line flag:
To run ESLint with this formatter, you can use the `-f` (or `--format`) command line flag:

```bash
eslint -f ./my-awesome-formatter.js src/
Expand Down Expand Up @@ -50,7 +50,7 @@ The [Using Rule metadata](#using-rule-metadata) example shows how to use the `da

## Packaging the Custom Formatter

Custom formatters can also be distributed through npm packages. To do so, create an npm package with a name in the format of `eslint-formatter-*`, where `*` is the name of your formatter (such as `eslint-formatter-awesome`). Projects should then install the package and can use the custom formatter with the `-f` (or `--formatter`) flag like this:
Custom formatters can also be distributed through npm packages. To do so, create an npm package with a name in the format of `eslint-formatter-*`, where `*` is the name of your formatter (such as `eslint-formatter-awesome`). Projects should then install the package and can use the custom formatter with the `-f` (or `--format`) flag like this:

```bash
eslint -f awesome src/
Expand Down