Updated readme and package files

This commit is contained in:
Toastie 2024-10-03 00:06:16 +13:00
parent b6f0d89dce
commit 316d799711
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
2 changed files with 38 additions and 22 deletions

View file

@ -7,36 +7,52 @@
First, install the plugin using npm.
```bash
npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import
npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/parser
```
## Usage
Create `.eslintrc.cjs` file and write as follows
Create `eslint.config.js` file and write as follows
```javascript:.eslintrc.cjs
module.exports = {
root: true,
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
```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',
},
},
},
ignorePatterns: ['**/.eslintrc.cjs'],
extends: [
'plugin:@valkyriecoms/recommended',
],
};
{
files: ['**/*.ts', '**/*.tsx'],
languageOptions: {
parserOptions: {
ecmaVersion: 'latest',
parser: tsParser,
project: ['./tsconfig.json'],
sourceType: 'module',
tsconfigRootDir: import.meta.dirname,
},
},
},
];
```
In tsconfig, strictNullChecks must be true.
```json:tsconfig.json
{
"compilerOptions": {
...
"strictNullChecks": true,
...
},
"compilerOptions": {
// ...
"strictNullChecks": true,
// ...
},
}
```
@ -44,9 +60,9 @@ Add the eslint task to `package.json`
```json:package.json
{
"scripts": {
"eslint": "eslint . --ext .js,.jsx,.ts,.tsx"
},
"scripts": {
"eslint": "eslint './**/*.{js,jsx,ts,tsx}'"
},
}
```

View file

@ -9,7 +9,7 @@
"type": "commonjs",
"main": "index.js",
"scripts": {
"eslint": "eslint . --ext .js,.jsx,.ts,.tsx"
"eslint": "eslint ./**/*.{js,jsx,ts,tsx}"
},
"files": [
"index.js",