eslint-plugin-valkyriecoms/README.md

@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.

npm install --save-dev eslint @valkyriecoms/eslint-plugin @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-import

Usage

Create .eslintrc.cjs file and write as follows

module.exports = {
	root: true,
	parserOptions: {
		tsconfigRootDir: __dirname,
		project: ['./tsconfig.json'],
	},
	ignorePatterns: ['**/.eslintrc.cjs'],
	extends: [
		'plugin:@valkyriecoms/recommended',
	],
};

In tsconfig, strictNullChecks must be true.

{
    "compilerOptions": {
        ...
        "strictNullChecks": true,
        ...
    },
}

Add the eslint task to package.json

{
  "scripts": {
    "eslint": "eslint . --ext .js,.jsx,.ts,.tsx"
  },
}

Run the task

npm run eslint

License

MIT License