aet/eslint-rules
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: aet:235cf4101bd5bcf46d2e7a3175509f6bfacafc49
Branches Tags
aet:main aet:flat aet:inline
...
compare: aet:main
Branches Tags
aet:main aet:flat aet:inline

16 Commits
235cf4101b ... main

Author SHA1 Message Date
Alex
c38449c759 Bump 2025-06-12 21:59:23 -04:00
Alex
d7e9b986c7 Bump 2025-06-07 20:32:51 -04:00
Alex
d06cd4937c Bump deps 2025-05-24 17:38:09 -04:00
Alex
a746e2fbc8 Bump version 2025-05-10 19:13:52 -04:00
Alex
9b4a6cb498 Bump deps 2025-04-27 01:01:23 -04:00
Alex
d7990e5cf1 Update 2025-02-26 14:00:41 -05:00
Alex
cddee19340 Bump 2025-02-05 18:55:12 -05:00
Alex
c2d582dea0 Update 2025-01-25 19:44:09 -05:00
Alex
8824c2166d Bump 2024-12-28 18:34:57 -05:00
Alex
51df8a9a2c Bump 2024-12-15 21:38:43 -05:00
Alex
1e56001e78 New version 2024-12-15 02:30:34 -05:00
Alex
2b4c3038b3 Update 2024-12-12 19:48:39 -05:00
Alex
eb5f72a049 Bump 2024-12-08 19:14:11 -05:00
Alex
952914699b Bump version and fix glob 2024-12-01 17:51:52 -05:00
Alex
78ed00fd21 Bump version 2024-11-28 23:27:52 -05:00
Alex
43d9cc294e add default 2024-11-23 17:04:14 -05:00
33 changed files with 3302 additions and 2444 deletions
Expand all files Collapse all files

1
.gitignore vendored
View File

@ -8,6 +8,7 @@ src/types/rules
dist2
dist/**/*.js
dist/**/*.js.map
!dist/default.js
# Logs
logs

14
dist/config/index.d.ts vendored
View File

