76 lines
No EOL
1.4 KiB
Markdown
76 lines
No EOL
1.4 KiB
Markdown
# @valkyriecoms/eslint-plugin
|
|
|
|
`@valkyriecoms/eslint-plugin` is an ESLint plugin designed for Valkyriecoms developers. This plugin helps you write code that adheres to the coding style and best practices of the Valkyriecoms project.
|
|
|
|
## Installation
|
|
|
|
First, install the plugin using npm.
|
|
|
|
```bash
|
|
npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/parser
|
|
```
|
|
|
|
## Usage
|
|
|
|
Create `eslint.config.js` 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',
|
|
},
|
|
},
|
|
},
|
|
{
|
|
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,
|
|
// ...
|
|
},
|
|
}
|
|
```
|
|
|
|
Add the eslint task to `package.json`
|
|
|
|
```json:package.json
|
|
{
|
|
"scripts": {
|
|
"eslint": "eslint './**/*.{js,jsx,ts,tsx}'"
|
|
},
|
|
}
|
|
```
|
|
|
|
Run the task
|
|
|
|
```
|
|
npm run eslint
|
|
```
|
|
|
|
## License
|
|
MIT License |