This commit is contained in:
Toastie (DCS Team) 2024-10-03 00:28:21 +13:00
parent 5621342dfb
commit 7675224af7
Signed by: toastie_t0ast
GPG key ID: 27F3B6855AFD40A4
5 changed files with 167 additions and 146 deletions

86
configs/javascript.js Normal file
View file

@ -0,0 +1,86 @@
import { fixupPluginRules } from '@eslint/compat';
import _import from 'eslint-plugin-import';
const jsRules = {
'indent': ['warn', 'tab', {
'SwitchCase': 1,
'MemberExpression': 1,
'flatTernaryExpressions': true,
'ArrayExpression': 'first',
'ObjectExpression': 'first',
}],
'eol-last': ['error', 'always'],
'semi': ['error', 'always'],
'semi-spacing': ['error', { 'before': false, 'after': true }],
'quotes': ['warn', 'single'],
'comma-dangle': ['warn', 'always-multiline'],
'comma-spacing': ['error', { 'before': false, 'after': true }],
'array-bracket-spacing': ['error', 'never'],
'keyword-spacing': ['error', {
'before': true,
'after': true,
}],
'key-spacing': ['error', {
'beforeColon': false,
'afterColon': true,
}],
'arrow-spacing': ['error', {
'before': true,
'after': true,
}],
'brace-style': ['error', '1tbs', {
'allowSingleLine': true,
}],
'padded-blocks': ['error', 'never'],
/* TODO: If you do not use path alias, a warning will be issued.
'no-restricted-imports': ['warn', {
'patterns': [
],
}],
*/
'eqeqeq': ['error', 'always', { 'null': 'ignore' }],
'no-multi-spaces': ['error'],
'no-var': ['error'],
'prefer-arrow-callback': ['error'],
'no-throw-literal': ['error'],
'no-param-reassign': ['warn'],
'no-constant-condition': ['warn'],
'no-empty-pattern': ['warn'],
'no-async-promise-executor': ['off'],
'no-useless-escape': ['off'],
'no-multiple-empty-lines': ['error', { 'max': 1 }],
'no-control-regex': ['warn'],
'no-empty': ['warn'],
'no-inner-declarations': ['off'],
'no-sparse-arrays': ['off'],
'nonblock-statement-body-position': ['error', 'beside'],
'object-curly-spacing': ['error', 'always'],
'space-infix-ops': ['error'],
'space-before-blocks': ['error', 'always'],
'padding-line-between-statements': [
'error',
{ 'blankLine': 'always', 'prev': 'function', 'next': '*' },
{ 'blankLine': 'always', 'prev': '*', 'next': 'function' },
],
'lines-between-class-members': 'off',
'import/no-unresolved': ['off'],
'import/no-default-export': ['warn'],
'import/order': ['warn', {
'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
}],
};
export default {
plugins: {
import: fixupPluginRules(_import),
},
settings: {
/** @see https://github.com/import-js/eslint-plugin-import/issues/2556#issuecomment-1419518561 */
'import/parsers': {
'@typescript-eslint/parser': ['.js', '.cjs', '.mjs', '.jsx'],
},
},
rules: {
...jsRules,
},
};

View file