@ -7,6 +7,17 @@ export type Middleware =
| (() => Promise<MiddlewareResult>)
| (() => Promise<{ default: MiddlewareResult }>);
export type Environment =
| 'jsdoc'
| 'lingui'
| 'react'
| 'reactQuery'
| 'reactRefresh'
| 'storybook'
| 'tailwind'
| 'testingLibrary'
| 'vitest';
export interface NormalizedExtendConfigOptions {
auto?: boolean;
middlewares?: Middleware[];
@ -15,6 +26,9 @@ export interface NormalizedExtendConfigOptions {
* Use `.gitignore` file to exclude files from ESLint.
*/
gitignore?: boolean;
env?: {
[key in Environment]?: boolean;
};
}
export type ExtendConfigOptions =

5
dist/default.d.ts vendored Normal file
View File

@ -0,0 +1,5 @@
import type { FlatESLintConfig } from '@aet/eslint-define-config';
declare const _default: FlatESLintConfig[];
export default _default;

3
dist/default.js vendored Normal file
View File

@ -0,0 +1,3 @@
import { extendConfig } from './config/index.js';
export default await extendConfig();

2
dist/eslint-init.sh vendored Normal file
View File

@ -0,0 +1,2 @@
#!/bin/bash
echo 'export { default } from "@aet/eslint-rules/default";' > eslint.config.js

67
dist/package.json vendored
View File

@ -1,61 +1,68 @@
{
"name": "@aet/eslint-rules",
"version": "2.0.10",
"version": "2.0.51",
"license": "UNLICENSED",
"type": "module",
"bin": {
"eslint-init": "eslint-init.sh",
"eslint-install": "install.js",
"eslint-print": "print-config.sh"
},
"main": "./config/index.js",
"peerDependencies": {
"eslint": "^9.15.0",
"typescript": "^5.6.3"
"typescript": "^5.7.2"
},
"exports": {
".": "./config/index.js",
"./default": "./default.js",
"./prettier": "./prettier.js",
"./tsconfig": "./tsconfig.json",
"./types": "./types.js"
},
"optionalDependencies": {
"@tanstack/eslint-plugin-query": "^5.59.7"
"@tanstack/eslint-plugin-query": "^5.62.1"
},
"dependencies": {
"@antfu/install-pkg": "^0.4.1",
"@aet/eslint-define-config": "^0.1.15",
"@antfu/install-pkg": "^1.1.0",
"@eslint-community/eslint-utils": "^4.7.0",
"@eslint-react/eslint-plugin": "1.51.3",
"@eslint/js": "^9.28.0",
"@nolyfill/is-core-module": "^1.0.39",
"@aet/eslint-define-config": "^0.1.0-beta.36",
"@eslint/js": "^9.15.0",
"@eslint-community/eslint-utils": "^4.4.1",
"@eslint-react/eslint-plugin": "1.17.1",
"@stylistic/eslint-plugin": "^2.11.0",
"@types/eslint": "^9.6.1",
"@typescript-eslint/eslint-plugin": "^8.15.0",
"@typescript-eslint/parser": "^8.15.0",
"@typescript-eslint/type-utils": "^8.15.0",
"@typescript-eslint/utils": "^8.15.0",
"@stylistic/eslint-plugin": "^4.4.1",
"@typescript-eslint/eslint-plugin": "^8.34.0",
"@typescript-eslint/parser": "^8.34.0",
"@typescript-eslint/type-utils": "^8.34.0",
"@typescript-eslint/utils": "^8.34.0",
"aria-query": "^5.3.2",
"axe-core": "^4.10.2",
"axe-core": "^4.10.3",
"axobject-query": "4.1.0",
"damerau-levenshtein": "1.0.8",
"debug": "^4.3.7",
"debug": "^4.4.1",
"doctrine": "^3.0.0",
"emoji-regex": "^10.4.0",
"enhanced-resolve": "^5.17.1",
"typescript-eslint": "^8.15.0",
"eslint-config-prettier": "^9.1.0",
"enhanced-resolve": "^5.18.1",
"eslint-config-prettier": "^10.1.5",
"eslint-import-resolver-node": "^0.3.9",
"eslint-import-resolver-typescript": "^3.6.3",
"eslint-import-resolver-typescript": "^4.4.3",
"eslint-module-utils": "^2.12.0",
"eslint-plugin-import-x": "^4.4.3",
"eslint-plugin-unicorn": "^56.0.1",
"eslint-plugin-import-x": "^4.15.1",
"eslint-plugin-regexp": "^2.9.0",
"eslint-plugin-unicorn": "^59.0.1",
"esprima": "^4.0.1",
"esquery": "^1.6.0",
"estraverse": "^5.3.0",
"fast-glob": "^3.3.2",
"get-tsconfig": "^4.8.1",
"globals": "^15.12.0",
"ignore": "^6.0.2",
"is-bun-module": "^1.2.1",
"fast-glob": "^3.3.3",
"get-tsconfig": "^4.10.1",
"globals": "^16.2.0",
"ignore": "^7.0.5",
"is-bun-module": "^2.0.0",
"is-glob": "^4.0.3",
"language-tags": "^1.0.9",
"language-tags": "^2.1.0",
"lodash-es": "^4.17.21",
"minimatch": "^10.0.1",
"semver": "^7.6.3"
"semver": "^7.7.2",
"typescript-eslint": "^8.34.0"
},
"pnpm": {
"overrides": {

19
dist/tsconfig.json vendored Normal file
View File

@ -0,0 +1,19 @@
{
"compilerOptions": {
"allowArbitraryExtensions": true,
"allowImportingTsExtensions": true,
"jsx": "react-jsx",
"module": "Preserve",
"moduleResolution": "Bundler",
"noEmit": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"resolveJsonModule": true,
"strict": true,
"stripInternal": true,
"target": "ESNext",
"verbatimModuleSyntax": true
}
}

136
package.json
View File

@ -6,71 +6,93 @@
"build": "./scripts/build.ts",
"check-import": "./scripts/check-imports.ts",
"define": "/usr/local/bin/codium ./packages/eslint-define-config",
"do": "yarn build; (cd dist && ver bump && npm publish && ver unpub)"
"sync": "./scripts/sync-deps.ts",
"do": "(cd dist && ver bump && npm publish && ver unpub)"
},
"private": true,
"devDependencies": {
"@aet/eslint-define-config": "^0.1.0-beta.36",
"@antfu/install-pkg": "^0.4.1",
"@babel/core": "^7.26.0",
"@babel/plugin-transform-flow-strip-types": "^7.25.9",
"@babel/preset-env": "^7.26.0",
"@eslint-react/eslint-plugin": "^1.17.1",
"@eslint/js": "^9.15.0",
"@graphql-eslint/eslint-plugin": "^3.20.1",
"@stylistic/eslint-plugin": "^2.11.0",
"@swc-node/register": "^1.10.9",
"@tanstack/eslint-plugin-query": "^5.60.1",
"@types/babel-plugin-macros": "^3.1.3",
"@types/babel__core": "^7.20.5",
"@types/eslint": "^9.6.1",
"@types/eslint-config-prettier": "^6.11.3",
"@types/eslint-plugin-tailwindcss": "^3.17.0",
"@types/eslint__js": "^8.42.3",
"@types/esprima": "^4.0.6",
"@types/esquery": "^1.5.4",
"@types/estree": "^1.0.6",
"@types/estree-jsx": "^1.0.5",
"@types/lodash-es": "^4.17.12",
"@types/node": "^22.9.3",
"@types/react-refresh": "^0.14.6",
"@typescript-eslint/eslint-plugin": "^8.15.0",
"@typescript-eslint/parser": "^8.15.0",
"@typescript-eslint/type-utils": "^8.15.0",
"@typescript-eslint/types": "^8.15.0",
"@typescript-eslint/typescript-estree": "^8.15.0",
"@typescript-eslint/utils": "^8.15.0",
"babel-plugin-macros": "^3.1.0",
"dts-bundle-generator": "9.5.1",
"esbuild": "0.24.0",
"esbuild-plugin-alias": "^0.2.1",
"eslint": "9.15.0",
"eslint-config-prettier": "^9.1.0",
"eslint-import-resolver-typescript": "^3.6.3",
"eslint-plugin-import-x": "^4.4.3",
"eslint-plugin-jsdoc": "^50.5.0",
"eslint-plugin-react-refresh": "^0.4.14",
"eslint-plugin-storybook": "canary",
"eslint-plugin-testing-library": "^6.5.0",
"eslint-plugin-unicorn": "^56.0.1",
"eslint-plugin-vitest": "^0.5.4",
"dependencies": {
"@aet/eslint-define-config": "^0.1.16",
"@antfu/install-pkg": "^1.1.0",
"@eslint-community/eslint-utils": "^4.7.0",
"@eslint-react/eslint-plugin": "1.52.2",
"@eslint/js": "^9.28.0",
"@nolyfill/is-core-module": "^1.0.39",
"@stylistic/eslint-plugin": "^4.4.1",
"@typescript-eslint/eslint-plugin": "^8.34.0",
"@typescript-eslint/parser": "^8.34.0",
"@typescript-eslint/type-utils": "^8.34.0",
"@typescript-eslint/utils": "^8.34.0",
"aria-query": "^5.3.2",
"axe-core": "^4.10.3",
"axobject-query": "4.1.0",
"damerau-levenshtein": "1.0.8",
"debug": "^4.4.1",
"doctrine": "^3.0.0",
"emoji-regex": "^10.4.0",
"enhanced-resolve": "^5.18.1",
"eslint-config-prettier": "^10.1.5",
"eslint-import-resolver-node": "^0.3.9",
"eslint-import-resolver-typescript": "^4.4.3",
"eslint-module-utils": "^2.12.0",
"eslint-plugin-import-x": "^4.15.2",
"eslint-plugin-regexp": "^2.9.0",
"eslint-plugin-unicorn": "^59.0.1",
"esprima": "^4.0.1",
"esquery": "^1.6.0",
"fast-glob": "^3.3.2",
"find-cache-dir": "^5.0.0",
"globals": "^15.12.0",
"graphql": "^16.9.0",
"json-schema-to-ts": "^3.1.1",
"estraverse": "^5.3.0",
"fast-glob": "^3.3.3",
"get-tsconfig": "^4.10.1",
"globals": "^16.2.0",
"ignore": "^7.0.5",
"is-bun-module": "^2.0.0",
"is-glob": "^4.0.3",
"language-tags": "^2.1.0",
"lodash-es": "^4.17.21",
"nolyfill": "^1.0.42",
"minimatch": "^10.0.3",
"semver": "^7.7.2",
"typescript-eslint": "^8.34.0"
},
"devDependencies": {
"@babel/core": "^7.27.4",
"@babel/plugin-transform-flow-strip-types": "^7.27.1",
"@babel/preset-env": "^7.27.2",
"@graphql-eslint/eslint-plugin": "^4.4.0",
"@swc-node/register": "^1.10.10",
"@tanstack/eslint-plugin-query": "^5.78.0",
"@types/babel-plugin-macros": "^3.1.3",
"@types/babel__core": "^7.20.5",
"@types/eslint-config-prettier": "^6.11.3",
"@types/eslint-plugin-tailwindcss": "^3.17.0",
"@types/esprima": "^4.0.6",
"@types/esquery": "^1.5.4",
"@types/estree": "^1.0.8",
"@types/estree-jsx": "^1.0.5",
"@types/lodash-es": "^4.17.12",
"@types/node": "^22.15.30",
"@types/react-refresh": "^0.14.6",
"@typescript-eslint/types": "^8.34.0",
"@typescript-eslint/typescript-estree": "^8.34.0",
"@vitest/eslint-plugin": "^1.2.4",
"babel-plugin-macros": "^3.1.0",
"dts-bundle-generator": "9.5.1",
"esbuild": "0.25.5",
"esbuild-plugin-alias": "^0.2.1",
"eslint": "^9.28.0",
"eslint-plugin-jsdoc": "^50.7.1",
"eslint-plugin-lingui": "^0.10.1",
"eslint-plugin-react-refresh": "^0.4.20",
"eslint-plugin-storybook": "^9.0.9",
"eslint-plugin-testing-library": "^7.5.2",
"graphql": "^16.11.0",
"json-schema-to-ts": "^3.1.1",
"nolyfill": "^1.0.44",
"patch-package": "^8.0.0",
"picocolors": "^1.1.1",
"prettier": "^3.3.3",
"prettier": "^3.5.3",
"prop-types": "^15.8.1",
"terser": "^5.36.0",
"type-fest": "^4.27.1",
"typescript": "^5.7.2",
"typescript-eslint": "^8.15.0"
"terser": "^5.42.0",
"type-fest": "^4.41.0",
"typescript": "^5.8.3"
},
"prettier": {
"arrowParens": "avoid",

1
packages/eslint-import-resolver-typescript

Submodule packages/eslint-import-resolver-typescript deleted from 3dfad602a0

2
packages/eslint-plugin-jsx-a11y

Submodule packages/eslint-plugin-jsx-a11y updated: cca288b73a...a7d1a12a61

2
packages/eslint-plugin-n

Submodule packages/eslint-plugin-n updated: 6744257b43...42464abe64

2
packages/jsx-ast-utils

Submodule packages/jsx-ast-utils updated: 5943318eaf...a8ca8f7033

2
patch/eslint-plugin-jsx-a11y.patch
View File

@ -206,7 +206,7 @@ index df7b6b8..c4d0da1 100644
attributes: {
autocomplete,
diff --git a/src/rules/label-has-associated-control.js b/src/rules/label-has-associated-control.js
index dd6b199..184199e 100644
index d65abe9..22ecee7 100644
--- a/src/rules/label-has-associated-control.js
+++ b/src/rules/label-has-associated-control.js
@@ -11,7 +11,7 @@

5150
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

1
scripts/build.ts
View File

@ -86,7 +86,6 @@ async function bundle(
plugins,
define: {},
alias: {},
external: ['find-cache-dir'],
format: 'esm',
banner: {
js: '/* eslint-disable */',

1
scripts/pull.sh
View File

@ -20,7 +20,6 @@ pull() {
echo
}
pull import-js eslint-import-resolver-typescript
pull jsx-eslint eslint-plugin-jsx-a11y
pull eslint-community eslint-plugin-n
pull jsx-eslint jsx-ast-utils

14
scripts/sync-deps.ts Executable file
View File

@ -0,0 +1,14 @@
#!/usr/bin/env node
import fs from 'node:fs';
const up = JSON.parse(
fs.readFileSync('package.json', 'utf8'),
) as typeof import('../package.json');
const down = JSON.parse(
fs.readFileSync('dist/package.json', 'utf8'),
) as typeof import('../dist/package.json');
down.dependencies = up.dependencies;
fs.writeFileSync('dist/package.json', JSON.stringify(down, null, 2));

24
src/commits.json
View File

@ -5,23 +5,17 @@
"committer": "Jordan Harband",
"subject": "[meta] add `repository.directory` field"
},
"eslint-import-resolver-typescript": {
"hash": "42e7cc3eb413dda56683c1b2b2483e4756e0bd62",
"date": "2024-11-01T01:52:08+00:00",
"committer": "GitHub",
"subject": "chore(deps): update dependency @types/node to ^18.19.63 (#320)"
},
"eslint-plugin-jsx-a11y": {
"hash": "7566e13531f09a040daee4c16d0cba0c28d321c4",
"date": "2024-11-17T09:51:03-08:00",
"hash": "a7d1a12a6198d546c4a06477b385b4fde03b762e",
"date": "2025-06-05T12:28:53-07:00",
"committer": "Jordan Harband",
"subject": "[Deps] update `axe-core`"
"subject": "[Tests] fix linting errors introduced in 2d9ad55"
},
"eslint-plugin-n": {
"hash": "ccf5f9e482c32f2fd2d5f78649d7f837a5db8870",
"date": "2024-11-21T21:05:02+01:00",
"hash": "42464abe64c5cefb709e8e0a9072b6bb1cd7fcdc",
"date": "2025-06-13T01:37:54+08:00",
"committer": "GitHub",
"subject": "chore(master): release 17.14.0 (#387)"
"subject": "chore(master): release 17.20.0 (#448)"
},
"eslint-plugin-react": {
"hash": "983b88dd3cb5e07919517d3fde4085f60883ded7",
@ -30,9 +24,9 @@
"subject": "[Tests] `no-array-index-key`: actually run valid tests"
},
"jsx-ast-utils": {
"hash": "5943318eaf23764eec3ff397ebb969613d728a95",
"date": "2023-07-28T18:34:04-07:00",
"hash": "a8ca8f70331b02db537b0b5cf72ea10e3d6c9377",
"date": "2025-02-20T08:51:06-08:00",
"committer": "Jordan Harband",
"subject": "v3.3.5"
"subject": "[Dev Deps] pin `psl` due to breaking change in a minor version"
}
}

14
src/config.d.ts vendored
View File

@ -7,6 +7,17 @@ export type Middleware =
| (() => Promise<MiddlewareResult>)
| (() => Promise<{ default: MiddlewareResult }>);
export type Environment =
| 'jsdoc'
| 'lingui'
| 'react'
| 'reactQuery'
| 'reactRefresh'
| 'storybook'
| 'tailwind'
| 'testingLibrary'
| 'vitest';
export interface NormalizedExtendConfigOptions {
auto?: boolean;
middlewares?: Middleware[];
@ -15,6 +26,9 @@ export interface NormalizedExtendConfigOptions {
* Use `.gitignore` file to exclude files from ESLint.
*/
gitignore?: boolean;
env?: {
[key in Environment]?: boolean;
};
}
export type ExtendConfigOptions =

16
src/custom/index.ts
View File

@ -3,6 +3,7 @@ import type { ESLint } from 'eslint';
import noEmptyObjectLiteral from './no-empty-object-literal';
import noImportDot from './no-import-dot';
import noUselessImportAlias from './no-useless-import-alias';
import requireImportAttribute from './require-import-attribute';
import restrictTemplateExpressions from './restrict-template-expressions';
type RuleLevel = 'error' | 'warn' | 'off' | 0 | 1 | 2;
@ -10,29 +11,32 @@ type RuleEntry<Options> = RuleLevel | [RuleLevel, Partial<Options>];
export interface LocalRuleOptions {
/** Bans import from the specifier '.' and '..' and replaces it with '.+/index' */
'custom/no-import-dot': RuleEntry<unknown>;
'aet/no-import-dot': RuleEntry<unknown>;
/**
* Enforce template literal expressions to be of `string` type
* @see [restrict-template-expressions](https://typescript-eslint.io/rules/restrict-template-expressions)
*/
'typed-custom/restrict-template-expressions': RuleEntry<{ allow: string[] }>;
'typed-aet/restrict-template-expressions': RuleEntry<{ allow: string[] }>;
/** Ban assignment of empty object literals `{}` and replace them with `Object.create(null)` */
'custom/no-empty-object-literal': RuleEntry<unknown>;
'aet/no-empty-object-literal': RuleEntry<unknown>;
/** Ban useless import alias */
'custom/no-useless-import-alias': RuleEntry<unknown>;
'aet/no-useless-import-alias': RuleEntry<unknown>;
/** Require the use of `{ type: "json" }` for JSON imports. */
'aet/require-import-attribute': RuleEntry<unknown>;
}
export const plugin: ESLint.Plugin = {
name: 'custom',
name: 'aet',
rules: {
'no-empty-object-literal': noEmptyObjectLiteral,
'no-import-dot': noImportDot,
'no-useless-import-alias': noUselessImportAlias,
'require-import-attribute': requireImportAttribute,
},
};
export const typedPlugin: ESLint.Plugin = {
name: 'typed-custom',
name: 'typed-aet',
rules: {
// @ts-expect-error type mismatch
'restrict-template-expressions': restrictTemplateExpressions,

61
src/custom/require-import-attribute.ts Normal file
View File

@ -0,0 +1,61 @@
import type { Rule } from 'eslint';
import type { Identifier, SimpleLiteral } from 'estree';
interface ImportAttribute {
key: Identifier | SimpleLiteral;
value: SimpleLiteral;
}
const requireImportAttribute: Rule.RuleModule = {
meta: {
type: 'problem',
docs: {
description:
'Requires JSON imports to have a "with { type: \'json\' }" import attribute.',
category: 'Possible Errors',
recommended: false,
},
fixable: 'code',
schema: [],
messages: {
missingJsonTypeAttribute:
'JSON imports must have a "with { type: \'json\' }" import attribute.',
},
},
create(context) {
return {
ImportDeclaration(node) {
// Only check modules that end with ".json"
if (
typeof node.source.value === 'string' &&
node.source.value.endsWith('.json')
) {
// Cast the node to our extended interface to access the assertions.
const importNode = node;
const assertions = (
importNode as {
assertions?: ImportAttribute[];
}
).assertions;
const hasJsonType = assertions?.some(attr => {
const keyName =
(attr.key as Identifier).name ?? (attr.key as SimpleLiteral).value;
return keyName === 'type' && attr.value.value === 'json';
});
if (!hasJsonType) {
context.report({
node,
messageId: 'missingJsonTypeAttribute',
fix: fixer =>
fixer.insertTextAfterRange(node.source.range!, ' with { type: "json" }'),
});
}
}
},
};
},
};
export default requireImportAttribute;

62
src/environment.ts
View File

@ -1,63 +1,76 @@
import fs from 'node:fs';
import path from 'node:path';
import type { Environment, NormalizedExtendConfigOptions } from './config';
import type { Middleware } from './middleware';
import { reactQuery, storybook, vitest } from './presets/misc';
import { react, reactRefresh } from './presets/react';
const jsdoc = () => import('./presets/jsdoc');
const tailwind = () => import('./presets/tailwind');
const testingLibrary = () => import('./presets/testing-library');
type Pkg = typeof import('../package.json');
type Dependency = keyof Pkg['dependencies'] | RemoveType<keyof Pkg['devDependencies']>;
const middlewares = {
type RemoveType<T extends string> = T extends `@types/${infer U}__${infer V}`
? `@${U}/${V}`
: T extends `@types/${infer U}`
? U
: T;
export const middlewares = {
react,
reactRefresh,
tailwind,
tailwind: () => import('./presets/tailwind'),
storybook,
reactQuery,
testingLibrary,
jsdoc,
testingLibrary: () => import('./presets/testing-library'),
jsdoc: () => import('./presets/jsdoc'),
vitest,
lingui: () => import('./presets/lingui'),
} satisfies {
[key: string]: Middleware;
[key in Environment]: Middleware;
};
export const envs: {
dependency: string;
eslintPlugin?: string;
dependency: string[];
eslintPlugin?: Dependency;
middleware: keyof typeof middlewares;
}[] = [
{
dependency: 'react',
dependency: ['react'],
middleware: 'react',
},
{
dependency: '@vitejs/plugin-react',
dependency: ['@vitejs/plugin-react', '@vitejs/plugin-react-swc'],
eslintPlugin: 'eslint-plugin-react-refresh',
middleware: 'reactRefresh',
},
{
dependency: 'tailwindcss',
dependency: ['tailwindcss'],
eslintPlugin: 'eslint-plugin-tailwindcss',
middleware: 'tailwind',
},
{
dependency: 'storybook',
dependency: ['storybook'],
eslintPlugin: 'eslint-plugin-storybook',
middleware: 'storybook',
},
{
dependency: '@tanstack/react-query',
dependency: ['@lingui/core', '@lingui/react'],
eslintPlugin: 'eslint-plugin-lingui',
middleware: 'lingui',
},
{
dependency: ['@tanstack/react-query'],
eslintPlugin: '@tanstack/eslint-plugin-query',
middleware: 'reactQuery',
},
{
dependency: '@testing-library/react',
dependency: ['@testing-library/react'],
eslintPlugin: 'eslint-plugin-testing-library',
middleware: 'testingLibrary',
},
{
dependency: 'vitest',
eslintPlugin: 'eslint-plugin-vitest',
dependency: ['vitest'],
eslintPlugin: '@vitest/eslint-plugin',
middleware: 'vitest',
},
];
@ -87,8 +100,19 @@ export function* checkEnv(): Generator<Middleware> {
const deps = getProjectDependencies();
for (const { dependency, eslintPlugin, middleware } of envs) {
if (deps.has(dependency) && (!eslintPlugin || deps.has(eslintPlugin))) {
if (
dependency.some(dep => deps.has(dep)) &&
(!eslintPlugin || deps.has(eslintPlugin))
) {
yield middlewares[middleware];
}
}
}
export function* fromEnvironments(envs: NormalizedExtendConfigOptions['env']) {
for (const [env, enabled] of Object.entries(envs ?? {}) as [Environment, boolean][]) {
if (enabled) {
yield middlewares[env];
}
}
}

26
src/index.ts
View File

@ -1,16 +1,18 @@
/* eslint-disable import-x/no-named-as-default-member */
import fs from 'node:fs';
import type { FlatESLintConfig } from '@aet/eslint-define-config';
import * as tsParser from '@typescript-eslint/parser';
import prettier from 'eslint-config-prettier';
import importPlugin from 'eslint-plugin-import-x';
import * as regexpPlugin from 'eslint-plugin-regexp';
import { uniq } from 'lodash-es';
import tseslint from 'typescript-eslint';
import type { ExtendConfigOptions, NormalizedExtendConfigOptions } from './config';
import { off } from './constants';
import { checkEnv } from './environment';
import { Middleware } from './middleware';
import { checkEnv, fromEnvironments } from './environment';
import type { Middleware } from './middleware';
import { eslintRules } from './presets/eslint';
import stylistic from './presets/stylistic';
import { importRules, typescriptRules } from './presets/typescript';
@ -32,6 +34,7 @@ function normalizeExtendConfig(
middlewares = [],
configs = [],
gitignore = true,
env,
} = options as NormalizedExtendConfigOptions;
return {
@ -39,6 +42,7 @@ function normalizeExtendConfig(
middlewares,
configs,
gitignore,
env,
};
}
@ -50,14 +54,15 @@ export async function extendConfig(
middlewares: addMiddlewares = [],
configs,
gitignore,
env,
} = normalizeExtendConfig(options);
const middlewares: Middleware[] = uniq([
() => import('./presets/custom'),
...(auto ? checkEnv() : []),
...fromEnvironments(env),
...addMiddlewares,
]);
const result: FlatESLintConfig[] = [
{
name: 'eslint-rules/eslint',
@ -69,6 +74,17 @@ export async function extendConfig(
importPlugin.flatConfigs.typescript,
...unicorn,
stylistic,
{
plugins: { regexp: regexpPlugin },
rules: {
...regexpPlugin.configs['flat/recommended'].rules,
// https://github.com/ota-meshi/eslint-plugin-regexp/issues/445
'regexp/strict': off,
'regexp/match-any': off,
// https://github.com/ota-meshi/eslint-plugin-regexp/issues/743
'regexp/letter-case': off,
},
},
{
name: 'eslint-rules/typescript-and-import-x',
files: ['**/*.{js,mjs,cjs,jsx,ts,tsx,mts,cts}'],
@ -99,7 +115,7 @@ export async function extendConfig(
},
{
name: 'eslint-rules: Disable type checking',
files: ['*.js', '*.mjs', '*.cjs', '*.jsx'],
files: ['**/*.js', '**/*.mjs', '**/*.cjs', '**/*.jsx'],
...tseslint.configs.disableTypeChecked,
rules: {
'import-x/no-commonjs': off,
@ -111,7 +127,7 @@ export async function extendConfig(
},
{
name: 'eslint-rules/.d.ts-files',
files: ['*.d.ts'],
files: ['**/*.d.ts'],
rules: {
'@typescript-eslint/consistent-type-imports': off,
'import-x/unambiguous': off,

7
src/install.ts
View File

@ -6,7 +6,12 @@ import { envs, getProjectDependencies } from './environment';
const deps = getProjectDependencies();
const packages = uniq(
envs
.filter(_ => deps.has(_.dependency) && _.eslintPlugin && !deps.has(_.eslintPlugin))
.filter(
_ =>
_.dependency.some(dep => deps.has(dep)) &&
_.eslintPlugin &&
!deps.has(_.eslintPlugin),
)
.map(_ => _.eslintPlugin!),
);

1
src/middleware.ts
View File

@ -6,5 +6,4 @@ export type Middleware =
| (() => Promise<MiddlewareResult>)
| (() => Promise<{ default: MiddlewareResult }>);
// eslint-disable-next-line unicorn/prevent-abbreviations
export const def = <T>(module: { default: T }): T => module.default;

19
src/presets/custom.ts
View File

@ -4,20 +4,21 @@ import { defineConfig } from '../types';
export default defineConfig([
{
name: 'eslint-rules/custom',
plugins: { custom: plugin },
name: 'eslint-rules/aet',
plugins: { aet: plugin },
rules: {
'custom/no-import-dot': error,
'custom/no-useless-import-alias': error,
'aet/no-import-dot': error,
'aet/no-useless-import-alias': error,
'aet/require-import-attribute': error,
} satisfies Partial<LocalRuleOptions>,
},
{
name: 'eslint-rules/typed-custom',
plugins: { 'typed-custom': typedPlugin },
files: ['*.ts'],
ignores: ['*.d.ts'],
name: 'eslint-rules/typed-aet',
plugins: { 'typed-aet': typedPlugin },
files: ['**/*.ts'],
ignores: ['**/*.d.ts'],
rules: {
'typed-custom/restrict-template-expressions': error,
'typed-aet/restrict-template-expressions': error,
} satisfies Partial<LocalRuleOptions>,
},
]);

12
src/presets/lingui.ts Normal file
View File

@ -0,0 +1,12 @@
import type { LinguiRulesObject } from '@aet/eslint-define-config/src/rules/lingui';
import * as pluginLingui from 'eslint-plugin-lingui';
import { defineConfig } from '../types';
// https://the-guild.dev/graphql/eslint/rules
const linguiRules: Partial<LinguiRulesObject> = {};
export default defineConfig([
pluginLingui.configs['flat/recommended'],
{ rules: linguiRules },
]);

17
src/presets/misc.ts
View File

@ -12,6 +12,19 @@ export async function reactQuery() {
}
export async function vitest() {
const { configs } = def(await import('eslint-plugin-vitest'));
return defineConfig([configs.recommended]);
const { configs } = def(await import('@vitest/eslint-plugin'));
return defineConfig([
configs.recommended,
{
rules: {
'vitest/expect-expect': [
'error',
{
assertFunctionNames: ['expect*', 'request.**.expect'],
additionalTestBlockFunctions: ['describe*'],
},
],
},
},
]);
}

6
src/presets/react.ts
View File

@ -10,6 +10,8 @@ const reactRules: Partial<ReactRulesObject> = {
'@eslint-react/no-missing-component-display-name': off,
'@eslint-react/no-children-prop': error,
'@eslint-react/no-leaked-conditional-rendering': error,
'@eslint-react/prefer-read-only-props': off,
'@eslint-react/hooks-extra/no-direct-set-state-in-use-effect': off,
};
export async function react() {
@ -23,12 +25,12 @@ export async function react() {
a11y.flatConfigs.recommended,
{
name: 'eslint-rules/react',
files: ['*.tsx'],
files: ['**/*.tsx'],
rules: reactRules,
},
{
name: 'eslint-rules/react/test-files',
files: ['*.test.tsx'],
files: ['**/*.test.tsx'],
rules: {
'@eslint-react/no-clone-element': off,
'@eslint-react/no-create-ref': off,

2
src/presets/tailwind.ts
View File

@ -16,7 +16,7 @@ export default defineConfig([
settings: {
tailwindcss: {
callees: ['classnames', 'clsx', 'tw', 'twx'],
classRegex: '^(css|class(Name)?)$',
classRegex: /^(css|class(Name)?)$/.source,
},
},
},

8
src/presets/typescript.ts
View File

@ -40,6 +40,14 @@ export const typescriptRules: Partial<TypeScriptRulesObject> = {
'@typescript-eslint/no-empty-object-type': off,
'@typescript-eslint/no-empty-interface': [error, { allowSingleExtends: true }],
'@typescript-eslint/no-explicit-any': off,
'@typescript-eslint/no-floating-promises': [
'warn',
{
allowForKnownSafeCalls: [
{ from: 'package', name: ['it', 'describe', 'test'], package: 'node:test' },
],
},
],
'@typescript-eslint/no-misused-promises': [error, { checksVoidReturn: false }],
'@typescript-eslint/no-namespace': off,
'@typescript-eslint/no-unnecessary-type-assertion': error,

24
src/presets/unicorn.ts
View File

@ -7,10 +7,12 @@ import { defineConfig } from '../types';
const suggest = (suggest: string) => ({ suggest, fix: false });
// https://github.com/sindresorhus/eslint-plugin-unicorn/tree/28e7498ad06679bb92343db53bb40a7b5ba2990a
// https://github.com/sindresorhus/eslint-plugin-unicorn/tree/1774135a5ddbded2c89f82952e37a3e3bb01cdfa
const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/better-regex': error,
'unicorn/consistent-destructuring': warn,
'unicorn/consistent-empty-array-spread': error,
'unicorn/consistent-existence-index-check': error,
'unicorn/consistent-function-scoping': warn,
'unicorn/escape-case': error,
'unicorn/no-array-for-each': warn,
@ -22,6 +24,7 @@ const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/no-instanceof-array': error,
'unicorn/no-invalid-fetch-options': error,
'unicorn/no-invalid-remove-event-listener': error,
'unicorn/no-length-as-slice-end': error,
'unicorn/no-lonely-if': warn,
'unicorn/no-negation-in-equality-check': error,
'unicorn/no-new-buffer': error,
@ -38,6 +41,7 @@ const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/no-useless-undefined': error,
'unicorn/no-zero-fractions': error,
'unicorn/number-literal-case': error,
'unicorn/prefer-array-index-of': error,
'unicorn/prefer-array-find': error,
'unicorn/prefer-array-flat': error,
'unicorn/prefer-array-flat-map': error,
@ -54,6 +58,7 @@ const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/prefer-json-parse-buffer': warn,
'unicorn/prefer-keyboard-event-key': warn,
'unicorn/prefer-logical-operator-over-ternary': warn,
'unicorn/prefer-math-min-max': error,
'unicorn/prefer-math-trunc': warn,
'unicorn/prefer-modern-dom-apis': error,
'unicorn/prefer-modern-math-apis': error,
@ -66,14 +71,16 @@ const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/prefer-regexp-test': error,
'unicorn/prefer-set-has': warn,
'unicorn/prefer-set-size': error,
'unicorn/prefer-string-raw': error,
'unicorn/prefer-string-raw': warn,
'unicorn/prefer-string-slice': error,
'unicorn/prefer-string-starts-ends-with': warn,
'unicorn/prefer-string-trim-start-end': error,
'unicorn/prefer-switch': warn,
'unicorn/prefer-ternary': warn,
'unicorn/prefer-type-error': warn,
'unicorn/relative-url-style': warn,
'unicorn/require-number-to-fixed-digits-argument': error,
'unicorn/require-post-message-target-origin': warn,
'unicorn/string-content': [
warn,
{
@ -100,17 +107,6 @@ const unicornRules: Partial<UnicornRulesObject> = {
'unicorn/template-indent': warn,
};
// export const unicorn = defineMiddleware((config, { addRules }) => {
// config.plugins.push('unicorn');
// addRules(unicornRules);
// config.overrides.push({
// files: ['*.test.ts', '*.test.tsx'],
// rules: {
// 'unicorn/no-useless-undefined': off,
// },
// });
// });
export default defineConfig([
{
name: 'eslint-rules/unicorn',
@ -124,7 +120,7 @@ export default defineConfig([
},
{
name: 'eslint-rules/unicorn/tests',
files: ['*.test.ts', '*.test.tsx'],
files: ['**/*.test.ts', '**/*.test.tsx'],
rules: {
'unicorn/no-useless-undefined': off,
},

23
src/prettier.ts
View File

@ -10,28 +10,15 @@ const prettier: Config = {
plugins: [],
};
export default function defineConfig({
tailwind,
...config
}: Partial<Config> & {
tailwind?: boolean;
}) {
export default function defineConfig(
config: Partial<Config> & {
tailwind?: boolean;
},
) {
const result: Config = {
...prettier,
...config,
};
if (tailwind) {
ensureHas(result.plugins!, 'prettier-plugin-tailwindcss');
result.tailwindAttributes ??= ['css'];
result.tailwindFunctions ??= ['tw'];
}
return result;
}
function ensureHas<T>(list: T[], item: T) {
if (!list.includes(item)) {
list.push(item);
}
}