Skip to content

Commit

Permalink
docs(readme): Add new configType option to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onigoetz committed Dec 25, 2023
1 parent 66e1e8c commit 796ae62
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -106,6 +106,25 @@ type cacheLocation = string;

Specify the path to the cache location. Can be a file or a directory.

### `configType`

- Type:

```ts
type configType = "flat" | "eslintrc";
```

- Default: `eslintrc`

Specify the type of configuration to use with ESLint.
- `eslintrc` is the classic configuration format available in most ESLint versions.
- `flat` is the new format introduced in ESLint 8.21.0.

The new configuration format is explained in its [own documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new).

> This configuration format being considered as experimental, it is not exported in the main ESLint module in ESLint 8.
> You need to set your `eslintPath` to `eslint/use-at-your-own-risk` for this config format to work.
### `context`

- Type:
Expand Down
8 changes: 4 additions & 4 deletions src/options.json
Expand Up @@ -2,6 +2,10 @@
"type": "object",
"additionalProperties": true,
"properties": {
"configType": {
"description": "Enable flat config by setting this value to `flat`.",
"type": "string"
},
"context": {
"description": "A string indicating the root of your files.",
"type": "string"
Expand Down Expand Up @@ -58,10 +62,6 @@
"description": "Will process and report errors only and ignore warnings, if set to `true`.",
"type": "boolean"
},
"configType": {
"description": "Enable flat config by setting this value to `flat`.",
"type": "string"
},
"outputReport": {
"description": "Write the output of the errors to a file, for example a checkstyle xml file for use for reporting on Jenkins CI",
"anyOf": [
Expand Down

0 comments on commit 796ae62

Please sign in to comment.