No description
Find a file
2024-10-02 18:12:48 +13:00
configs Added files 2024-10-01 19:04:25 +13:00
test Added files 2024-10-01 19:04:25 +13:00
.gitignore Added files 2024-10-01 19:04:25 +13:00
eslint.config.js Added files 2024-10-01 19:04:25 +13:00
index.js Added files 2024-10-01 19:04:25 +13:00
LICENSE Initial commit 2024-09-30 19:44:33 -07:00
package.json changed package name again. 2024-10-02 18:10:05 +13:00
pnpm-lock.yaml Added files 2024-10-01 19:04:25 +13:00
README.md Updated README.md 2024-10-02 18:12:48 +13:00
tsconfig.json Added files 2024-10-01 19:04:25 +13:00

@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/parser

Usage

Create eslint.config.js file and write as follows

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.

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

Add the eslint task to package.json

{
	"scripts": {
		"eslint": "eslint './**/*.{js,jsx,ts,tsx}'"
	},
}

Run the task

npm run eslint

License

MIT License