From 06e6e45b43101dec86a7aecca18caa55c74004b5 Mon Sep 17 00:00:00 2001 From: Daniel Tschinder Date: Thu, 24 Sep 2020 16:56:07 +0200 Subject: [PATCH] chore(eslint): Add correct documentation --- packages/spire-plugin-eslint/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/spire-plugin-eslint/README.md b/packages/spire-plugin-eslint/README.md index ba23b849..fed889a2 100644 --- a/packages/spire-plugin-eslint/README.md +++ b/packages/spire-plugin-eslint/README.md @@ -24,6 +24,9 @@ - `command` \ Command name to run eslint on. Defaults to `lint`. - `eslintConfig` \ Default [eslint] configuration. Defaults to [`./config.js`](./config.js). + - `autosetEslintConfig` \ Decides if the plugin should automatically + create an `.eslintrc.js` file. It will only create the file if there isn't + already a config present. Defaults to `true`. - `allowCustomConfig` \ Whether to allow user-provided config. If this option is `false` and there's custom eslint config found it will throw an error. Defaults to `true`. @@ -32,7 +35,8 @@ - `allowCustomIgnore` \ Whether to allow user-provided `.eslintignore`. If this option is `false` and there's custom ignore file found it will throw an error. Defaults to `true`. - - `glob` \ Linter glob to run on precommit. Defaults to `*.js`. + - `fileExtensions` \ Extension of files eslint should scan. + Defaults to `['.js', '.jsx', '.mjs', '.ts', '.tsx']`. - CLI `npx spire lint [args]` - Passes all arguments as-is to eslint.