Skip to content

Commit

Permalink
docs: update README on configuration formats
Browse files Browse the repository at this point in the history
  • Loading branch information
TillaTheHun0 committed Dec 13, 2020
1 parent 51469da commit 83feba5
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Expand Up @@ -141,6 +141,37 @@ For example, when passing the `src/` directory and the `extensions` option is

You can disable these default ignores by setting the `noDefaultExensions` option to `true`.

### Configuration Formats

This documentation shows examples of adding configuration to `standard-engine` via the `package.json`. Alternatively, a configuration file can be used. The configuration can be provided as follows:

```js
[
'package.json',
`.pocketlintrc`,
`.pocketlintrc.json`,
`.pocketlintrc.yaml`,
`.pocketlintrc.yml`,
`.pocketlintrc.js`,
`.pocketlintrc.cjs`,
`pocketlint.config.js`,
`pocketlint.config.cjs`,
]
```

Configuration is searched for in the current directory. If configuration is not found, the parent directory is then searched, and so on until the user's home directory is reached. If configuration is still not found, the `XDG_CONFIG_HOME` is then searched for confguration. The configuration in the XDG config directory can be provided as follows:

```js
[
'pocketlint/config',
'pocketlint/config.json',
'pocketlint/config.yaml',
'pocketlint/config.yml',
'pocketlint/config.js',
'pocketlint/config.cjs'
]
```

### Ignoring Files

The paths `node_modules/**`, `*.min.js`, `coverage/**`, hidden files/folders
Expand Down

0 comments on commit 83feba5

Please sign in to comment.