diff --git a/README.md b/README.md index d583f40..517e473 100644 --- a/README.md +++ b/README.md @@ -7,52 +7,36 @@ First, install the plugin using npm. ```bash -npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/parser +npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import ``` ## Usage -Create `eslint.config.js` file and write as follows +Create `.eslintrc.cjs` file and write as follows -```javascript:eslint.config.js -import pluginValkyriecoms from '@valkyriecoms/eslint-plugin'; -import tsParser from '@typescript-eslint/parser'; - -export default [ - ...pluginValkyriecoms.configs['recommended'], - { - files: ['**/*.js', '**/*.jsx'], - languageOptions: { - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - }, - }, +```javascript:.eslintrc.cjs +module.exports = { + root: true, + parserOptions: { + tsconfigRootDir: __dirname, + project: ['./tsconfig.json'], }, - { - files: ['**/*.ts', '**/*.tsx'], - languageOptions: { - parserOptions: { - ecmaVersion: 'latest', - parser: tsParser, - project: ['./tsconfig.json'], - sourceType: 'module', - tsconfigRootDir: import.meta.dirname, - }, - }, - }, -]; + ignorePatterns: ['**/.eslintrc.cjs'], + extends: [ + 'plugin:@valkyriecoms/recommended', + ], +}; ``` In tsconfig, strictNullChecks must be true. ```json:tsconfig.json { - "compilerOptions": { - // ... - "strictNullChecks": true, - // ... - }, + "compilerOptions": { + ... + "strictNullChecks": true, + ... + }, } ``` @@ -60,9 +44,9 @@ Add the eslint task to `package.json` ```json:package.json { - "scripts": { - "eslint": "eslint './**/*.{js,jsx,ts,tsx}'" - }, + "scripts": { + "eslint": "eslint . --ext .js,.jsx,.ts,.tsx" + }, } ```