@ -1,11 +1,10 @@
import path from 'node:path'; import path from 'node:path';
import { fileURLToPath } from 'node:url'; import { fileURLToPath } from 'node:url';
import typescriptEslint from '@typescript-eslint/eslint-plugin'; import { fixupConfigRules } from '@eslint/compat';
import tsParser from '@typescript-eslint/parser';
import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
import { FlatCompat } from '@eslint/eslintrc'; import { FlatCompat } from '@eslint/eslintrc';
import js from '@eslint/js'; import js from '@eslint/js';
import _import from 'eslint-plugin-import'; import javascript from './javascript.js';
import typescript from './typescript.js';
const __filename = fileURLToPath(import.meta.url); const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename); const __dirname = path.dirname(__filename);
@ -15,114 +14,6 @@ const compat = new FlatCompat({
allConfig: js.configs.all, allConfig: js.configs.all,
}); });
const jsRules = {
'indent': ['warn', 'tab', {
'SwitchCase': 1,
'MemberExpression': 1,
'flatTernaryExpressions': true,
'ArrayExpression': 'first',
'ObjectExpression': 'first',
}],
'eol-last': ['error', 'always'],
'semi': ['error', 'always'],
'semi-spacing': ['error', { 'before': false, 'after': true }],
'quotes': ['warn', 'single'],
'comma-dangle': ['warn', 'always-multiline'],
'comma-spacing': ['error', { 'before': false, 'after': true }],
'array-bracket-spacing': ['error', 'never'],
'keyword-spacing': ['error', {
'before': true,
'after': true,
}],
'key-spacing': ['error', {
'beforeColon': false,
'afterColon': true,
}],
'arrow-spacing': ['error', {
'before': true,
'after': true,
}],
'brace-style': ['error', '1tbs', {
'allowSingleLine': true,
}],
'padded-blocks': ['error', 'never'],
/* TODO: If you do not use path alias, a warning will be issued.
'no-restricted-imports': ['warn', {
'patterns': [
],
}],
*/
'eqeqeq': ['error', 'always', { 'null': 'ignore' }],
'no-multi-spaces': ['error'],
'no-var': ['error'],
'prefer-arrow-callback': ['error'],
'no-throw-literal': ['error'],
'no-param-reassign': ['warn'],
'no-constant-condition': ['warn'],
'no-empty-pattern': ['warn'],
'no-async-promise-executor': ['off'],
'no-useless-escape': ['off'],
'no-multiple-empty-lines': ['error', { 'max': 1 }],
'no-control-regex': ['warn'],
'no-empty': ['warn'],
'no-inner-declarations': ['off'],
'no-sparse-arrays': ['off'],
'nonblock-statement-body-position': ['error', 'beside'],
'object-curly-spacing': ['error', 'always'],
'space-infix-ops': ['error'],
'space-before-blocks': ['error', 'always'],
'padding-line-between-statements': [
'error',
{ 'blankLine': 'always', 'prev': 'function', 'next': '*' },
{ 'blankLine': 'always', 'prev': '*', 'next': 'function' },
],
'lines-between-class-members': 'off',
'import/no-unresolved': ['off'],
'import/no-default-export': ['warn'],
'import/order': ['warn', {
'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
}],
};
const tsRules = {
/* It seems that typescript-eslint does not support enforce.
'@typescript-eslint/lines-between-class-members': ['error', {
enforce: [{
blankLine: 'always',
prev: 'method',
next: '*',
}],
}],
*/
'@typescript-eslint/func-call-spacing': ['error', 'never'],
'@typescript-eslint/no-explicit-any': ['warn'],
'@typescript-eslint/no-unused-vars': ['warn'],
'@typescript-eslint/no-unnecessary-condition': ['warn'],
'@typescript-eslint/no-var-requires': ['warn'],
'@typescript-eslint/no-inferrable-types': ['warn'],
'@typescript-eslint/no-empty-function': ['off'],
'@typescript-eslint/no-non-null-assertion': ['warn'],
'@typescript-eslint/explicit-function-return-type': ['off'],
'@typescript-eslint/no-misused-promises': ['error', {
'checksVoidReturn': false,
}],
'@typescript-eslint/consistent-type-imports': 'off',
'@typescript-eslint/prefer-nullish-coalescing': [
'warn',
],
'@typescript-eslint/naming-convention': [
'error',
{
'selector': 'typeLike',
'format': ['PascalCase'],
},
{
'selector': 'typeParameter',
'format': [],
},
],
};
export default [ export default [
...fixupConfigRules(compat.extends( ...fixupConfigRules(compat.extends(
'eslint:recommended', 'eslint:recommended',
@ -135,36 +26,10 @@ export default [
)), )),
{ {
files: ['**/*.js', '**/*.cjs', '**/*.mjs', '**/*.jsx'], files: ['**/*.js', '**/*.cjs', '**/*.mjs', '**/*.jsx'],
plugins: { ...javascript,
import: fixupPluginRules(_import),
},
settings: {
/** @see https://github.com/import-js/eslint-plugin-import/issues/2556#issuecomment-1419518561 */
'import/parsers': {
'@typescript-eslint/parser': ['.js', '.cjs', '.mjs', '.jsx'],
},
},
rules: {
...jsRules,
},
}, },
{ {
files: ['**/*.ts', '**/*.tsx'], files: ['**/*.ts', '**/*.tsx'],
plugins: { ...typescript,
'@typescript-eslint': fixupPluginRules(typescriptEslint),
import: fixupPluginRules(_import),
},
languageOptions: {
parser: tsParser,
},
settings: {
'import/parsers': {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
},
rules: {
...jsRules,
...tsRules,
},
}, },
]; ];

63
configs/typescript.js Normal file
View file

@ -0,0 +1,63 @@
import typescriptEslint from '@typescript-eslint/eslint-plugin';
import tsParser from '@typescript-eslint/parser';
import { fixupPluginRules } from '@eslint/compat';
import _import from 'eslint-plugin-import';
import javascript from './javascript.js';
const tsRules = {
/* It seems that typescript-eslint does not support enforce.
'@typescript-eslint/lines-between-class-members': ['error', {
enforce: [{
blankLine: 'always',
prev: 'method',
next: '*',
}],
}],
*/
'@typescript-eslint/func-call-spacing': ['error', 'never'],
'@typescript-eslint/no-explicit-any': ['warn'],
'@typescript-eslint/no-unused-vars': ['warn'],
'@typescript-eslint/no-unnecessary-condition': ['warn'],
'@typescript-eslint/no-var-requires': ['warn'],
'@typescript-eslint/no-inferrable-types': ['warn'],
'@typescript-eslint/no-empty-function': ['off'],
'@typescript-eslint/no-non-null-assertion': ['warn'],
'@typescript-eslint/explicit-function-return-type': ['off'],
'@typescript-eslint/no-misused-promises': ['error', {
'checksVoidReturn': false,
}],
'@typescript-eslint/consistent-type-imports': 'off',
'@typescript-eslint/prefer-nullish-coalescing': [
'warn',
],
'@typescript-eslint/naming-convention': [
'error',
{
'selector': 'typeLike',
'format': ['PascalCase'],
},
{
'selector': 'typeParameter',
'format': [],
},
],
};
export default {
plugins: {
'@typescript-eslint': fixupPluginRules(typescriptEslint),
import: fixupPluginRules(_import),
},
languageOptions: {
parser: tsParser,
},
settings: {
'import/parsers': {
'@typescript-eslint/parser': ['.ts', '.tsx'],
},
},
rules: {
...javascript.rules,
...tsRules,
},
};

View file

@ -1,15 +1,22 @@
import javascript from './configs/javascript.js';
import recommended from './configs/recommended.js'; import recommended from './configs/recommended.js';
// import packageConfig from './package.json' with { type: 'json' }; import typescript from './configs/typescript.js';
/**
* TODO: I want to import attributes, but depending on the VS Code environment, an error occurs, so I put this off for now.
* @see https://github.com/microsoft/vscode-eslint/issues/1848
*/
import packageConfig from './package.json' assert { type: 'json' };
const plugin = { const plugin = {
meta: { meta: {
// name: packageConfig.name, name: packageConfig.name,
// version: packageConfig.version, version: packageConfig.version,
name: '@valkyriecoms/eslint-plugin',
version: '1.0.0',
}, },
configs: { configs: {
javascript,
recommended, recommended,
typescript,
}, },
}; };

View file

@ -1,6 +1,6 @@
{ {
"name": "@valkyriecoms/eslint-plugin", "name": "@valkyriecoms/eslint-plugin",
"version": "2.0.1", "version": "2.0.2",
"description": "An ESLint plugin designed for Valkyriecoms developers", "description": "An ESLint plugin designed for Valkyriecoms developers",
"author": "Toastie <toastie@dragonschildstudios.com", "author": "Toastie <toastie@dragonschildstudios.com",
"license": "MIT", "license": "MIT",