Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Docs: Fix the format option name in the document (#13770)
  • Loading branch information
ganta committed Oct 20, 2020
1 parent 84fd591 commit b025795
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/developer-guide/working-with-custom-formatters.md
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

0 comments on commit b025795

Please sign in to comment.