Compare commits
6 Commits
inline
...
3ac5f91988
| Author | SHA1 | Date | |
|---|---|---|---|
| 3ac5f91988 | |||
| 2853da4344 | |||
| 1e6d679af3 | |||
| 674eaf1811 | |||
| c175f87441 | |||
| 003a43512c |
18
.eslintrc
18
.eslintrc
@ -3,12 +3,12 @@
|
||||
"env": {
|
||||
"node": true,
|
||||
"browser": true,
|
||||
"es6": true
|
||||
"es6": true,
|
||||
},
|
||||
"extends": ["eslint:recommended", "prettier"],
|
||||
"parserOptions": {
|
||||
"sourceType": "module",
|
||||
"ecmaVersion": "latest"
|
||||
"ecmaVersion": "latest",
|
||||
},
|
||||
"rules": {
|
||||
"no-restricted-imports": [
|
||||
@ -24,14 +24,14 @@
|
||||
"object.hasown",
|
||||
"object.values",
|
||||
"string.prototype.matchall",
|
||||
"has"
|
||||
]
|
||||
}
|
||||
"has",
|
||||
],
|
||||
},
|
||||
],
|
||||
"arrow-body-style": ["error", "as-needed"],
|
||||
"class-methods-use-this": [
|
||||
"warn",
|
||||
{ "exceptMethods": ["toString", "shouldComponentUpdate"] }
|
||||
{ "exceptMethods": ["toString", "shouldComponentUpdate"] },
|
||||
],
|
||||
"complexity": ["warn", { "max": 100 }],
|
||||
"curly": ["error", "multi-line", "consistent"],
|
||||
@ -50,13 +50,13 @@
|
||||
"prefer-const": ["error", { "destructuring": "all" }],
|
||||
"prefer-destructuring": [
|
||||
"warn",
|
||||
{ "AssignmentExpression": { "array": false, "object": false } }
|
||||
{ "AssignmentExpression": { "array": false, "object": false } },
|
||||
],
|
||||
"prefer-rest-params": "warn",
|
||||
"prefer-spread": "warn",
|
||||
"quote-props": ["error", "as-needed"],
|
||||
"spaced-comment": ["error", "always", { "markers": ["/"] }],
|
||||
"sort-imports": ["warn", { "ignoreDeclarationSort": true }],
|
||||
"yoda": ["error", "never", { "exceptRange": true }]
|
||||
}
|
||||
"yoda": ["error", "never", { "exceptRange": true }],
|
||||
},
|
||||
}
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,4 +1,6 @@
|
||||
drafts
|
||||
!/packages/eslint-plugin-react-hooks
|
||||
/packages/eslint-define-config
|
||||
/react
|
||||
src/types/rules
|
||||
|
||||
|
||||
@ -4,6 +4,8 @@ Personal ESLint config. Guaranteed to have no useless polyfills.
|
||||
|
||||
## flat config support
|
||||
|
||||
- ❌ [import](https://github.com/import-js/eslint-plugin-import/issues/2556)
|
||||
- ⏱️ [a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/pull/993)
|
||||
- ✅ [react](https://github.com/jsx-eslint/eslint-plugin-react/pull/3429)
|
||||
- ⏱️ [a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/pull/891)
|
||||
- ✅ [unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn/pull/1886)
|
||||
- ❌ [import](https://github.com/un-ts/eslint-plugin-import-x/issues/29)
|
||||
- ❌ [jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/978)
|
||||
|
||||
14
dist/eslint-plugin-import/index.d.ts
vendored
14
dist/eslint-plugin-import/index.d.ts
vendored
@ -1,14 +0,0 @@
|
||||
import type { Linter } from 'eslint';
|
||||
|
||||
export const rules: Readonly<Linter.RulesRecord>;
|
||||
|
||||
export const configs: {
|
||||
recommended: Linter.BaseConfig;
|
||||
errors: Linter.BaseConfig;
|
||||
warnings: Linter.BaseConfig;
|
||||
'stage-0': Linter.BaseConfig;
|
||||
react: Linter.BaseConfig;
|
||||
'react-native': Linter.BaseConfig;
|
||||
electron: Linter.BaseConfig;
|
||||
typescript: Linter.BaseConfig;
|
||||
};
|
||||
35
dist/index.d.ts
vendored
35
dist/index.d.ts
vendored
@ -1,12 +1,19 @@
|
||||
// Generated by dts-bundle-generator v9.4.0
|
||||
|
||||
import { ESLintConfig, KnownExtends, Rules, Settings } from '@aet/eslint-define-config';
|
||||
import { ESLintUtils } from '@typescript-eslint/utils';
|
||||
import { Rule } from 'eslint';
|
||||
import { ESLintConfig, Rules } from 'eslint-define-config';
|
||||
import { Merge, SetRequired } from 'type-fest';
|
||||
|
||||
export declare const error = "error";
|
||||
export declare const warn = "warn";
|
||||
export declare const off = "off";
|
||||
export declare const graphql: Middleware;
|
||||
export declare const jsdoc: Middleware;
|
||||
export declare const storybook: Middleware;
|
||||
export declare const react: Middleware;
|
||||
export declare const reactRefresh: Middleware;
|
||||
export declare const tailwind: Middleware;
|
||||
export type RuleLevel = "error" | "warn" | "off" | 0 | 1 | 2;
|
||||
export type RuleEntry<Options> = RuleLevel | [
|
||||
RuleLevel,
|
||||
@ -32,6 +39,7 @@ export interface CustomRule {
|
||||
}>;
|
||||
options?: RuleLevel;
|
||||
}
|
||||
export type Middleware = (config: MiddlewareConfig, helpers: MiddlewareFunctions) => void;
|
||||
/**
|
||||
* ESLint Configuration.
|
||||
* @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/)
|
||||
@ -41,18 +49,32 @@ export type InputConfig = Omit<ESLintConfig, "rules"> & {
|
||||
* Rules.
|
||||
* @see [Rules](https://eslint.org/docs/latest/user-guide/configuring/rules)
|
||||
*/
|
||||
rules?: RuleOptions;
|
||||
rules?: Partial<RuleOptions>;
|
||||
/**
|
||||
* Glob pattern to find paths to custom rule files in JavaScript or TypeScript.
|
||||
* Note this must be a string literal or an array of string literals since
|
||||
* this is statically analyzed.
|
||||
*/
|
||||
customRuleFiles?: string | string[];
|
||||
/**
|
||||
* Automatically detect project types, dependencies and deduct the plugins.
|
||||
*/
|
||||
auto?: boolean;
|
||||
};
|
||||
export type OptionalObjectKey<T> = Exclude<{
|
||||
[Key in keyof T]: undefined | any[] extends T[Key] ? Key : undefined | Record<any, any> extends T[Key] ? Key : never;
|
||||
}[keyof T], undefined>;
|
||||
export type MiddlewareConfig = Merge<SetRequired<ESLintConfig, OptionalObjectKey<ESLintConfig>>, {
|
||||
extends: KnownExtends[];
|
||||
}>;
|
||||
export interface MiddlewareFunctions {
|
||||
addRules(rules: Partial<RuleOptions>): void;
|
||||
addSettings(settings: Partial<Settings>): void;
|
||||
}
|
||||
/**
|
||||
* Returns a ESLint config object.
|
||||
*
|
||||
* By default, it includes `["@typescript-eslint", "import", "prettier"]` configs.
|
||||
* By default, it includes `["@typescript-eslint", "import-x", "prettier", "unicorn"]` configs.
|
||||
* Additional bundled plugins include:
|
||||
*
|
||||
* 1. [`react`](https://github.com/jsx-eslint/eslint-plugin-react#list-of-supported-rules)
|
||||
@ -61,12 +83,15 @@ export type InputConfig = Omit<ESLintConfig, "rules"> & {
|
||||
* 2. [`react-refresh`](https://github.com/ArnaudBarre/eslint-plugin-react-refresh)
|
||||
* 3. [`jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#supported-rules)
|
||||
* 4. [`unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn#rules)
|
||||
* 5. [`n`](https://github.com/eslint-community/eslint-plugin-n#-rules) (Node.js specific)
|
||||
* 5. [`n`](https://github.com/eslint-community/eslint-plugin-n#-rules) (Node.js specific,
|
||||
* requires `minimatch`)
|
||||
* 6. [`jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc#rules)
|
||||
*
|
||||
* Non bundled:
|
||||
* 1. [`graphql`](https://the-guild.dev/graphql/eslint/rules)
|
||||
*/
|
||||
export declare function extendConfig(of?: InputConfig): ESLintConfig;
|
||||
export declare function extendConfig(of?: InputConfig & {
|
||||
middlewares: Middleware[];
|
||||
}): ESLintConfig;
|
||||
|
||||
export {};
|
||||
|
||||
55
dist/package.json
vendored
55
dist/package.json
vendored
@ -1,60 +1,63 @@
|
||||
{
|
||||
"name": "@aet/eslint-rules",
|
||||
"version": "0.0.24-beta.1",
|
||||
"version": "1.0.1-beta.11",
|
||||
"license": "UNLICENSED",
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.57.0",
|
||||
"typescript": "^5.4.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@nolyfill/is-core-module": "^1.0.39",
|
||||
"@aet/eslint-define-config": "^0.1.0-beta.15",
|
||||
"@eslint-community/eslint-utils": "^4.4.0",
|
||||
"@types/eslint": "^8.56.9",
|
||||
"@typescript-eslint/eslint-plugin": "^7.7.0",
|
||||
"@typescript-eslint/parser": "^7.7.0",
|
||||
"@typescript-eslint/type-utils": "^7.7.0",
|
||||
"@typescript-eslint/utils": "^7.7.0",
|
||||
"@tanstack/eslint-plugin-query": "^5.51.15",
|
||||
"@types/eslint": "^8.56.11",
|
||||
"@typescript-eslint/eslint-plugin": "^7.17.0",
|
||||
"@typescript-eslint/parser": "^7.17.0",
|
||||
"@typescript-eslint/type-utils": "^7.17.0",
|
||||
"@typescript-eslint/utils": "^7.17.0",
|
||||
"@eslint-react/eslint-plugin": "^1.6.0",
|
||||
"aria-query": "^5.3.0",
|
||||
"axe-core": "^4.9.0",
|
||||
"axobject-query": "^4.0.0",
|
||||
"axe-core": "^4.9.1",
|
||||
"axobject-query": "4.1.0",
|
||||
"damerau-levenshtein": "1.0.8",
|
||||
"debug": "^4.3.4",
|
||||
"debug": "^4.3.6",
|
||||
"doctrine": "^3.0.0",
|
||||
"emoji-regex": "^10.3.0",
|
||||
"enhanced-resolve": "^5.16.0",
|
||||
"enhanced-resolve": "^5.17.1",
|
||||
"eslint-config-prettier": "^9.1.0",
|
||||
"eslint-define-config": "^1.24.1",
|
||||
"eslint-import-resolver-node": "^0.3.9",
|
||||
"eslint-module-utils": "^2.8.1",
|
||||
"eslint-plugin-es-x": "^7.6.0",
|
||||
"eslint-plugin-jsdoc": "^48.2.3",
|
||||
"eslint-plugin-unicorn": "^52.0.0",
|
||||
"eslint-plugin-es-x": "^8.0.0",
|
||||
"eslint-plugin-import-x": "^3.1.0",
|
||||
"eslint-plugin-jsdoc": "^48.8.3",
|
||||
"eslint-plugin-react-refresh": "^0.4.9",
|
||||
"eslint-plugin-unicorn": "^55.0.0",
|
||||
"esprima": "^4.0.1",
|
||||
"esquery": "^1.5.0",
|
||||
"esquery": "^1.6.0",
|
||||
"estraverse": "^5.3.0",
|
||||
"fast-glob": "^3.3.2",
|
||||
"get-tsconfig": "^4.7.3",
|
||||
"get-tsconfig": "^4.7.6",
|
||||
"is-bun-module": "^1.0.2",
|
||||
"ignore": "^5.3.1",
|
||||
"is-builtin-module": "^3.2.1",
|
||||
"is-glob": "^4.0.3",
|
||||
"language-tags": "^1.0.9",
|
||||
"lodash": "^4.17.21",
|
||||
"minimatch": "^9.0.4",
|
||||
"resolve": "^2.0.0-next.5",
|
||||
"semver": "^7.6.0",
|
||||
"tsconfig-paths": "^4.2.0"
|
||||
"semver": "^7.6.3"
|
||||
},
|
||||
"overrides": {
|
||||
"supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag",
|
||||
"is-core-module": "file:./overrides/is-core-module"
|
||||
"is-core-module": "file:./overrides/is-core-module",
|
||||
"supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag"
|
||||
},
|
||||
"resolutions": {
|
||||
"**/supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag",
|
||||
"**/is-core-module": "file:./overrides/is-core-module"
|
||||
"**/is-core-module": "file:./overrides/is-core-module",
|
||||
"**/supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag"
|
||||
},
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag",
|
||||
"is-core-module": "file:./overrides/is-core-module"
|
||||
"is-core-module": "file:./overrides/is-core-module",
|
||||
"supports-preserve-symlinks-flag": "file:./overrides/supports-preserve-symlinks-flag"
|
||||
}
|
||||
}
|
||||
}
|
||||
1130
dist/yarn.lock
vendored
1130
dist/yarn.lock
vendored
File diff suppressed because it is too large
Load Diff
71
package.json
71
package.json
@ -1,49 +1,50 @@
|
||||
{
|
||||
"name": "@aet/eslint-configs",
|
||||
"scripts": {
|
||||
"build": "./scripts/build-all.ts",
|
||||
"build-types": "cd ./packages/eslint-define-config && ./scripts/index.ts",
|
||||
"check-import": "./scripts/check-imports.ts"
|
||||
"build": "./scripts/build.ts",
|
||||
"check-import": "./scripts/check-imports.ts",
|
||||
"define": "/usr/local/bin/codium ./packages/eslint-define-config"
|
||||
},
|
||||
"private": true,
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.24.4",
|
||||
"@babel/plugin-transform-flow-strip-types": "^7.24.1",
|
||||
"@babel/preset-env": "^7.24.4",
|
||||
"@aet/eslint-define-config": "^0.1.0-beta.15",
|
||||
"@babel/core": "^7.24.9",
|
||||
"@babel/plugin-transform-flow-strip-types": "^7.24.7",
|
||||
"@babel/preset-env": "^7.25.0",
|
||||
"@types/babel-plugin-macros": "^3.1.3",
|
||||
"@types/babel__core": "^7.20.5",
|
||||
"@types/eslint": "^8.56.10",
|
||||
"@types/eslint": "^9.6.0",
|
||||
"@types/esprima": "^4.0.6",
|
||||
"@types/esquery": "^1.5.3",
|
||||
"@types/esquery": "^1.5.4",
|
||||
"@types/estree": "^1.0.5",
|
||||
"@types/estree-jsx": "^1.0.5",
|
||||
"@types/lodash": "^4.17.0",
|
||||
"@types/node": "^20.12.7",
|
||||
"@typescript-eslint/eslint-plugin": "7.7.0",
|
||||
"@typescript-eslint/type-utils": "^7.7.0",
|
||||
"@typescript-eslint/types": "^7.7.0",
|
||||
"@typescript-eslint/typescript-estree": "^7.7.0",
|
||||
"@typescript-eslint/utils": "^7.7.0",
|
||||
"@types/lodash": "^4.17.7",
|
||||
"@types/node": "^20.14.12",
|
||||
"@typescript-eslint/eslint-plugin": "7.17.0",
|
||||
"@typescript-eslint/type-utils": "^7.17.0",
|
||||
"@typescript-eslint/types": "^7.17.0",
|
||||
"@typescript-eslint/typescript-estree": "^7.17.0",
|
||||
"@typescript-eslint/utils": "^7.17.0",
|
||||
"babel-plugin-macros": "^3.1.0",
|
||||
"dts-bundle-generator": "^9.5.0",
|
||||
"esbin": "0.0.4",
|
||||
"esbuild": "0.20.2",
|
||||
"dts-bundle-generator": "9.4.0",
|
||||
"esbuild": "0.23.0",
|
||||
"esbuild-plugin-alias": "^0.2.1",
|
||||
"eslint": "8.57.0",
|
||||
"eslint-config-prettier": "^9.1.0",
|
||||
"eslint-define-config": "file:./src/types",
|
||||
"eslint-plugin-import-x": "^3.1.0",
|
||||
"esprima": "^4.0.1",
|
||||
"esquery": "^1.5.0",
|
||||
"esquery": "^1.6.0",
|
||||
"fast-glob": "^3.3.2",
|
||||
"find-cache-dir": "^5.0.0",
|
||||
"json-schema-to-ts": "^3.0.1",
|
||||
"json-schema-to-ts": "^3.1.0",
|
||||
"lodash": "^4.17.21",
|
||||
"minimatch": "^9.0.4",
|
||||
"nolyfill": "^1.0.39",
|
||||
"patch-package": "^8.0.0",
|
||||
"picocolors": "^1.0.0",
|
||||
"prettier": "^3.2.5",
|
||||
"picocolors": "^1.0.1",
|
||||
"prettier": "^3.3.3",
|
||||
"prop-types": "^15.8.1",
|
||||
"typescript": "^5.4.5"
|
||||
"type-fest": "^4.23.0",
|
||||
"typescript": "^5.5.4"
|
||||
},
|
||||
"prettier": {
|
||||
"arrowParens": "avoid",
|
||||
@ -55,15 +56,17 @@
|
||||
},
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"function-bind": "npm:@nolyfill/function-bind@latest",
|
||||
"has-proto": "npm:@nolyfill/has-proto@latest",
|
||||
"has-symbols": "npm:@nolyfill/has-symbols@latest",
|
||||
"hasown": "npm:@nolyfill/hasown@latest",
|
||||
"isarray": "npm:@nolyfill/isarray@latest",
|
||||
"jsonify": "npm:@nolyfill/jsonify@latest",
|
||||
"object-keys": "npm:@nolyfill/object-keys@latest",
|
||||
"set-function-length": "npm:@nolyfill/set-function-length@latest",
|
||||
"@babel/types": "7.24.0"
|
||||
"function-bind": "npm:@nolyfill/function-bind@^1",
|
||||
"has-proto": "npm:@nolyfill/has-proto@^1",
|
||||
"has-symbols": "npm:@nolyfill/has-symbols@^1",
|
||||
"hasown": "npm:@nolyfill/hasown@^1",
|
||||
"isarray": "npm:@nolyfill/isarray@^1",
|
||||
"jsonify": "npm:@nolyfill/jsonify@^1",
|
||||
"object-keys": "npm:@nolyfill/object-keys@^1",
|
||||
"set-function-length": "npm:@nolyfill/set-function-length@^1",
|
||||
"@babel/types": "7.24.0",
|
||||
"is-core-module": "npm:@nolyfill/is-core-module@^1",
|
||||
"json-stable-stringify": "npm:@nolyfill/json-stable-stringify@^1"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2021-2023 Christopher Quadflieg
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -1,144 +0,0 @@
|
||||
<p>
|
||||
<a href="https://www.npmjs.com/package/eslint-define-config" target="_blank">
|
||||
<img alt="NPM package" src="https://img.shields.io/npm/v/eslint-define-config.svg">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/eslint-define-config" target="_blank">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dt/eslint-define-config.svg">
|
||||
</a>
|
||||
<a href="https://github.com/eslint-types/eslint-define-config/actions/workflows/ci.yml">
|
||||
<img alt="Build Status" src="https://github.com/eslint-types/eslint-define-config/actions/workflows/ci.yml/badge.svg?branch=main">
|
||||
</a>
|
||||
<a href="https://github.com/eslint-types/eslint-define-config/blob/main/LICENSE">
|
||||
<img alt="License: MIT" src="https://img.shields.io/github/license/eslint-types/eslint-define-config.svg">
|
||||
</a>
|
||||
<a href="https://prettier.io" target="_blank">
|
||||
<img alt="Code Style: Prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
|
||||
</a>
|
||||
<a href="https://www.paypal.com/donate?hosted_button_id=L7GY729FBKTZY" target="_blank">
|
||||
<img alt="Donate: PayPal" src="https://img.shields.io/badge/Donate-PayPal-blue.svg">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
# eslint-define-config
|
||||
|
||||
Provide a `defineConfig` function for `.eslintrc.js`, and a `defineFlatConfig` function for `eslint.config.js` files.
|
||||
|
||||
> This project is written by a human and only partially automatically generated!
|
||||
> Some rules are even enhanced by hand!
|
||||
> Unfortunately, this has the disadvantage that not everything is immediately defined. For example, if a rule is not defined, it falls back to a basic definition.
|
||||
> However, the advantage is that you get documentation for pretty much everything in the code and usually get a direct link to the respective plugin or eslint rule. The types are also strictly typed.
|
||||
>
|
||||
> So if you are missing something like a rule or a plugin that should also be supported or a rule definition is e.g. out of date, feel free to open an issue or PR for it.
|
||||
|
||||
# Installation
|
||||
|
||||
```bash
|
||||
# add eslint and eslint-define-config to project’s dev dependencies
|
||||
npm add --save-dev eslint eslint-define-config
|
||||
# or
|
||||
yarn add --dev eslint eslint-define-config
|
||||
# or
|
||||
pnpm add --save-dev eslint eslint-define-config
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
`.eslintrc.js`
|
||||
|
||||
```ts
|
||||
// @ts-check
|
||||
|
||||
// To activate auto-suggestions for Rules of specific plugins, you need to add a `/// <reference types="eslint-plugin-PLUGIN_NAME/define-config-support" />` comment.
|
||||
// ⚠️ This feature is very new and requires the support of the respective plugin owners.
|
||||
|
||||
/// <reference types="@typescript-eslint/eslint-plugin/define-config-support" />
|
||||
|
||||
const { defineConfig } = require('eslint-define-config');
|
||||
|
||||
module.exports = defineConfig({
|
||||
root: true,
|
||||
rules: {
|
||||
// rules...
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Flat Config
|
||||
|
||||
`eslint.config.js`
|
||||
|
||||
```ts
|
||||
// @ts-check
|
||||
const { defineFlatConfig } = require('eslint-define-config');
|
||||
|
||||
module.exports = defineFlatConfig([
|
||||
'eslint:recommended',
|
||||
{
|
||||
plugins: {
|
||||
// plugins...
|
||||
},
|
||||
rules: {
|
||||
// rules...
|
||||
},
|
||||
},
|
||||
]);
|
||||
```
|
||||
|
||||
# Why?
|
||||
|
||||
Improve your eslint configuration experience with:
|
||||
|
||||
- auto-suggestions
|
||||
- type checking (Use `// @ts-check` at the first line in your `.eslintrc.js` or `eslint.config.js`)
|
||||
- documentation
|
||||
- deprecation warnings
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/7195563/112484789-8a416480-8d7a-11eb-9337-d8b5bc16de17.png" alt="Image" width="600px"/>
|
||||
|
||||
## Video
|
||||
|
||||
_Click on the thumbnail to play the video_
|
||||
|
||||
<a href="https://user-images.githubusercontent.com/7195563/112726158-4a19e780-8f1c-11eb-8cc6-4ea6c100137f.mp4" target="_blank">
|
||||
<img src="https://user-images.githubusercontent.com/7195563/112726343-30c56b00-8f1d-11eb-9b92-260c530caf1b.png" alt="Video" width="600px"/>
|
||||
</a>
|
||||
|
||||
## Want to support your own plugin?
|
||||
|
||||
:warning: **This feature is very new and requires the support of the respective plugin owners**
|
||||
|
||||
Add a `declare module` to your plugin package like this:
|
||||
|
||||
```ts
|
||||
declare module 'eslint-define-config' {
|
||||
export interface CustomRuleOptions {
|
||||
/**
|
||||
* Require consistently using either `T[]` or `Array<T>` for arrays.
|
||||
*
|
||||
* @see [array-type](https://typescript-eslint.io/rules/array-type)
|
||||
*/
|
||||
'@typescript-eslint/array-type': [
|
||||
{
|
||||
default?: 'array' | 'generic' | 'array-simple';
|
||||
readonly?: 'array' | 'generic' | 'array-simple';
|
||||
},
|
||||
];
|
||||
|
||||
// ... more Rules
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
There are other interfaces that can be extended.
|
||||
|
||||
- `CustomExtends`
|
||||
- `CustomParserOptions`
|
||||
- `CustomParsers`
|
||||
- `CustomPlugins`
|
||||
- `CustomSettings`
|
||||
|
||||
# Credits
|
||||
|
||||
- [Proposal Idea](https://github.com/eslint/eslint/issues/14249)
|
||||
- [Vite](https://github.com/vitejs/vite) and [Evan You](https://github.com/yyx990803) for the idea
|
||||
- [@antfu](https://github.com/antfu) and his [tweet](https://twitter.com/antfu7/status/1365907188338753536)
|
||||
@ -1,120 +0,0 @@
|
||||
{
|
||||
"name": "eslint-define-config",
|
||||
"version": "1.24.1",
|
||||
"description": "Provide a defineConfig function for .eslintrc.js files",
|
||||
"scripts": {
|
||||
"clean": "rimraf coverage .eslintcache dist pnpm-lock.yaml node_modules",
|
||||
"format": "prettier --cache --write .",
|
||||
"lint:run": "eslint --cache --cache-strategy content --report-unused-disable-directives .",
|
||||
"lint": "run-s build lint:run",
|
||||
"typecheck": "vitest typecheck",
|
||||
"ts-check": "tsc",
|
||||
"test": "vitest",
|
||||
"coverage": "vitest run --coverage",
|
||||
"generate:rules": "tsx ./scripts/generate-rule-files/cli.ts",
|
||||
"prepublishOnly": "pnpm run clean && pnpm install && pnpm run build",
|
||||
"preflight": "pnpm install && run-s format lint ts-check test typecheck"
|
||||
},
|
||||
"type": "module",
|
||||
"main": "dist/index.cjs",
|
||||
"module": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js",
|
||||
"require": "./dist/index.cjs",
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"keywords": [
|
||||
"config",
|
||||
"configuration",
|
||||
"define-config",
|
||||
"eslint-config",
|
||||
"eslint",
|
||||
"eslintconfig",
|
||||
"typed",
|
||||
"typescript"
|
||||
],
|
||||
"author": {
|
||||
"name": "Christopher Quadflieg",
|
||||
"email": "chrissi92@hotmail.de",
|
||||
"url": "https://github.com/Shinigami92"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/eslint-types/eslint-define-config.git"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/Shinigami92"
|
||||
},
|
||||
{
|
||||
"type": "paypal",
|
||||
"url": "https://www.paypal.com/donate/?hosted_button_id=L7GY729FBKTZY"
|
||||
}
|
||||
],
|
||||
"bugs": "https://github.com/eslint-types/eslint-define-config/issues",
|
||||
"license": "MIT",
|
||||
"files": [
|
||||
"dist",
|
||||
"src",
|
||||
"tsconfig.json"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@graphql-eslint/eslint-plugin": "~3.20.1",
|
||||
"@intlify/eslint-plugin-vue-i18n": "~2.0.0",
|
||||
"@poppinss/cliui": "~6.4.1",
|
||||
"@types/dedent": "^0.7.2",
|
||||
"@types/eslint": "~8.44.3",
|
||||
"@types/json-schema": "~7.0.13",
|
||||
"@types/node": "~20.8.3",
|
||||
"@typescript-eslint/eslint-plugin": "~6.7.4",
|
||||
"@typescript-eslint/parser": "~6.7.4",
|
||||
"@vitest/coverage-v8": "~0.34.6",
|
||||
"change-case": "~5.4.4",
|
||||
"dedent": "^1.5.3",
|
||||
"eslint-config-prettier": "~9.0.0",
|
||||
"eslint-gitignore": "~0.1.0",
|
||||
"eslint-plugin-deprecation": "~2.0.0",
|
||||
"eslint-plugin-eslint-comments": "~3.2.0",
|
||||
"eslint-plugin-import": "~2.28.1",
|
||||
"eslint-plugin-inclusive-language": "~2.2.1",
|
||||
"eslint-plugin-jsdoc": "~46.8.2",
|
||||
"eslint-plugin-jsonc": "~2.9.0",
|
||||
"eslint-plugin-jsx-a11y": "~6.7.1",
|
||||
"eslint-plugin-mdx": "~3.1.5",
|
||||
"eslint-plugin-n": "~16.1.0",
|
||||
"eslint-plugin-node": "~11.1.0",
|
||||
"eslint-plugin-prettier": "~5.0.0",
|
||||
"eslint-plugin-promise": "~6.1.1",
|
||||
"eslint-plugin-react": "~7.33.2",
|
||||
"eslint-plugin-react-hooks": "~4.6.0",
|
||||
"eslint-plugin-sonarjs": "~0.21.0",
|
||||
"eslint-plugin-spellcheck": "~0.0.20",
|
||||
"eslint-plugin-testing-library": "~6.0.2",
|
||||
"eslint-plugin-unicorn": "~48.0.1",
|
||||
"eslint-plugin-vitest": "~0.3.2",
|
||||
"eslint-plugin-vue": "~9.17.0",
|
||||
"eslint-plugin-vue-pug": "~0.6.0",
|
||||
"eslint-plugin-yml": "~1.10.0",
|
||||
"expect-type": "~0.17.3",
|
||||
"graphql": "~16.8.1",
|
||||
"json-schema": "~0.4.0",
|
||||
"json-schema-to-ts": "~2.9.2",
|
||||
"json-schema-to-typescript": "~13.1.1",
|
||||
"npm-run-all": "~4.1.5",
|
||||
"prettier-plugin-organize-imports": "^3.2.4",
|
||||
"rimraf": "~5.0.5",
|
||||
"tsup": "~7.2.0",
|
||||
"vue-eslint-parser": "~9.3.2"
|
||||
},
|
||||
"packageManager": "pnpm@8.8.0",
|
||||
"engines": {
|
||||
"node": ">=18.0.0",
|
||||
"npm": ">=9.0.0",
|
||||
"pnpm": ">=8.6.0"
|
||||
}
|
||||
}
|
||||
6894
packages/eslint-define-config/pnpm-lock.yaml
generated
6894
packages/eslint-define-config/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1,22 +0,0 @@
|
||||
diff --git b/lib/rules/eslint/no-constructor-return.d.ts a/lib/rules/eslint/no-constructor-return.d.ts
|
||||
index fedeca4..3e1fd03 100644
|
||||
--- b/lib/rules/eslint/no-constructor-return.d.ts
|
||||
+++ a/lib/rules/eslint/no-constructor-return.d.ts
|
||||
@@ -1,16 +1,9 @@
|
||||
import type { RuleConfig } from '../rule-config';
|
||||
|
||||
-/**
|
||||
- * Option.
|
||||
- */
|
||||
-export interface NoConstructorReturnOption {
|
||||
- [k: string]: any;
|
||||
-}
|
||||
-
|
||||
/**
|
||||
* Options.
|
||||
*/
|
||||
-export type NoConstructorReturnOptions = NoConstructorReturnOption;
|
||||
+export type NoConstructorReturnOptions = [];
|
||||
|
||||
/**
|
||||
* Disallow returning value from constructor.
|
||||
@ -1,14 +0,0 @@
|
||||
diff --git b/lib/rules/graphql-eslint/naming-convention.d.ts a/lib/rules/graphql-eslint/naming-convention.d.ts
|
||||
index 60b228b..5e01373 100644
|
||||
--- b/lib/rules/graphql-eslint/naming-convention.d.ts
|
||||
+++ a/lib/rules/graphql-eslint/naming-convention.d.ts
|
||||
@@ -78,8 +78,7 @@ export type NamingConventionOption =
|
||||
VariableDefinition?: AsString | AsObject;
|
||||
allowLeadingUnderscore?: boolean;
|
||||
allowTrailingUnderscore?: boolean;
|
||||
- /**
|
||||
- */
|
||||
+ } & {
|
||||
[k: string]: AsString | AsObject;
|
||||
},
|
||||
];
|
||||
@ -1,13 +0,0 @@
|
||||
diff --git b/lib/rules/node/file-extension-in-import.d.ts a/lib/rules/node/file-extension-in-import.d.ts
|
||||
index 652b18d..7261252 100644
|
||||
--- b/lib/rules/node/file-extension-in-import.d.ts
|
||||
+++ a/lib/rules/node/file-extension-in-import.d.ts
|
||||
@@ -5,7 +5,7 @@ import type { RuleConfig } from '../rule-config';
|
||||
*/
|
||||
export interface FileExtensionInImportConfig {
|
||||
tryExtensions?: string[];
|
||||
- [k: string]: 'always' | 'never';
|
||||
+ [ext: `.${string}`]: 'always' | 'never';
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1,23 +0,0 @@
|
||||
diff --git a/lib/rules/react/jsx-no-constructed-context-values.d.ts b/lib/rules/react/jsx-no-constructed-context-values.d.ts
|
||||
index 410f060..e356693 100644
|
||||
--- a/lib/rules/react/jsx-no-constructed-context-values.d.ts
|
||||
+++ b/lib/rules/react/jsx-no-constructed-context-values.d.ts
|
||||
@@ -1,17 +1,9 @@
|
||||
import type { RuleConfig } from '../rule-config';
|
||||
|
||||
-/**
|
||||
- * Option.
|
||||
- */
|
||||
-export interface JsxNoConstructedContextValuesOption {
|
||||
- [k: string]: any;
|
||||
-}
|
||||
-
|
||||
/**
|
||||
* Options.
|
||||
*/
|
||||
-export type JsxNoConstructedContextValuesOptions =
|
||||
- JsxNoConstructedContextValuesOption;
|
||||
+export type JsxNoConstructedContextValuesOptions = [];
|
||||
|
||||
/**
|
||||
* Disallows JSX context provider values from taking values that will cause needless rerenders.
|
||||
@ -1,13 +0,0 @@
|
||||
diff --git a/lib/rules/react/jsx-props-no-spreading.d.ts b/lib/rules/react/jsx-props-no-spreading.d.ts
|
||||
index c1e0069..ba1e1bc 100644
|
||||
--- a/lib/rules/react/jsx-props-no-spreading.d.ts
|
||||
+++ b/lib/rules/react/jsx-props-no-spreading.d.ts
|
||||
@@ -8,8 +8,6 @@ export type JsxPropsNoSpreadingOption = {
|
||||
custom?: 'enforce' | 'ignore';
|
||||
exceptions?: string[];
|
||||
[k: string]: any;
|
||||
-} & {
|
||||
- [k: string]: any;
|
||||
};
|
||||
|
||||
/**
|
||||
@ -1,21 +0,0 @@
|
||||
diff --git a/lib/rules/vitest/valid-title.d.ts b/lib/rules/vitest/valid-title.d.ts
|
||||
index 160be76..834ac9b 100644
|
||||
--- a/lib/rules/vitest/valid-title.d.ts
|
||||
+++ b/lib/rules/vitest/valid-title.d.ts
|
||||
@@ -7,15 +7,7 @@ export interface ValidTitleOption {
|
||||
ignoreTypeOfDescribeName?: boolean;
|
||||
allowArguments?: boolean;
|
||||
disallowedWords?: string[];
|
||||
- /**
|
||||
- */
|
||||
- [k: string]:
|
||||
- | string
|
||||
- | [string]
|
||||
- | [string, string]
|
||||
- | {
|
||||
- [k: string]: string | [string] | [string, string];
|
||||
- };
|
||||
+ [k: string]: any;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1,178 +0,0 @@
|
||||
#!/usr/bin/env bun
|
||||
import { Logger, colors as cliColors } from '@poppinss/cliui';
|
||||
import { pascalCase } from 'change-case';
|
||||
import type { Rule } from 'eslint';
|
||||
import { existsSync, promises as fs } from 'node:fs';
|
||||
import { join, resolve } from 'node:path';
|
||||
import { format } from 'prettier';
|
||||
import { buildJSDoc, prettierConfig, type Plugin } from './utils';
|
||||
import { PLUGIN_REGISTRY, loadPlugin } from './plugins-map';
|
||||
import { RuleFile } from './rule-file';
|
||||
|
||||
interface FailedRule {
|
||||
ruleName: string;
|
||||
err: unknown;
|
||||
}
|
||||
|
||||
const logger = new Logger();
|
||||
const colors = cliColors.ansi();
|
||||
|
||||
const getRuleName = (name: string) =>
|
||||
name === 'ESLint' ? 'ESLintRule' : `${pascalCase(name)}Rule`;
|
||||
|
||||
const index: [string, string][] = [];
|
||||
|
||||
/**
|
||||
* Generate the `index.d.ts` file for the plugin's rules that will re-export all rules.
|
||||
*/
|
||||
async function generateRuleIndexFile(
|
||||
pluginDirectory: string,
|
||||
{ rules, name, id }: Plugin,
|
||||
failedRules: FailedRule[],
|
||||
): Promise<void> {
|
||||
const generatedRules = Object.keys(rules!).filter(
|
||||
ruleName => !failedRules.some(failedRule => failedRule.ruleName === ruleName),
|
||||
);
|
||||
|
||||
/**
|
||||
* Build all the import statements for the rules.
|
||||
*/
|
||||
const rulesImports = generatedRules
|
||||
.map(name => `import type { ${getRuleName(name)} } from './${name}';`)
|
||||
.join('\n');
|
||||
|
||||
/**
|
||||
* Build the exported type that is an intersection of all the rules.
|
||||
*/
|
||||
const rulesFinalIntersection = generatedRules
|
||||
.map(name => `${getRuleName(name)}`)
|
||||
.sort()
|
||||
.join(' & ');
|
||||
|
||||
const pluginRulesType = `
|
||||
${buildJSDoc([`All ${name} rules.`])}
|
||||
export type ${name}Rules = ${rulesFinalIntersection};
|
||||
`;
|
||||
|
||||
/**
|
||||
* Write the final `index.d.ts` file.
|
||||
*/
|
||||
const fileContent = `
|
||||
${rulesImports}
|
||||
|
||||
${pluginRulesType}
|
||||
`;
|
||||
|
||||
const indexPath = join(pluginDirectory, 'index.d.ts');
|
||||
await fs.writeFile(indexPath, await format(fileContent, prettierConfig));
|
||||
|
||||
index.push([`${name}Rules`, `./${id}/index`]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Print a report after having generated rules files for a plugin.
|
||||
*/
|
||||
function printGenerationReport(
|
||||
rules: Array<[string, Rule.RuleModule]>,
|
||||
failedRules: FailedRule[],
|
||||
): void {
|
||||
const msg: string = ` ✅ Generated ${rules.length - failedRules.length} rules`;
|
||||
logger.logUpdate(colors.green(msg));
|
||||
logger.logUpdatePersist();
|
||||
|
||||
if (failedRules.length) {
|
||||
logger.log(colors.red(` ❌ Failed ${failedRules.length} rules`));
|
||||
failedRules.forEach(({ ruleName, err }) => {
|
||||
logger.log(colors.red(` - ${ruleName}: ${String(err)}`));
|
||||
});
|
||||
}
|
||||
|
||||
logger.log('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a `.d.ts` file for each rule in the given plugin.
|
||||
*/
|
||||
async function generateRulesFiles(
|
||||
plugin: Plugin,
|
||||
pluginDirectory: string,
|
||||
): Promise<{ failedRules: FailedRule[] }> {
|
||||
const failedRules: FailedRule[] = [];
|
||||
|
||||
const pluginRules = plugin.rules;
|
||||
if (!pluginRules) {
|
||||
throw new Error(
|
||||
`Plugin ${plugin.name} doesn't have any rules. Did you forget to load them?`,
|
||||
);
|
||||
}
|
||||
|
||||
const rules = Object.entries(pluginRules);
|
||||
for (const [ruleName, rule] of rules) {
|
||||
logger.logUpdate(colors.yellow(` Generating > ${ruleName}`));
|
||||
|
||||
try {
|
||||
await RuleFile(plugin, pluginDirectory, ruleName, rule);
|
||||
} catch (err) {
|
||||
failedRules.push({ ruleName, err });
|
||||
}
|
||||
}
|
||||
|
||||
printGenerationReport(rules, failedRules);
|
||||
|
||||
return { failedRules };
|
||||
}
|
||||
|
||||
const rulesDirectory = resolve(__dirname, '../../../src/types/rules');
|
||||
|
||||
/**
|
||||
* If it doesn't exist, create the directory that will contain the plugin's rule files.
|
||||
*/
|
||||
async function createPluginDirectory(pluginName: string): Promise<string> {
|
||||
const pluginDirectory = join(rulesDirectory, pluginName);
|
||||
|
||||
if (existsSync(pluginDirectory)) {
|
||||
await fs.rm(pluginDirectory, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
await fs.mkdir(pluginDirectory, { mode: 0o755, recursive: true });
|
||||
|
||||
return pluginDirectory;
|
||||
}
|
||||
|
||||
export interface RunOptions {
|
||||
plugins?: string[];
|
||||
targetDirectory?: string;
|
||||
}
|
||||
|
||||
for (const plugin of PLUGIN_REGISTRY) {
|
||||
logger.info(`Generating ${plugin.name} rules.`);
|
||||
logger.logUpdate(colors.yellow(` Loading plugin > ${plugin.name}`));
|
||||
const loadedPlugin = await loadPlugin(plugin);
|
||||
|
||||
const pluginDir = await createPluginDirectory(plugin.id);
|
||||
const { failedRules } = await generateRulesFiles(loadedPlugin, pluginDir);
|
||||
|
||||
await generateRuleIndexFile(pluginDir, loadedPlugin, failedRules);
|
||||
}
|
||||
|
||||
await fs.writeFile(
|
||||
resolve(rulesDirectory, 'index.d.ts'),
|
||||
await format(
|
||||
[
|
||||
'import type { RuleConfig } from "./rule-config";',
|
||||
...index.map(([name, path]) => `import { ${name} } from ${JSON.stringify(path)};`),
|
||||
'',
|
||||
'/**',
|
||||
' * Rules.',
|
||||
' *',
|
||||
' * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules)',
|
||||
' */',
|
||||
'',
|
||||
'export type Rules = Partial<',
|
||||
...index.map(([name]) => ` ${name} &`),
|
||||
' Record<string, RuleConfig>',
|
||||
'>;',
|
||||
].join('\n'),
|
||||
prettierConfig,
|
||||
),
|
||||
);
|
||||
@ -1,58 +0,0 @@
|
||||
import type { JSONSchema4 } from 'json-schema';
|
||||
import { compile } from 'json-schema-to-typescript';
|
||||
|
||||
/**
|
||||
* Remove unnecessary comments that are generated by `json-schema-to-typescript`.
|
||||
*/
|
||||
function cleanJsDoc(content: string): string {
|
||||
const patterns = [
|
||||
/\* This interface was referenced by .+ JSON-Schema definition/,
|
||||
/\* via the `.+` "/,
|
||||
];
|
||||
|
||||
return content
|
||||
.split('\n')
|
||||
.filter(line => !patterns.some(ignoredLine => ignoredLine.test(line)))
|
||||
.join('\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace some types that are generated by `json-schema-to-typescript`.
|
||||
*/
|
||||
export function patchTypes(content: string): string {
|
||||
const replacements: [RegExp, string][] = [
|
||||
[
|
||||
/\(string & \{\s*\[k: string\]: any\s*\} & \{\s*\[k: string\]: any\s*\}\)\[\]/,
|
||||
'string[]',
|
||||
],
|
||||
];
|
||||
|
||||
for (const [pattern, replacement] of replacements) {
|
||||
content = content.replace(pattern, replacement);
|
||||
}
|
||||
|
||||
return content;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a type from the given JSON schema.
|
||||
*/
|
||||
export async function generateTypeFromSchema(
|
||||
schema: JSONSchema4,
|
||||
typeName: string,
|
||||
): Promise<string> {
|
||||
schema = JSON.parse(
|
||||
JSON.stringify(schema).replace(/#\/items\/0\/\$defs\//g, '#/$defs/'),
|
||||
);
|
||||
const result = await compile(schema, typeName, {
|
||||
format: false,
|
||||
bannerComment: '',
|
||||
style: {
|
||||
singleQuote: true,
|
||||
trailingComma: 'all',
|
||||
},
|
||||
unknownAny: false,
|
||||
});
|
||||
|
||||
return patchTypes(cleanJsDoc(result));
|
||||
}
|
||||
@ -1,145 +0,0 @@
|
||||
import type { Plugin, PluginRules } from './utils';
|
||||
|
||||
/**
|
||||
* Map of plugins for which the script will generate rule files.
|
||||
*/
|
||||
export const PLUGIN_REGISTRY: Plugin[] = [
|
||||
{
|
||||
id: 'deprecation',
|
||||
name: 'Deprecation',
|
||||
module: () => import('eslint-plugin-deprecation'),
|
||||
},
|
||||
{
|
||||
id: 'eslint',
|
||||
name: 'ESLint',
|
||||
module: () => import('eslint'),
|
||||
},
|
||||
{
|
||||
id: 'typescript-eslint',
|
||||
name: 'TypeScript',
|
||||
prefix: '@typescript-eslint',
|
||||
module: () => import('@typescript-eslint/eslint-plugin'),
|
||||
},
|
||||
{
|
||||
id: 'import',
|
||||
name: 'Import',
|
||||
module: () => import('eslint-plugin-import'),
|
||||
},
|
||||
{
|
||||
id: 'eslint-comments',
|
||||
name: 'EslintComments',
|
||||
module: () => import('eslint-plugin-eslint-comments'),
|
||||
},
|
||||
{
|
||||
id: 'graphql-eslint',
|
||||
name: 'GraphQL',
|
||||
prefix: '@graphql-eslint',
|
||||
module: () => import('@graphql-eslint/eslint-plugin'),
|
||||
},
|
||||
{
|
||||
id: 'jsdoc',
|
||||
name: 'JSDoc',
|
||||
prefix: 'jsdoc',
|
||||
module: () => import('eslint-plugin-jsdoc'),
|
||||
},
|
||||
{
|
||||
id: 'jsonc',
|
||||
name: 'Jsonc',
|
||||
module: () => import('eslint-plugin-jsonc'),
|
||||
},
|
||||
{
|
||||
id: 'jsx-a11y',
|
||||
name: 'JsxA11y',
|
||||
module: () => import('eslint-plugin-jsx-a11y'),
|
||||
},
|
||||
{
|
||||
id: 'mdx',
|
||||
name: 'Mdx',
|
||||
module: () => import('eslint-plugin-mdx'),
|
||||
},
|
||||
{
|
||||
id: 'n',
|
||||
name: 'N',
|
||||
module: () => import('eslint-plugin-n'),
|
||||
},
|
||||
{
|
||||
id: 'node',
|
||||
name: 'Node',
|
||||
module: () => import('eslint-plugin-node'),
|
||||
},
|
||||
{
|
||||
id: 'promise',
|
||||
name: 'Promise',
|
||||
module: () => import('eslint-plugin-promise'),
|
||||
},
|
||||
{
|
||||
id: 'react',
|
||||
name: 'React',
|
||||
module: () => import('eslint-plugin-react'),
|
||||
},
|
||||
{
|
||||
id: 'react-hooks',
|
||||
name: 'ReactHooks',
|
||||
module: () => import('eslint-plugin-react-hooks'),
|
||||
},
|
||||
{
|
||||
id: 'sonarjs',
|
||||
name: 'SonarJS',
|
||||
prefix: 'sonarjs',
|
||||
module: () => import('eslint-plugin-sonarjs'),
|
||||
},
|
||||
{
|
||||
id: 'spellcheck',
|
||||
name: 'Spellcheck',
|
||||
module: () => import('eslint-plugin-spellcheck'),
|
||||
},
|
||||
{
|
||||
id: 'testing-library',
|
||||
name: 'TestingLibrary',
|
||||
module: () => import('eslint-plugin-testing-library'),
|
||||
},
|
||||
{
|
||||
id: 'unicorn',
|
||||
name: 'Unicorn',
|
||||
module: () => import('eslint-plugin-unicorn'),
|
||||
},
|
||||
{
|
||||
id: 'vitest',
|
||||
name: 'Vitest',
|
||||
module: () => import('eslint-plugin-vitest'),
|
||||
},
|
||||
{
|
||||
id: 'vue',
|
||||
name: 'Vue',
|
||||
module: () => import('eslint-plugin-vue'),
|
||||
},
|
||||
{
|
||||
id: 'vue-i18n',
|
||||
name: 'VueI18n',
|
||||
prefix: '@intlify/vue-i18n',
|
||||
module: () => import('@intlify/eslint-plugin-vue-i18n'),
|
||||
},
|
||||
{
|
||||
id: 'vue-pug',
|
||||
name: 'VuePug',
|
||||
module: () => import('eslint-plugin-vue-pug'),
|
||||
},
|
||||
{
|
||||
id: 'yml',
|
||||
name: 'Yml',
|
||||
module: () => import('eslint-plugin-yml'),
|
||||
},
|
||||
] as const;
|
||||
|
||||
export async function loadPlugin(plugin: Plugin): Promise<Plugin> {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
const mod: any = await plugin.module();
|
||||
const rules: PluginRules =
|
||||
plugin.name === 'ESLint'
|
||||
? Object.fromEntries(
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
||||
new mod.Linter().getRules().entries(),
|
||||
)
|
||||
: mod.rules ?? mod.default.rules;
|
||||
return { ...plugin, rules };
|
||||
}
|
||||
@ -1,168 +0,0 @@
|
||||
import { Logger, colors as cliColors } from '@poppinss/cliui';
|
||||
import { pascalCase, kebabCase } from 'change-case';
|
||||
import type { Rule } from 'eslint';
|
||||
import type { JSONSchema4 } from 'json-schema';
|
||||
import { execSync } from 'node:child_process';
|
||||
import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
|
||||
import { dirname, resolve } from 'node:path';
|
||||
import { format } from 'prettier';
|
||||
import { generateTypeFromSchema } from './json-schema-to-ts';
|
||||
import { buildJSDoc, prettierConfig, type Plugin } from './utils';
|
||||
|
||||
const logger = new Logger();
|
||||
const colors = cliColors.ansi();
|
||||
|
||||
/**
|
||||
* Build the rule description to append to the JSDoc.
|
||||
*/
|
||||
function buildDescription(description = ''): string {
|
||||
description = description.charAt(0).toUpperCase() + description.slice(1);
|
||||
if (description.length > 0 && !description.endsWith('.')) {
|
||||
description += '.';
|
||||
}
|
||||
|
||||
return description.replace('*/', '');
|
||||
}
|
||||
|
||||
export async function RuleFile(
|
||||
plugin: Plugin,
|
||||
pluginDirectory: string,
|
||||
ruleName: string,
|
||||
rule: Rule.RuleModule,
|
||||
) {
|
||||
let content = '';
|
||||
|
||||
const rulePath = resolve(pluginDirectory, `${ruleName}.d.ts`);
|
||||
const ruleNamePascalCase = pascalCase(ruleName);
|
||||
const schema: JSONSchema4 | JSONSchema4[] | undefined = rule.meta?.schema;
|
||||
const isSchemaArray = Array.isArray(schema);
|
||||
|
||||
const mainSchema = isSchemaArray ? schema[0] : schema;
|
||||
const sideSchema = isSchemaArray && schema.length > 1 ? schema[1] : undefined;
|
||||
const thirdSchema = isSchemaArray && schema.length > 2 ? schema[2] : undefined;
|
||||
|
||||
/**
|
||||
* Generate a JSDoc with the rule description and `@see` url.
|
||||
*/
|
||||
function generateTypeJsDoc(): string {
|
||||
const { meta } = rule;
|
||||
const seeDocLink: string = meta?.docs?.url
|
||||
? `@see [${ruleName}](${meta.docs.url})`
|
||||
: '';
|
||||
|
||||
return buildJSDoc([
|
||||
buildDescription(rule.meta?.docs?.description),
|
||||
' ',
|
||||
rule.meta?.deprecated ? '@deprecated' : '',
|
||||
rule.meta?.deprecated ? ' ' : '',
|
||||
seeDocLink,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a type from a JSON schema and append it to the file content.
|
||||
*/
|
||||
async function appendJsonSchemaType(
|
||||
schema: JSONSchema4,
|
||||
comment: string,
|
||||
): Promise<void> {
|
||||
const type = await generateTypeFromSchema(schema, ruleNamePascalCase + comment);
|
||||
const jsdoc = buildJSDoc([`${comment}.`]);
|
||||
content += `\n${jsdoc}`;
|
||||
content += `\n${type}\n`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scoped rule name ESLint config uses.
|
||||
*/
|
||||
function prefixedRuleName(): string {
|
||||
const { prefix, name } = plugin;
|
||||
const rulePrefix = (prefix ?? kebabCase(name)) + '/';
|
||||
return name === 'ESLint' ? ruleName : `${rulePrefix}${ruleName}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Append the `import type { RuleConfig } from '../rule-config'` at the top of the file.
|
||||
*/
|
||||
const nestedDepth = ruleName.split('/').length;
|
||||
content += `import type { RuleConfig } from '${'../'.repeat(nestedDepth)}rule-config'\n\n`;
|
||||
|
||||
/**
|
||||
* Generate and append types for the rule schemas.
|
||||
*/
|
||||
if (thirdSchema) {
|
||||
await appendJsonSchemaType(thirdSchema, 'Setting');
|
||||
}
|
||||
if (sideSchema) {
|
||||
await appendJsonSchemaType(sideSchema, 'Config');
|
||||
}
|
||||
if (mainSchema) {
|
||||
await appendJsonSchemaType(mainSchema, 'Option');
|
||||
}
|
||||
|
||||
if (mainSchema) {
|
||||
/**
|
||||
* Append the rule type options to the file content.
|
||||
*/
|
||||
let type: string = '';
|
||||
if (!isSchemaArray) {
|
||||
type = `${ruleNamePascalCase}Option`;
|
||||
} else if (thirdSchema) {
|
||||
type = `[${ruleNamePascalCase}Option?, ${ruleNamePascalCase}Config?, ${ruleNamePascalCase}Setting?]`;
|
||||
} else if (sideSchema) {
|
||||
type = `[${ruleNamePascalCase}Option?, ${ruleNamePascalCase}Config?]`;
|
||||
} else if (mainSchema) {
|
||||
type = `[${ruleNamePascalCase}Option?]`;
|
||||
}
|
||||
|
||||
content += buildJSDoc(['Options.']) + '\n';
|
||||
content += `export type ${ruleNamePascalCase}Options = ${type}\n\n`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Append the rule config type to the file content.
|
||||
*/
|
||||
content += generateTypeJsDoc() + '\n';
|
||||
content += `export type ${ruleNamePascalCase}RuleConfig = RuleConfig<${mainSchema ? `${ruleNamePascalCase}Options` : '[]'}>;\n\n`;
|
||||
|
||||
/**
|
||||
* Append the final rule interface to the file content.
|
||||
*/
|
||||
content += generateTypeJsDoc() + '\n';
|
||||
content += `export interface ${ruleNamePascalCase}Rule {`;
|
||||
content += `${generateTypeJsDoc()}\n`;
|
||||
content += `'${prefixedRuleName()}': ${ruleNamePascalCase}RuleConfig;`;
|
||||
content += '}';
|
||||
|
||||
content = await format(content, prettierConfig);
|
||||
|
||||
/**
|
||||
* Create the directory of the rule file if it doesn't exist.
|
||||
*/
|
||||
const subPath = dirname(rulePath);
|
||||
if (!existsSync(subPath)) {
|
||||
mkdirSync(subPath, { recursive: true });
|
||||
}
|
||||
|
||||
writeFileSync(rulePath, content);
|
||||
|
||||
/**
|
||||
* Apply a patch to the generated content if a diff file exists for it.
|
||||
*
|
||||
* Must be called after `generate()`.
|
||||
*/
|
||||
const pathParts = rulePath.split('/');
|
||||
const diffFile = resolve(
|
||||
__dirname,
|
||||
'./diffs/rules',
|
||||
pathParts.at(-2) ?? '',
|
||||
`${pathParts.at(-1) ?? ''}.diff`,
|
||||
);
|
||||
|
||||
if (existsSync(diffFile)) {
|
||||
logger.logUpdate(colors.yellow(` 🧹 Adjusting ${prefixedRuleName()}`));
|
||||
logger.logUpdatePersist();
|
||||
|
||||
execSync(`git apply ${diffFile}`);
|
||||
}
|
||||
}
|
||||
@ -1,24 +0,0 @@
|
||||
import type { Rule } from 'eslint';
|
||||
import type { Config } from 'prettier';
|
||||
|
||||
export function buildJSDoc(content: string[]) {
|
||||
return ['/**', ...content.filter(Boolean).map(line => ` * ${line}`), ' */'].join('\n');
|
||||
}
|
||||
|
||||
export const prettierConfig: Config = {
|
||||
plugins: ['prettier-plugin-organize-imports'],
|
||||
parser: 'typescript',
|
||||
singleQuote: true,
|
||||
trailingComma: 'all',
|
||||
};
|
||||
|
||||
export type MaybeArray<T> = T | T[];
|
||||
export type PluginRules = Record<string, Rule.RuleModule>;
|
||||
|
||||
export interface Plugin {
|
||||
id: string;
|
||||
name: string;
|
||||
prefix?: string;
|
||||
module: () => Promise<any>;
|
||||
rules?: PluginRules;
|
||||
}
|
||||
Submodule packages/eslint-import-resolver-typescript updated: 7a02ac08b5...c9b5626ee6
Submodule packages/eslint-plugin-import deleted from f77ceb679d
Submodule packages/eslint-plugin-jsx-a11y updated: 0d5321a545...cca288b73a
Submodule packages/eslint-plugin-n updated: eb11b5b35a...5aad5f1c41
Submodule packages/eslint-plugin-react deleted from 4467db503e
@ -8,22 +8,20 @@
|
||||
/* eslint-disable no-for-of-loops/no-for-of-loops */
|
||||
import type { Rule, Scope } from 'eslint';
|
||||
import type {
|
||||
ArrayExpression,
|
||||
ArrowFunctionExpression,
|
||||
CallExpression,
|
||||
ChainExpression,
|
||||
Expression,
|
||||
FunctionDeclaration,
|
||||
FunctionExpression,
|
||||
Identifier,
|
||||
MemberExpression,
|
||||
Node,
|
||||
OptionalMemberExpression,
|
||||
Pattern,
|
||||
SpreadElement,
|
||||
CallExpression,
|
||||
Expression,
|
||||
Super,
|
||||
TSAsExpression,
|
||||
Node,
|
||||
ArrowFunctionExpression,
|
||||
FunctionExpression,
|
||||
SpreadElement,
|
||||
Identifier,
|
||||
VariableDeclarator,
|
||||
MemberExpression,
|
||||
ChainExpression,
|
||||
Pattern,
|
||||
OptionalMemberExpression,
|
||||
} from 'estree';
|
||||
import type { FromSchema } from 'json-schema-to-ts';
|
||||
import { __EXPERIMENTAL__ } from './index';
|
||||
@ -111,7 +109,7 @@ const rule: Rule.RuleModule = {
|
||||
*/
|
||||
function visitFunctionWithDependencies(
|
||||
node: ArrowFunctionExpression | FunctionExpression | FunctionDeclaration,
|
||||
declaredDependenciesNode: SpreadElement | Expression | undefined,
|
||||
declaredDependenciesNode: SpreadElement | Expression,
|
||||
reactiveHook: Super | Expression,
|
||||
reactiveHookName: string,
|
||||
isEffect: boolean,
|
||||
@ -130,7 +128,7 @@ const rule: Rule.RuleModule = {
|
||||
' }\n' +
|
||||
' fetchData();\n' +
|
||||
`}, [someId]); // Or [] if effect doesn't need props or state\n\n` +
|
||||
'Learn more about data fetching with Hooks: https://react.dev/link/hooks-data-fetching',
|
||||
'Learn more about data fetching with Hooks: https://reactjs.org/link/hooks-data-fetching',
|
||||
});
|
||||
}
|
||||
|
||||
@ -196,7 +194,7 @@ const rule: Rule.RuleModule = {
|
||||
if (init == null) {
|
||||
return false;
|
||||
}
|
||||
while (init.type === 'TSAsExpression' || init.type === 'AsExpression') {
|
||||
while (init.type === 'TSAsExpression') {
|
||||
init = init.expression;
|
||||
}
|
||||
// Detect primitive constants
|
||||
@ -622,11 +620,7 @@ const rule: Rule.RuleModule = {
|
||||
|
||||
const declaredDependencies: DeclaredDependency[] = [];
|
||||
const externalDependencies = new Set<string>();
|
||||
const isArrayExpression = declaredDependenciesNode.type === 'ArrayExpression';
|
||||
const isTSAsArrayExpression =
|
||||
declaredDependenciesNode.type === 'TSAsExpression' &&
|
||||
declaredDependenciesNode.expression.type === 'ArrayExpression';
|
||||
if (!isArrayExpression && !isTSAsArrayExpression) {
|
||||
if (declaredDependenciesNode.type !== 'ArrayExpression') {
|
||||
// If the declared dependencies are not an array expression then we
|
||||
// can't verify that the user provided the correct dependencies. Tell
|
||||
// the user this in an error.
|
||||
@ -639,10 +633,7 @@ const rule: Rule.RuleModule = {
|
||||
'dependencies.',
|
||||
});
|
||||
} else {
|
||||
const arrayExpression = isTSAsArrayExpression
|
||||
? ((declaredDependenciesNode as TSAsExpression).expression as ArrayExpression)
|
||||
: (declaredDependenciesNode as ArrayExpression);
|
||||
arrayExpression.elements.forEach(declaredDependencyNode => {
|
||||
declaredDependenciesNode.elements.forEach(declaredDependencyNode => {
|
||||
// Skip elided elements.
|
||||
if (declaredDependencyNode === null) {
|
||||
return;
|
||||
@ -1167,11 +1158,7 @@ const rule: Rule.RuleModule = {
|
||||
const reactiveHook = node.callee as Identifier | MemberExpression;
|
||||
const reactiveHookName = (getNodeWithoutReactNamespace(reactiveHook) as Identifier)
|
||||
.name;
|
||||
const maybeNode = node.arguments[callbackIndex + 1];
|
||||
const declaredDependenciesNode =
|
||||
maybeNode && !(maybeNode.type === 'Identifier' && maybeNode.name === 'undefined')
|
||||
? maybeNode
|
||||
: undefined;
|
||||
const declaredDependenciesNode = node.arguments[callbackIndex + 1];
|
||||
const isEffect = /Effect($|[^a-z])/g.test(reactiveHookName);
|
||||
|
||||
// Check whether a callback is supplied. If there is no callback supplied
|
||||
@ -1216,15 +1203,6 @@ const rule: Rule.RuleModule = {
|
||||
isEffect,
|
||||
);
|
||||
return; // Handled
|
||||
case 'TSAsExpression':
|
||||
visitFunctionWithDependencies(
|
||||
callback.expression,
|
||||
declaredDependenciesNode,
|
||||
reactiveHook,
|
||||
reactiveHookName,
|
||||
isEffect,
|
||||
);
|
||||
return; // Handled
|
||||
case 'Identifier':
|
||||
if (!declaredDependenciesNode) {
|
||||
// No deps, no problems.
|
||||
@ -1567,7 +1545,7 @@ function getConstructionExpressionType(node: Node) {
|
||||
}
|
||||
return null;
|
||||
case 'TypeCastExpression':
|
||||
case 'AsExpression':
|
||||
return getConstructionExpressionType(node.expression);
|
||||
case 'TSAsExpression':
|
||||
return getConstructionExpressionType(node.expression);
|
||||
}
|
||||
@ -1771,7 +1749,7 @@ function analyzePropertyChain(
|
||||
}
|
||||
}
|
||||
|
||||
function getNodeWithoutReactNamespace(node: Expression | Super) {
|
||||
function getNodeWithoutReactNamespace(node: Identifier | MemberExpression) {
|
||||
if (
|
||||
node.type === 'MemberExpression' &&
|
||||
node.object.type === 'Identifier' &&
|
||||
|
||||
@ -24,8 +24,11 @@ import { __EXPERIMENTAL__ } from './index';
|
||||
*/
|
||||
|
||||
function isHookName(s: string) {
|
||||
if (__EXPERIMENTAL__) {
|
||||
return s === 'use' || /^use[A-Z0-9]/.test(s);
|
||||
}
|
||||
return /^use[A-Z0-9]/.test(s);
|
||||
}
|
||||
|
||||
/**
|
||||
* We consider hooks to be a hook name identifier or a member expression
|
||||
@ -56,7 +59,7 @@ function isComponentName(node: Node) {
|
||||
return node.type === 'Identifier' && /^[A-Z]/.test(node.name);
|
||||
}
|
||||
|
||||
function isReactFunction(node: Node, functionName: string) {
|
||||
function isReactFunction(node: Expression | Super, functionName: string) {
|
||||
return (
|
||||
(node as Identifier).name === functionName ||
|
||||
(node.type === 'MemberExpression' &&
|
||||
@ -112,7 +115,10 @@ function isUseEffectEventIdentifier(node: Node) {
|
||||
}
|
||||
|
||||
function isUseIdentifier(node: Node) {
|
||||
return isReactFunction(node, 'use');
|
||||
if (__EXPERIMENTAL__) {
|
||||
return node.type === 'Identifier' && node.name === 'use';
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
const rule: Rule.RuleModule = {
|
||||
|
||||
@ -3,8 +3,8 @@
|
||||
"version": 1,
|
||||
"sources": {
|
||||
"main": {
|
||||
"repository": "https://github.com/facebook/react",
|
||||
"commit": "0e0b69321a6fcfe8a3eaae3b1016beb110437b38",
|
||||
"repository": "git@github.com:facebook/react.git",
|
||||
"commit": "899cb95f52cc83ab5ca1eb1e268c909d3f0961e7",
|
||||
"branch": "main"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,28 +1,10 @@
|
||||
diff --git a/package.json b/package.json
|
||||
index 98370b5..da6cd9b 100644
|
||||
--- a/package.json
|
||||
+++ b/package.json
|
||||
@@ -62,8 +62,7 @@
|
||||
"typecov": "type-coverage"
|
||||
},
|
||||
"peerDependencies": {
|
||||
- "eslint": "*",
|
||||
- "eslint-plugin-import": "*"
|
||||
+ "eslint": "*"
|
||||
},
|
||||
"dependencies": {
|
||||
"debug": "^4.3.4",
|
||||
diff --git a/tsconfig.json b/tsconfig.json
|
||||
deleted file mode 100644
|
||||
index a303861..0000000
|
||||
index 39c6900..6fd8822 100644
|
||||
--- a/tsconfig.json
|
||||
+++ /dev/null
|
||||
@@ -1,8 +0,0 @@
|
||||
-{
|
||||
+++ b/tsconfig.json
|
||||
@@ -1,5 +1,4 @@
|
||||
{
|
||||
- "extends": "@1stg/tsconfig/node16",
|
||||
- "compilerOptions": {
|
||||
- "module": "Node16",
|
||||
- "outDir": "./lib"
|
||||
- },
|
||||
- "include": ["./src", "./shim.d.ts"]
|
||||
-}
|
||||
"compilerOptions": {
|
||||
"module": "Node16",
|
||||
"outDir": "./lib",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,10 +1,16 @@
|
||||
diff --git a/src/index.js b/src/index.js
|
||||
index 7b931fe..eaea267 100644
|
||||
index 2fa185f..29d65d0 100644
|
||||
--- a/src/index.js
|
||||
+++ b/src/index.js
|
||||
@@ -1,296 +1,344 @@
|
||||
@@ -1,48 +1,90 @@
|
||||
/* eslint-disable global-require */
|
||||
+// @ts-check
|
||||
-const flatConfigBase = require('./configs/flat-config-base');
|
||||
-const legacyConfigBase = require('./configs/legacy-config-base');
|
||||
-const { name, version } = require('../package.json');
|
||||
+import flatConfigBase from './configs/flat-config-base';
|
||||
+import legacyConfigBase from './configs/legacy-config-base';
|
||||
+import { name, version } from '../package.json';
|
||||
+
|
||||
+import accessibleEmoji from './rules/accessible-emoji';
|
||||
+import altText from './rules/alt-text';
|
||||
+import anchorAmbiguousText from './rules/anchor-ambiguous-text';
|
||||
@ -45,8 +51,7 @@ index 7b931fe..eaea267 100644
|
||||
+import scope from './rules/scope';
|
||||
+import tabindexNoPositive from './rules/tabindex-no-positive';
|
||||
|
||||
-module.exports = {
|
||||
- rules: {
|
||||
const allRules = {
|
||||
- 'accessible-emoji': require('./rules/accessible-emoji'),
|
||||
- 'alt-text': require('./rules/alt-text'),
|
||||
- 'anchor-ambiguous-text': require('./rules/anchor-ambiguous-text'),
|
||||
@ -86,536 +91,65 @@ index 7b931fe..eaea267 100644
|
||||
- 'role-supports-aria-props': require('./rules/role-supports-aria-props'),
|
||||
- scope: require('./rules/scope'),
|
||||
- 'tabindex-no-positive': require('./rules/tabindex-no-positive'),
|
||||
- },
|
||||
- configs: {
|
||||
- recommended: {
|
||||
- plugins: [
|
||||
- 'jsx-a11y',
|
||||
+export const rules = kebabCase({
|
||||
+ accessibleEmoji,
|
||||
+ altText,
|
||||
+ anchorAmbiguousText,
|
||||
+ anchorHasContent,
|
||||
+ anchorIsValid,
|
||||
+ ariaActivedescendantHasTabindex,
|
||||
+ ariaProps,
|
||||
+ ariaProptypes,
|
||||
+ ariaRole,
|
||||
+ ariaUnsupportedElements,
|
||||
+ autocompleteValid,
|
||||
+ clickEventsHaveKeyEvents,
|
||||
+ controlHasAssociatedLabel,
|
||||
+ headingHasContent,
|
||||
+ htmlHasLang,
|
||||
+ iframeHasTitle,
|
||||
+ imgRedundantAlt,
|
||||
+ interactiveSupportsFocus,
|
||||
+ labelHasAssociatedControl,
|
||||
+ labelHasFor,
|
||||
+ 'accessible-emoji': accessibleEmoji,
|
||||
+ 'alt-text': altText,
|
||||
+ 'anchor-ambiguous-text': anchorAmbiguousText,
|
||||
+ 'anchor-has-content': anchorHasContent,
|
||||
+ 'anchor-is-valid': anchorIsValid,
|
||||
+ 'aria-activedescendant-has-tabindex': ariaActivedescendantHasTabindex,
|
||||
+ 'aria-props': ariaProps,
|
||||
+ 'aria-proptypes': ariaProptypes,
|
||||
+ 'aria-role': ariaRole,
|
||||
+ 'aria-unsupported-elements': ariaUnsupportedElements,
|
||||
+ 'autocomplete-valid': autocompleteValid,
|
||||
+ 'click-events-have-key-events': clickEventsHaveKeyEvents,
|
||||
+ 'control-has-associated-label': controlHasAssociatedLabel,
|
||||
+ 'heading-has-content': headingHasContent,
|
||||
+ 'html-has-lang': htmlHasLang,
|
||||
+ 'iframe-has-title': iframeHasTitle,
|
||||
+ 'img-redundant-alt': imgRedundantAlt,
|
||||
+ 'interactive-supports-focus': interactiveSupportsFocus,
|
||||
+ 'label-has-associated-control': labelHasAssociatedControl,
|
||||
+ 'label-has-for': labelHasFor,
|
||||
+ lang,
|
||||
+ mediaHasCaption,
|
||||
+ mouseEventsHaveKeyEvents,
|
||||
+ noAccessKey,
|
||||
+ noAriaHiddenOnFocusable,
|
||||
+ noAutofocus,
|
||||
+ noDistractingElements,
|
||||
+ 'media-has-caption': mediaHasCaption,
|
||||
+ 'mouse-events-have-key-events': mouseEventsHaveKeyEvents,
|
||||
+ 'no-access-key': noAccessKey,
|
||||
+ 'no-aria-hidden-on-focusable': noAriaHiddenOnFocusable,
|
||||
+ 'no-autofocus': noAutofocus,
|
||||
+ 'no-distracting-elements': noDistractingElements,
|
||||
+ 'no-interactive-element-to-noninteractive-role':
|
||||
+ noInteractiveElementToNoninteractiveRole,
|
||||
+ noNoninteractiveElementInteractions,
|
||||
+ 'no-noninteractive-element-interactions': noNoninteractiveElementInteractions,
|
||||
+ 'no-noninteractive-element-to-interactive-role':
|
||||
+ noNoninteractiveElementToInteractiveRole,
|
||||
+ noNoninteractiveTabindex,
|
||||
+ noOnChange,
|
||||
+ noRedundantRoles,
|
||||
+ noStaticElementInteractions,
|
||||
+ preferTagOverRole,
|
||||
+ roleHasRequiredAriaProps,
|
||||
+ roleSupportsAriaProps,
|
||||
+ 'no-noninteractive-tabindex': noNoninteractiveTabindex,
|
||||
+ 'no-onchange': noOnChange,
|
||||
+ 'no-redundant-roles': noRedundantRoles,
|
||||
+ 'no-static-element-interactions': noStaticElementInteractions,
|
||||
+ 'prefer-tag-over-role': preferTagOverRole,
|
||||
+ 'role-has-required-aria-props': roleHasRequiredAriaProps,
|
||||
+ 'role-supports-aria-props': roleSupportsAriaProps,
|
||||
+ scope,
|
||||
+ tabindexNoPositive,
|
||||
+});
|
||||
+export const configs = {
|
||||
+ recommended: {
|
||||
+ plugins: [
|
||||
+ 'jsx-a11y',
|
||||
+ ],
|
||||
+ parserOptions: {
|
||||
+ ecmaFeatures: {
|
||||
+ jsx: true,
|
||||
+ },
|
||||
+ },
|
||||
+ rules: {
|
||||
+ 'jsx-a11y/alt-text': 'error',
|
||||
+ 'jsx-a11y/anchor-ambiguous-text': 'off', // TODO: error
|
||||
+ 'jsx-a11y/anchor-has-content': 'error',
|
||||
+ 'jsx-a11y/anchor-is-valid': 'error',
|
||||
+ 'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
|
||||
+ 'jsx-a11y/aria-props': 'error',
|
||||
+ 'jsx-a11y/aria-proptypes': 'error',
|
||||
+ 'jsx-a11y/aria-role': 'error',
|
||||
+ 'jsx-a11y/aria-unsupported-elements': 'error',
|
||||
+ 'jsx-a11y/autocomplete-valid': 'error',
|
||||
+ 'jsx-a11y/click-events-have-key-events': 'error',
|
||||
+ 'jsx-a11y/control-has-associated-label': ['off', {
|
||||
+ ignoreElements: [
|
||||
+ 'audio',
|
||||
+ 'canvas',
|
||||
+ 'embed',
|
||||
+ 'input',
|
||||
+ 'textarea',
|
||||
+ 'tr',
|
||||
+ 'video',
|
||||
+ ],
|
||||
+ ignoreRoles: [
|
||||
+ 'grid',
|
||||
+ 'listbox',
|
||||
+ 'menu',
|
||||
+ 'menubar',
|
||||
+ 'radiogroup',
|
||||
+ 'row',
|
||||
+ 'tablist',
|
||||
+ 'toolbar',
|
||||
+ 'tree',
|
||||
+ 'treegrid',
|
||||
+ ],
|
||||
+ includeRoles: [
|
||||
+ 'alert',
|
||||
+ 'dialog',
|
||||
+ ],
|
||||
+ }],
|
||||
+ 'jsx-a11y/heading-has-content': 'error',
|
||||
+ 'jsx-a11y/html-has-lang': 'error',
|
||||
+ 'jsx-a11y/iframe-has-title': 'error',
|
||||
+ 'jsx-a11y/img-redundant-alt': 'error',
|
||||
+ 'jsx-a11y/interactive-supports-focus': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ tabbable: [
|
||||
+ 'button',
|
||||
+ 'checkbox',
|
||||
+ 'link',
|
||||
+ 'searchbox',
|
||||
+ 'spinbutton',
|
||||
+ 'switch',
|
||||
+ 'textbox',
|
||||
+ ],
|
||||
+ },
|
||||
],
|
||||
- parserOptions: {
|
||||
- ecmaFeatures: {
|
||||
- jsx: true,
|
||||
+ 'jsx-a11y/label-has-associated-control': 'error',
|
||||
+ 'jsx-a11y/label-has-for': 'off',
|
||||
+ 'jsx-a11y/media-has-caption': 'error',
|
||||
+ 'jsx-a11y/mouse-events-have-key-events': 'error',
|
||||
+ 'jsx-a11y/no-access-key': 'error',
|
||||
+ 'jsx-a11y/no-autofocus': 'error',
|
||||
+ 'jsx-a11y/no-distracting-elements': 'error',
|
||||
+ 'jsx-a11y/no-interactive-element-to-noninteractive-role': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ tr: ['none', 'presentation'],
|
||||
+ canvas: ['img'],
|
||||
},
|
||||
- },
|
||||
- rules: {
|
||||
- 'jsx-a11y/alt-text': 'error',
|
||||
- 'jsx-a11y/anchor-ambiguous-text': 'off', // TODO: error
|
||||
- 'jsx-a11y/anchor-has-content': 'error',
|
||||
- 'jsx-a11y/anchor-is-valid': 'error',
|
||||
- 'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
|
||||
- 'jsx-a11y/aria-props': 'error',
|
||||
- 'jsx-a11y/aria-proptypes': 'error',
|
||||
- 'jsx-a11y/aria-role': 'error',
|
||||
- 'jsx-a11y/aria-unsupported-elements': 'error',
|
||||
- 'jsx-a11y/autocomplete-valid': 'error',
|
||||
- 'jsx-a11y/click-events-have-key-events': 'error',
|
||||
- 'jsx-a11y/control-has-associated-label': ['off', {
|
||||
- ignoreElements: [
|
||||
- 'audio',
|
||||
- 'canvas',
|
||||
- 'embed',
|
||||
- 'input',
|
||||
- 'textarea',
|
||||
- 'tr',
|
||||
- 'video',
|
||||
+ ],
|
||||
+ 'jsx-a11y/no-noninteractive-element-interactions': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ handlers: [
|
||||
+ 'onClick',
|
||||
+ 'onError',
|
||||
+ 'onLoad',
|
||||
+ 'onMouseDown',
|
||||
+ 'onMouseUp',
|
||||
+ 'onKeyPress',
|
||||
+ 'onKeyDown',
|
||||
+ 'onKeyUp',
|
||||
],
|
||||
- ignoreRoles: [
|
||||
- 'grid',
|
||||
+ alert: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
|
||||
+ body: ['onError', 'onLoad'],
|
||||
+ dialog: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
|
||||
+ iframe: ['onError', 'onLoad'],
|
||||
+ img: ['onError', 'onLoad'],
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/no-noninteractive-element-to-interactive-role': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ ul: [
|
||||
'listbox',
|
||||
'menu',
|
||||
'menubar',
|
||||
'radiogroup',
|
||||
- 'row',
|
||||
'tablist',
|
||||
- 'toolbar',
|
||||
'tree',
|
||||
'treegrid',
|
||||
],
|
||||
- includeRoles: [
|
||||
- 'alert',
|
||||
- 'dialog',
|
||||
- ],
|
||||
- }],
|
||||
- 'jsx-a11y/heading-has-content': 'error',
|
||||
- 'jsx-a11y/html-has-lang': 'error',
|
||||
- 'jsx-a11y/iframe-has-title': 'error',
|
||||
- 'jsx-a11y/img-redundant-alt': 'error',
|
||||
- 'jsx-a11y/interactive-supports-focus': [
|
||||
- 'error',
|
||||
- {
|
||||
- tabbable: [
|
||||
- 'button',
|
||||
- 'checkbox',
|
||||
- 'link',
|
||||
- 'searchbox',
|
||||
- 'spinbutton',
|
||||
- 'switch',
|
||||
- 'textbox',
|
||||
- ],
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/label-has-associated-control': 'error',
|
||||
- 'jsx-a11y/label-has-for': 'off',
|
||||
- 'jsx-a11y/media-has-caption': 'error',
|
||||
- 'jsx-a11y/mouse-events-have-key-events': 'error',
|
||||
- 'jsx-a11y/no-access-key': 'error',
|
||||
- 'jsx-a11y/no-autofocus': 'error',
|
||||
- 'jsx-a11y/no-distracting-elements': 'error',
|
||||
- 'jsx-a11y/no-interactive-element-to-noninteractive-role': [
|
||||
- 'error',
|
||||
- {
|
||||
- tr: ['none', 'presentation'],
|
||||
- canvas: ['img'],
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/no-noninteractive-element-interactions': [
|
||||
- 'error',
|
||||
- {
|
||||
- handlers: [
|
||||
- 'onClick',
|
||||
- 'onError',
|
||||
- 'onLoad',
|
||||
- 'onMouseDown',
|
||||
- 'onMouseUp',
|
||||
- 'onKeyPress',
|
||||
- 'onKeyDown',
|
||||
- 'onKeyUp',
|
||||
- ],
|
||||
- alert: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
|
||||
- body: ['onError', 'onLoad'],
|
||||
- dialog: ['onKeyUp', 'onKeyDown', 'onKeyPress'],
|
||||
- iframe: ['onError', 'onLoad'],
|
||||
- img: ['onError', 'onLoad'],
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/no-noninteractive-element-to-interactive-role': [
|
||||
- 'error',
|
||||
- {
|
||||
- ul: [
|
||||
- 'listbox',
|
||||
- 'menu',
|
||||
- 'menubar',
|
||||
- 'radiogroup',
|
||||
- 'tablist',
|
||||
- 'tree',
|
||||
- 'treegrid',
|
||||
- ],
|
||||
- ol: [
|
||||
- 'listbox',
|
||||
- 'menu',
|
||||
- 'menubar',
|
||||
- 'radiogroup',
|
||||
- 'tablist',
|
||||
- 'tree',
|
||||
- 'treegrid',
|
||||
- ],
|
||||
- li: ['menuitem', 'option', 'row', 'tab', 'treeitem'],
|
||||
- table: ['grid'],
|
||||
- td: ['gridcell'],
|
||||
- fieldset: ['radiogroup', 'presentation'],
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/no-noninteractive-tabindex': [
|
||||
- 'error',
|
||||
- {
|
||||
- tags: [],
|
||||
- roles: ['tabpanel'],
|
||||
- allowExpressionValues: true,
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/no-redundant-roles': 'error',
|
||||
- 'jsx-a11y/no-static-element-interactions': [
|
||||
- 'error',
|
||||
- {
|
||||
- allowExpressionValues: true,
|
||||
- handlers: [
|
||||
- 'onClick',
|
||||
- 'onMouseDown',
|
||||
- 'onMouseUp',
|
||||
- 'onKeyPress',
|
||||
- 'onKeyDown',
|
||||
- 'onKeyUp',
|
||||
- ],
|
||||
- },
|
||||
- ],
|
||||
- 'jsx-a11y/role-has-required-aria-props': 'error',
|
||||
- 'jsx-a11y/role-supports-aria-props': 'error',
|
||||
- 'jsx-a11y/scope': 'error',
|
||||
- 'jsx-a11y/tabindex-no-positive': 'error',
|
||||
- },
|
||||
- },
|
||||
- strict: {
|
||||
- plugins: [
|
||||
- 'jsx-a11y',
|
||||
- ],
|
||||
- parserOptions: {
|
||||
- ecmaFeatures: {
|
||||
- jsx: true,
|
||||
- },
|
||||
- },
|
||||
- rules: {
|
||||
- 'jsx-a11y/alt-text': 'error',
|
||||
- 'jsx-a11y/anchor-has-content': 'error',
|
||||
- 'jsx-a11y/anchor-is-valid': 'error',
|
||||
- 'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
|
||||
- 'jsx-a11y/aria-props': 'error',
|
||||
- 'jsx-a11y/aria-proptypes': 'error',
|
||||
- 'jsx-a11y/aria-role': 'error',
|
||||
- 'jsx-a11y/aria-unsupported-elements': 'error',
|
||||
- 'jsx-a11y/autocomplete-valid': 'error',
|
||||
- 'jsx-a11y/click-events-have-key-events': 'error',
|
||||
- 'jsx-a11y/control-has-associated-label': ['off', {
|
||||
- ignoreElements: [
|
||||
- 'audio',
|
||||
- 'canvas',
|
||||
- 'embed',
|
||||
- 'input',
|
||||
- 'textarea',
|
||||
- 'tr',
|
||||
- 'video',
|
||||
- ],
|
||||
- ignoreRoles: [
|
||||
- 'grid',
|
||||
+ ol: [
|
||||
'listbox',
|
||||
'menu',
|
||||
'menubar',
|
||||
'radiogroup',
|
||||
- 'row',
|
||||
'tablist',
|
||||
- 'toolbar',
|
||||
'tree',
|
||||
'treegrid',
|
||||
],
|
||||
- includeRoles: [
|
||||
- 'alert',
|
||||
- 'dialog',
|
||||
+ li: ['menuitem', 'option', 'row', 'tab', 'treeitem'],
|
||||
+ table: ['grid'],
|
||||
+ td: ['gridcell'],
|
||||
+ fieldset: ['radiogroup', 'presentation'],
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/no-noninteractive-tabindex': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ tags: [],
|
||||
+ roles: ['tabpanel'],
|
||||
+ allowExpressionValues: true,
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/no-redundant-roles': 'error',
|
||||
+ 'jsx-a11y/no-static-element-interactions': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ allowExpressionValues: true,
|
||||
+ handlers: [
|
||||
+ 'onClick',
|
||||
+ 'onMouseDown',
|
||||
+ 'onMouseUp',
|
||||
+ 'onKeyPress',
|
||||
+ 'onKeyDown',
|
||||
+ 'onKeyUp',
|
||||
],
|
||||
- }],
|
||||
- 'jsx-a11y/heading-has-content': 'error',
|
||||
- 'jsx-a11y/html-has-lang': 'error',
|
||||
- 'jsx-a11y/iframe-has-title': 'error',
|
||||
- 'jsx-a11y/img-redundant-alt': 'error',
|
||||
- 'jsx-a11y/interactive-supports-focus': [
|
||||
- 'error',
|
||||
- {
|
||||
- tabbable: [
|
||||
- 'button',
|
||||
- 'checkbox',
|
||||
- 'link',
|
||||
- 'progressbar',
|
||||
- 'searchbox',
|
||||
- 'slider',
|
||||
- 'spinbutton',
|
||||
- 'switch',
|
||||
- 'textbox',
|
||||
- ],
|
||||
- },
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/role-has-required-aria-props': 'error',
|
||||
+ 'jsx-a11y/role-supports-aria-props': 'error',
|
||||
+ 'jsx-a11y/scope': 'error',
|
||||
+ 'jsx-a11y/tabindex-no-positive': 'error',
|
||||
+ },
|
||||
+ },
|
||||
+ strict: {
|
||||
+ plugins: [
|
||||
+ 'jsx-a11y',
|
||||
+ ],
|
||||
+ parserOptions: {
|
||||
+ ecmaFeatures: {
|
||||
+ jsx: true,
|
||||
+ },
|
||||
+ },
|
||||
+ rules: {
|
||||
+ 'jsx-a11y/alt-text': 'error',
|
||||
+ 'jsx-a11y/anchor-has-content': 'error',
|
||||
+ 'jsx-a11y/anchor-is-valid': 'error',
|
||||
+ 'jsx-a11y/aria-activedescendant-has-tabindex': 'error',
|
||||
+ 'jsx-a11y/aria-props': 'error',
|
||||
+ 'jsx-a11y/aria-proptypes': 'error',
|
||||
+ 'jsx-a11y/aria-role': 'error',
|
||||
+ 'jsx-a11y/aria-unsupported-elements': 'error',
|
||||
+ 'jsx-a11y/autocomplete-valid': 'error',
|
||||
+ 'jsx-a11y/click-events-have-key-events': 'error',
|
||||
+ 'jsx-a11y/control-has-associated-label': ['off', {
|
||||
+ ignoreElements: [
|
||||
+ 'audio',
|
||||
+ 'canvas',
|
||||
+ 'embed',
|
||||
+ 'input',
|
||||
+ 'textarea',
|
||||
+ 'tr',
|
||||
+ 'video',
|
||||
],
|
||||
- 'jsx-a11y/label-has-for': 'off',
|
||||
- 'jsx-a11y/label-has-associated-control': 'error',
|
||||
- 'jsx-a11y/media-has-caption': 'error',
|
||||
- 'jsx-a11y/mouse-events-have-key-events': 'error',
|
||||
- 'jsx-a11y/no-access-key': 'error',
|
||||
- 'jsx-a11y/no-autofocus': 'error',
|
||||
- 'jsx-a11y/no-distracting-elements': 'error',
|
||||
- 'jsx-a11y/no-interactive-element-to-noninteractive-role': 'error',
|
||||
- 'jsx-a11y/no-noninteractive-element-interactions': [
|
||||
- 'error',
|
||||
- {
|
||||
- body: ['onError', 'onLoad'],
|
||||
- iframe: ['onError', 'onLoad'],
|
||||
- img: ['onError', 'onLoad'],
|
||||
- },
|
||||
+ ignoreRoles: [
|
||||
+ 'grid',
|
||||
+ 'listbox',
|
||||
+ 'menu',
|
||||
+ 'menubar',
|
||||
+ 'radiogroup',
|
||||
+ 'row',
|
||||
+ 'tablist',
|
||||
+ 'toolbar',
|
||||
+ 'tree',
|
||||
+ 'treegrid',
|
||||
],
|
||||
- 'jsx-a11y/no-noninteractive-element-to-interactive-role': 'error',
|
||||
- 'jsx-a11y/no-noninteractive-tabindex': 'error',
|
||||
- 'jsx-a11y/no-redundant-roles': 'error',
|
||||
- 'jsx-a11y/no-static-element-interactions': 'error',
|
||||
- 'jsx-a11y/role-has-required-aria-props': 'error',
|
||||
- 'jsx-a11y/role-supports-aria-props': 'error',
|
||||
- 'jsx-a11y/scope': 'error',
|
||||
- 'jsx-a11y/tabindex-no-positive': 'error',
|
||||
- },
|
||||
+ includeRoles: [
|
||||
+ 'alert',
|
||||
+ 'dialog',
|
||||
+ ],
|
||||
+ }],
|
||||
+ 'jsx-a11y/heading-has-content': 'error',
|
||||
+ 'jsx-a11y/html-has-lang': 'error',
|
||||
+ 'jsx-a11y/iframe-has-title': 'error',
|
||||
+ 'jsx-a11y/img-redundant-alt': 'error',
|
||||
+ 'jsx-a11y/interactive-supports-focus': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ tabbable: [
|
||||
+ 'button',
|
||||
+ 'checkbox',
|
||||
+ 'link',
|
||||
+ 'progressbar',
|
||||
+ 'searchbox',
|
||||
+ 'slider',
|
||||
+ 'spinbutton',
|
||||
+ 'switch',
|
||||
+ 'textbox',
|
||||
+ ],
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/label-has-for': 'off',
|
||||
+ 'jsx-a11y/label-has-associated-control': 'error',
|
||||
+ 'jsx-a11y/media-has-caption': 'error',
|
||||
+ 'jsx-a11y/mouse-events-have-key-events': 'error',
|
||||
+ 'jsx-a11y/no-access-key': 'error',
|
||||
+ 'jsx-a11y/no-autofocus': 'error',
|
||||
+ 'jsx-a11y/no-distracting-elements': 'error',
|
||||
+ 'jsx-a11y/no-interactive-element-to-noninteractive-role': 'error',
|
||||
+ 'jsx-a11y/no-noninteractive-element-interactions': [
|
||||
+ 'error',
|
||||
+ {
|
||||
+ body: ['onError', 'onLoad'],
|
||||
+ iframe: ['onError', 'onLoad'],
|
||||
+ img: ['onError', 'onLoad'],
|
||||
+ },
|
||||
+ ],
|
||||
+ 'jsx-a11y/no-noninteractive-element-to-interactive-role': 'error',
|
||||
+ 'jsx-a11y/no-noninteractive-tabindex': 'error',
|
||||
+ 'jsx-a11y/no-redundant-roles': 'error',
|
||||
+ 'jsx-a11y/no-static-element-interactions': 'error',
|
||||
+ 'jsx-a11y/role-has-required-aria-props': 'error',
|
||||
+ 'jsx-a11y/role-supports-aria-props': 'error',
|
||||
+ 'jsx-a11y/scope': 'error',
|
||||
+ 'jsx-a11y/tabindex-no-positive': 'error',
|
||||
},
|
||||
},
|
||||
+ 'tabindex-no-positive': tabindexNoPositive,
|
||||
};
|
||||
+
|
||||
+/** @param {object} obj */
|
||||
+function kebabCase(obj) {
|
||||
+ return Object.fromEntries(
|
||||
+ Object.entries(obj).map(([key, value]) => [
|
||||
+ key.replace(/([A-Z])/g, '-$1').toLowerCase(),
|
||||
+ value,
|
||||
+ ]),
|
||||
+ );
|
||||
|
||||
const recommendedRules = {
|
||||
@@ -299,10 +341,10 @@ const jsxA11y = {
|
||||
const createConfig = (rules, flatConfigName) => ({
|
||||
...(flatConfigName
|
||||
? {
|
||||
- ...flatConfigBase,
|
||||
- name: `jsx-a11y/${flatConfigName}`,
|
||||
- plugins: { 'jsx-a11y': jsxA11y },
|
||||
- }
|
||||
+ ...flatConfigBase,
|
||||
+ name: `jsx-a11y/${flatConfigName}`,
|
||||
+ plugins: { 'jsx-a11y': jsxA11y },
|
||||
+ }
|
||||
: { ...legacyConfigBase, plugins: ['jsx-a11y'] }),
|
||||
rules: { ...rules },
|
||||
});
|
||||
diff --git a/src/util/mayContainChildComponent.js b/src/util/mayContainChildComponent.js
|
||||
index 43a03ef..5e1035e 100644
|
||||
--- a/src/util/mayContainChildComponent.js
|
||||
|
||||
@ -27,3 +27,98 @@ index 49fd4c7..a0fdd81 100644
|
||||
},
|
||||
rules: /** @type {Record<string, import('eslint').Rule.RuleModule>} */ ({
|
||||
"callback-return": require("./rules/callback-return"),
|
||||
diff --git a/tests/fixtures/no-extraneous/dependencies/node_modules/@bbb/aaa.js b/tests/fixtures/no-extraneous/dependencies/node_modules/@bbb/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/dependencies/node_modules/aaa.js b/tests/fixtures/no-extraneous/dependencies/node_modules/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/dependencies/node_modules/bbb/index.js b/tests/fixtures/no-extraneous/dependencies/node_modules/bbb/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/dependencies/node_modules/bbb/package.json b/tests/fixtures/no-extraneous/dependencies/node_modules/bbb/package.json
|
||||
deleted file mode 100644
|
||||
index b7d25e2..0000000
|
||||
--- a/tests/fixtures/no-extraneous/dependencies/node_modules/bbb/package.json
|
||||
+++ /dev/null
|
||||
@@ -1,4 +0,0 @@
|
||||
-{
|
||||
- "name": "bbb",
|
||||
- "main": "index.js"
|
||||
-}
|
||||
\ No newline at end of file
|
||||
diff --git a/tests/fixtures/no-extraneous/devDependencies/node_modules/@bbb/aaa.js b/tests/fixtures/no-extraneous/devDependencies/node_modules/@bbb/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/devDependencies/node_modules/aaa.js b/tests/fixtures/no-extraneous/devDependencies/node_modules/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/devDependencies/node_modules/bbb/index.js b/tests/fixtures/no-extraneous/devDependencies/node_modules/bbb/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/devDependencies/node_modules/bbb/package.json b/tests/fixtures/no-extraneous/devDependencies/node_modules/bbb/package.json
|
||||
deleted file mode 100644
|
||||
index b7d25e2..0000000
|
||||
--- a/tests/fixtures/no-extraneous/devDependencies/node_modules/bbb/package.json
|
||||
+++ /dev/null
|
||||
@@ -1,4 +0,0 @@
|
||||
-{
|
||||
- "name": "bbb",
|
||||
- "main": "index.js"
|
||||
-}
|
||||
\ No newline at end of file
|
||||
diff --git a/tests/fixtures/no-extraneous/noDependencies/node_modules/@bbb/aaa.js b/tests/fixtures/no-extraneous/noDependencies/node_modules/@bbb/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/noDependencies/node_modules/aaa.js b/tests/fixtures/no-extraneous/noDependencies/node_modules/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/noDependencies/node_modules/bbb.js b/tests/fixtures/no-extraneous/noDependencies/node_modules/bbb.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/optionalDependencies/node_modules/@bbb/aaa.js b/tests/fixtures/no-extraneous/optionalDependencies/node_modules/@bbb/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/optionalDependencies/node_modules/aaa.js b/tests/fixtures/no-extraneous/optionalDependencies/node_modules/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/optionalDependencies/node_modules/bbb/index.js b/tests/fixtures/no-extraneous/optionalDependencies/node_modules/bbb/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/optionalDependencies/node_modules/bbb/package.json b/tests/fixtures/no-extraneous/optionalDependencies/node_modules/bbb/package.json
|
||||
deleted file mode 100644
|
||||
index b7d25e2..0000000
|
||||
--- a/tests/fixtures/no-extraneous/optionalDependencies/node_modules/bbb/package.json
|
||||
+++ /dev/null
|
||||
@@ -1,4 +0,0 @@
|
||||
-{
|
||||
- "name": "bbb",
|
||||
- "main": "index.js"
|
||||
-}
|
||||
\ No newline at end of file
|
||||
diff --git a/tests/fixtures/no-extraneous/peerDependencies/node_modules/@bbb/aaa.js b/tests/fixtures/no-extraneous/peerDependencies/node_modules/@bbb/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/peerDependencies/node_modules/aaa.js b/tests/fixtures/no-extraneous/peerDependencies/node_modules/aaa.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/peerDependencies/node_modules/bbb/index.js b/tests/fixtures/no-extraneous/peerDependencies/node_modules/bbb/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-extraneous/peerDependencies/node_modules/bbb/package.json b/tests/fixtures/no-extraneous/peerDependencies/node_modules/bbb/package.json
|
||||
deleted file mode 100644
|
||||
index b7d25e2..0000000
|
||||
--- a/tests/fixtures/no-extraneous/peerDependencies/node_modules/bbb/package.json
|
||||
+++ /dev/null
|
||||
@@ -1,4 +0,0 @@
|
||||
-{
|
||||
- "name": "bbb",
|
||||
- "main": "index.js"
|
||||
-}
|
||||
\ No newline at end of file
|
||||
diff --git a/tests/fixtures/no-hide-core-modules/indirect-thirdparty/node_modules/util/index.js b/tests/fixtures/no-hide-core-modules/indirect-thirdparty/node_modules/util/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
diff --git a/tests/fixtures/no-hide-core-modules/thirdparty/node_modules/util/index.js b/tests/fixtures/no-hide-core-modules/thirdparty/node_modules/util/index.js
|
||||
deleted file mode 100644
|
||||
index e69de29..0000000
|
||||
|
||||
@ -1,336 +0,0 @@
|
||||
diff --git a/.eslintrc b/.eslintrc
|
||||
deleted file mode 100644
|
||||
index 4991f200..00000000
|
||||
--- a/.eslintrc
|
||||
+++ /dev/null
|
||||
@@ -1,82 +0,0 @@
|
||||
-{
|
||||
- "root": true,
|
||||
- "extends": ["airbnb-base", "plugin:eslint-plugin/recommended"],
|
||||
- "plugins": ["eslint-plugin"],
|
||||
- "env": {
|
||||
- "es6": true,
|
||||
- "node": true
|
||||
- },
|
||||
- "parserOptions": {
|
||||
- "ecmaVersion": 6,
|
||||
- "ecmaFeatures": {
|
||||
- "jsx": true
|
||||
- },
|
||||
- "sourceType": "script",
|
||||
- },
|
||||
- "ignorePatterns": [
|
||||
- "coverage/",
|
||||
- ".nyc_output/",
|
||||
- ],
|
||||
- "rules": {
|
||||
- "comma-dangle": [2, "always-multiline"],
|
||||
- "object-shorthand": [2, "always", {
|
||||
- "ignoreConstructors": false,
|
||||
- "avoidQuotes": false, // this is the override vs airbnb
|
||||
- }],
|
||||
- "max-len": [2, 120, {
|
||||
- "ignoreStrings": true,
|
||||
- "ignoreTemplateLiterals": true,
|
||||
- "ignoreComments": true,
|
||||
- }],
|
||||
- "consistent-return": 0,
|
||||
-
|
||||
- "prefer-destructuring": [2, { "array": false, "object": false }, { "enforceForRenamedProperties": false }],
|
||||
- "prefer-object-spread": 0, // until node 8 is required
|
||||
- "prefer-rest-params": 0, // until node 6 is required
|
||||
- "prefer-spread": 0, // until node 6 is required
|
||||
- "function-call-argument-newline": 1, // TODO: enable
|
||||
- "function-paren-newline": 0,
|
||||
- "no-plusplus": [2, {"allowForLoopAfterthoughts": true}],
|
||||
- "no-param-reassign": 1,
|
||||
- "no-restricted-syntax": [2, {
|
||||
- "selector": "ObjectPattern",
|
||||
- "message": "Object destructuring is not compatible with Node v4"
|
||||
- }],
|
||||
- "strict": [2, "safe"],
|
||||
- "valid-jsdoc": [2, {
|
||||
- "requireReturn": false,
|
||||
- "requireParamDescription": false,
|
||||
- "requireReturnDescription": false,
|
||||
- }],
|
||||
-
|
||||
- "eslint-plugin/consistent-output": 0,
|
||||
- "eslint-plugin/require-meta-docs-description": [2, { "pattern": "^(Enforce|Require|Disallow)" }],
|
||||
- "eslint-plugin/require-meta-schema": 0,
|
||||
- "eslint-plugin/require-meta-type": 0
|
||||
- },
|
||||
- "overrides": [
|
||||
- {
|
||||
- "files": "tests/**",
|
||||
- "rules": {
|
||||
- "no-template-curly-in-string": 1,
|
||||
- },
|
||||
- },
|
||||
- {
|
||||
- "files": "markdown.config.js",
|
||||
- "rules": {
|
||||
- "no-console": 0,
|
||||
- },
|
||||
- },
|
||||
- {
|
||||
- "files": ".github/workflows/*.js",
|
||||
- "parserOptions": {
|
||||
- "ecmaVersion": 2019,
|
||||
- },
|
||||
- "rules": {
|
||||
- "camelcase": 0,
|
||||
- "no-console": 0,
|
||||
- "no-restricted-syntax": 0,
|
||||
- },
|
||||
- },
|
||||
- ],
|
||||
-}
|
||||
diff --git a/index.js b/index.js
|
||||
index 4140c6c8..03e623af 100644
|
||||
--- a/index.js
|
||||
+++ b/index.js
|
||||
@@ -1,31 +1,25 @@
|
||||
-'use strict';
|
||||
-
|
||||
-const configAll = require('./configs/all');
|
||||
-const configRecommended = require('./configs/recommended');
|
||||
-const configRuntime = require('./configs/jsx-runtime');
|
||||
-
|
||||
-const allRules = require('./lib/rules');
|
||||
+import configAll from './configs/all';
|
||||
+import configRecommended from './configs/recommended';
|
||||
+import configRuntime from './configs/jsx-runtime';
|
||||
+import { name } from './package.json';
|
||||
+export { default as rules } from './lib/rules';
|
||||
|
||||
// for legacy config system
|
||||
-const plugins = [
|
||||
- 'react',
|
||||
-];
|
||||
+const plugins = [name];
|
||||
+
|
||||
+export const deprecatedRules = configAll.plugins.react.deprecatedRules;
|
||||
|
||||
-module.exports = {
|
||||
- deprecatedRules: configAll.plugins.react.deprecatedRules,
|
||||
- rules: allRules,
|
||||
- configs: {
|
||||
- recommended: Object.assign({}, configRecommended, {
|
||||
- parserOptions: configRecommended.languageOptions.parserOptions,
|
||||
- plugins,
|
||||
- }),
|
||||
- all: Object.assign({}, configAll, {
|
||||
- parserOptions: configAll.languageOptions.parserOptions,
|
||||
- plugins,
|
||||
- }),
|
||||
- 'jsx-runtime': Object.assign({}, configRuntime, {
|
||||
- parserOptions: configRuntime.languageOptions.parserOptions,
|
||||
- plugins,
|
||||
- }),
|
||||
- },
|
||||
+export const configs = {
|
||||
+ recommended: Object.assign({}, configRecommended, {
|
||||
+ parserOptions: configRecommended.languageOptions.parserOptions,
|
||||
+ plugins,
|
||||
+ }),
|
||||
+ all: Object.assign({}, configAll, {
|
||||
+ parserOptions: configAll.languageOptions.parserOptions,
|
||||
+ plugins,
|
||||
+ }),
|
||||
+ 'jsx-runtime': Object.assign({}, configRuntime, {
|
||||
+ parserOptions: configRuntime.languageOptions.parserOptions,
|
||||
+ plugins,
|
||||
+ }),
|
||||
};
|
||||
diff --git a/lib/rules/button-has-type.js b/lib/rules/button-has-type.js
|
||||
index 204a33c4..01d992c2 100644
|
||||
--- a/lib/rules/button-has-type.js
|
||||
+++ b/lib/rules/button-has-type.js
|
||||
@@ -5,8 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const getProp = require('jsx-ast-utils/getProp');
|
||||
-const getLiteralPropValue = require('jsx-ast-utils/getLiteralPropValue');
|
||||
+const { getProp, getLiteralPropValue } = require('jsx-ast-utils');
|
||||
const docsUrl = require('../util/docsUrl');
|
||||
const isCreateElement = require('../util/isCreateElement');
|
||||
const report = require('../util/report');
|
||||
diff --git a/lib/rules/jsx-fragments.js b/lib/rules/jsx-fragments.js
|
||||
index 38b4dd8b..d0575572 100644
|
||||
--- a/lib/rules/jsx-fragments.js
|
||||
+++ b/lib/rules/jsx-fragments.js
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const elementType = require('jsx-ast-utils/elementType');
|
||||
+import { elementType } from 'jsx-ast-utils';
|
||||
const pragmaUtil = require('../util/pragma');
|
||||
const variableUtil = require('../util/variable');
|
||||
const testReactVersion = require('../util/version').testReactVersion;
|
||||
diff --git a/lib/rules/jsx-key.js b/lib/rules/jsx-key.js
|
||||
index 7ea874d0..48df0dba 100644
|
||||
--- a/lib/rules/jsx-key.js
|
||||
+++ b/lib/rules/jsx-key.js
|
||||
@@ -5,8 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const hasProp = require('jsx-ast-utils/hasProp');
|
||||
-const propName = require('jsx-ast-utils/propName');
|
||||
+import { hasProp, propName } from 'jsx-ast-utils';
|
||||
const values = require('object.values');
|
||||
const docsUrl = require('../util/docsUrl');
|
||||
const pragmaUtil = require('../util/pragma');
|
||||
diff --git a/lib/rules/jsx-no-bind.js b/lib/rules/jsx-no-bind.js
|
||||
index 17e56e2e..cb6dec1a 100644
|
||||
--- a/lib/rules/jsx-no-bind.js
|
||||
+++ b/lib/rules/jsx-no-bind.js
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const propName = require('jsx-ast-utils/propName');
|
||||
+import { propName } from 'jsx-ast-utils';
|
||||
const docsUrl = require('../util/docsUrl');
|
||||
const jsxUtil = require('../util/jsx');
|
||||
const report = require('../util/report');
|
||||
diff --git a/lib/rules/jsx-pascal-case.js b/lib/rules/jsx-pascal-case.js
|
||||
index efeef403..33df4653 100644
|
||||
--- a/lib/rules/jsx-pascal-case.js
|
||||
+++ b/lib/rules/jsx-pascal-case.js
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const elementType = require('jsx-ast-utils/elementType');
|
||||
+import { elementType } from 'jsx-ast-utils';
|
||||
const minimatch = require('minimatch');
|
||||
const docsUrl = require('../util/docsUrl');
|
||||
const jsxUtil = require('../util/jsx');
|
||||
diff --git a/lib/rules/jsx-sort-props.js b/lib/rules/jsx-sort-props.js
|
||||
index 3ca1724e..faf58f91 100644
|
||||
--- a/lib/rules/jsx-sort-props.js
|
||||
+++ b/lib/rules/jsx-sort-props.js
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const propName = require('jsx-ast-utils/propName');
|
||||
+import { propName } from 'jsx-ast-utils';
|
||||
const includes = require('array-includes');
|
||||
const toSorted = require('array.prototype.tosorted');
|
||||
|
||||
diff --git a/lib/rules/no-namespace.js b/lib/rules/no-namespace.js
|
||||
index d7559f5e..fbfad23a 100644
|
||||
--- a/lib/rules/no-namespace.js
|
||||
+++ b/lib/rules/no-namespace.js
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const elementType = require('jsx-ast-utils/elementType');
|
||||
+import { elementType } from 'jsx-ast-utils';
|
||||
const docsUrl = require('../util/docsUrl');
|
||||
const isCreateElement = require('../util/isCreateElement');
|
||||
const report = require('../util/report');
|
||||
diff --git a/lib/rules/no-unknown-property.js b/lib/rules/no-unknown-property.js
|
||||
index 9491f9c6..44396948 100644
|
||||
--- a/lib/rules/no-unknown-property.js
|
||||
+++ b/lib/rules/no-unknown-property.js
|
||||
@@ -543,7 +543,7 @@ module.exports = {
|
||||
|
||||
create(context) {
|
||||
function getIgnoreConfig() {
|
||||
- return (context.options[0] && context.options[0].ignore) || DEFAULTS.ignore;
|
||||
+ return context.options[0]?.ignore || DEFAULTS.ignore;
|
||||
}
|
||||
|
||||
function getRequireDataLowercase() {
|
||||
@@ -556,7 +556,7 @@ module.exports = {
|
||||
JSXAttribute(node) {
|
||||
const ignoreNames = getIgnoreConfig();
|
||||
const actualName = context.getSourceCode().getText(node.name);
|
||||
- if (ignoreNames.indexOf(actualName) >= 0) {
|
||||
+ if (ignoreNames.includes(actualName)) {
|
||||
return;
|
||||
}
|
||||
const name = normalizeAttributeCase(actualName);
|
||||
diff --git a/lib/util/annotations.js b/lib/util/annotations.js
|
||||
index 60aaef8c..ad8dc0bf 100644
|
||||
--- a/lib/util/annotations.js
|
||||
+++ b/lib/util/annotations.js
|
||||
@@ -27,6 +27,6 @@ function isAnnotatedFunctionPropsDeclaration(node, context) {
|
||||
return (isAnnotated && (isDestructuredProps || isProps));
|
||||
}
|
||||
|
||||
-module.exports = {
|
||||
+export {
|
||||
isAnnotatedFunctionPropsDeclaration,
|
||||
};
|
||||
diff --git a/lib/util/ast.js b/lib/util/ast.js
|
||||
index fd6019a3..3cbc293e 100644
|
||||
--- a/lib/util/ast.js
|
||||
+++ b/lib/util/ast.js
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const estraverse = require('estraverse');
|
||||
+import estraverse from 'estraverse';
|
||||
// const pragmaUtil = require('./pragma');
|
||||
|
||||
/**
|
||||
@@ -428,7 +428,7 @@ function isTSTypeParameterInstantiation(node) {
|
||||
return nodeType === 'TSTypeParameterInstantiation';
|
||||
}
|
||||
|
||||
-module.exports = {
|
||||
+export {
|
||||
traverse,
|
||||
findReturnStatement,
|
||||
getFirstNodeInLine,
|
||||
diff --git a/lib/util/jsx.js b/lib/util/jsx.js
|
||||
index 55073bfe..efc07af1 100644
|
||||
--- a/lib/util/jsx.js
|
||||
+++ b/lib/util/jsx.js
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
'use strict';
|
||||
|
||||
-const elementType = require('jsx-ast-utils/elementType');
|
||||
+import { elementType } from 'jsx-ast-utils';
|
||||
|
||||
const astUtil = require('./ast');
|
||||
const isCreateElement = require('./isCreateElement');
|
||||
diff --git a/tsconfig.json b/tsconfig.json
|
||||
deleted file mode 100644
|
||||
index 39187b7f..00000000
|
||||
--- a/tsconfig.json
|
||||
+++ /dev/null
|
||||
@@ -1,23 +0,0 @@
|
||||
-{
|
||||
- "compilerOptions": {
|
||||
- "target": "ES2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
|
||||
- "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
|
||||
- // "lib": ["es2015"], /* Specify library files to be included in the compilation. */
|
||||
- "allowJs": true, /* Allow javascript files to be compiled. */
|
||||
- "checkJs": true, /* Report errors in .js files. */
|
||||
- "noEmit": true, /* Do not emit outputs. */
|
||||
- "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
||||
-
|
||||
- /* Strict Type-Checking Options */
|
||||
- // "strict": true, /* Enable all strict type-checking options. */
|
||||
- "noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */
|
||||
- // "strictNullChecks": true, /* Enable strict null checks. */
|
||||
- // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
||||
- "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
||||
- "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
||||
- "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
||||
- "alwaysStrict": false, /* Parse in strict mode and emit "use strict" for each source file. */
|
||||
- "resolveJsonModule": true
|
||||
- },
|
||||
- "include": ["lib"],
|
||||
-}
|
||||
5260
pnpm-lock.yaml
generated
5260
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,8 @@
|
||||
#!/usr/bin/env tsx
|
||||
import { promises as fs } from 'node:fs';
|
||||
import { camelCase } from 'lodash';
|
||||
|
||||
export async function buildLocalRules() {
|
||||
const files = (await fs.readdir('./src/rules'))
|
||||
.filter(file => file.endsWith('.ts'))
|
||||
.filter(file => file !== 'index.ts')
|
||||
@ -20,5 +22,9 @@ export const rules: Record<
|
||||
};
|
||||
`.trim();
|
||||
|
||||
console.log('Building local rules...');
|
||||
await fs.writeFile('./src/rules/index.ts', entryFile + '\n');
|
||||
}
|
||||
|
||||
if (require.main === module) {
|
||||
buildLocalRules();
|
||||
}
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
#!/usr/bin/env bun
|
||||
import './build-local-rules';
|
||||
#!/usr/bin/env tsx
|
||||
import { promises as fs } from 'node:fs';
|
||||
import { resolve, relative } from 'node:path';
|
||||
import { isBuiltin } from 'node:module';
|
||||
@ -8,6 +7,7 @@ import type { Plugin } from 'esbuild';
|
||||
import { memoize } from 'lodash';
|
||||
import { gray, green } from 'picocolors';
|
||||
import { dependencies } from '../dist/package.json';
|
||||
import { buildLocalRules } from './build-local-rules';
|
||||
import { dts } from './dts';
|
||||
import { babelPlugin } from './modifier';
|
||||
|
||||
@ -124,6 +124,9 @@ function bundleType(source: string, output: string) {
|
||||
}
|
||||
|
||||
async function main() {
|
||||
console.log('Building local rules...');
|
||||
await buildLocalRules();
|
||||
|
||||
console.log('Building type definitions...');
|
||||
bundleType('./src/index.ts', './dist/index.d.ts');
|
||||
bundleType('./src/prettier.ts', './dist/prettier.d.ts');
|
||||
@ -131,8 +134,6 @@ async function main() {
|
||||
|
||||
console.log('Building packages...');
|
||||
await Promise.all([
|
||||
bundle('./packages/eslint-plugin-react/index.js'),
|
||||
bundle('./packages/eslint-plugin-import/src/index.js'),
|
||||
bundle('./packages/eslint-plugin-jsx-a11y/src/index.js'),
|
||||
bundle('./packages/eslint-plugin-react-hooks/index.ts'),
|
||||
bundle('./packages/eslint-plugin-n/lib/index.js', './dist/eslint-plugin-n/index.js'),
|
||||
@ -17,22 +17,14 @@ export function dts({
|
||||
const entry: EntryPointConfig = {
|
||||
filePath: source,
|
||||
failOnClass: false,
|
||||
libraries: {
|
||||
importedLibraries: ['eslint-define-config'],
|
||||
},
|
||||
output: {
|
||||
inlineDeclareExternals: false,
|
||||
inlineDeclareGlobals: false,
|
||||
sortNodes: false,
|
||||
noBanner: false,
|
||||
respectPreserveConstEnum: false,
|
||||
exportReferencedTypes: true,
|
||||
},
|
||||
};
|
||||
|
||||
const generatedDts = generateDtsBundle([entry], {
|
||||
preferredConfigPath: project,
|
||||
followSymlinks: false,
|
||||
followSymlinks: true,
|
||||
});
|
||||
|
||||
ts.sys.writeFile(dist, generatedDts[0]);
|
||||
|
||||
@ -10,8 +10,6 @@ import * as polyfill from '../src/polyfill';
|
||||
|
||||
const polyfills = Object.keys(polyfill);
|
||||
|
||||
const ENV = (process.env.NODE_ENV ??= 'production');
|
||||
|
||||
class HandlerMap {
|
||||
map = new Map<string, MacroHandler>();
|
||||
|
||||
|
||||
@ -21,8 +21,6 @@ pull() {
|
||||
}
|
||||
|
||||
pull import-js eslint-import-resolver-typescript
|
||||
pull import-js eslint-plugin-import
|
||||
pull jsx-eslint eslint-plugin-jsx-a11y
|
||||
pull eslint-community eslint-plugin-n
|
||||
pull jsx-eslint eslint-plugin-react
|
||||
pull jsx-eslint jsx-ast-utils
|
||||
|
||||
@ -4,8 +4,6 @@ sync() (
|
||||
)
|
||||
|
||||
sync eslint-import-resolver-typescript
|
||||
sync eslint-plugin-import
|
||||
sync eslint-plugin-jsx-a11y
|
||||
sync eslint-plugin-n
|
||||
sync eslint-plugin-react
|
||||
sync jsx-ast-utils
|
||||
|
||||
@ -1,33 +1,33 @@
|
||||
{
|
||||
"eslint-plugin-import": {
|
||||
"hash": "f77ceb679d59ced5d9a633123385470a9eea10d9",
|
||||
"date": "2024-04-07T12:55:28+12:00",
|
||||
"hash": "6554bd5c30976290024cecc44ef1e96746cf3cf7",
|
||||
"date": "2024-05-23T12:47:41-07:00",
|
||||
"committer": "Jordan Harband",
|
||||
"subject": "[actions] cancel in-progress runs on PR updates"
|
||||
"subject": "[meta] add `repository.directory` field"
|
||||
},
|
||||
"eslint-import-resolver-typescript": {
|
||||
"hash": "7a02ac08b5aaac8c217f0e87142f97eafcc38fbc",
|
||||
"date": "2024-04-01T01:06:20+00:00",
|
||||
"hash": "c9b5626ee69bd529c7e391e40928a4fb28dce179",
|
||||
"date": "2024-07-23T20:40:14+08:00",
|
||||
"committer": "GitHub",
|
||||
"subject": "chore(deps): update dependency npm-run-all2 to ^5.0.2 (#277)"
|
||||
"subject": "chore: release eslint-import-resolver-typescript (#302)"
|
||||
},
|
||||
"eslint-plugin-jsx-a11y": {
|
||||
"hash": "0d5321a5457c5f0da0ca216053cc5b4f571b53ae",
|
||||
"date": "2024-01-27T22:18:19-08:00",
|
||||
"hash": "cca288b73a39fa0932a57c02a7a88de68fc971fc",
|
||||
"date": "2024-07-22T02:39:43+01:00",
|
||||
"committer": "Jordan Harband",
|
||||
"subject": "[Deps] update `@babel/runtime`, `safe-regex-test`"
|
||||
"subject": "[readme] fix typo in shareable config section in readme"
|
||||
},
|
||||
"eslint-plugin-n": {
|
||||
"hash": "eb11b5b35a6a797dc7fba6df53b1c4dada3a2a55",
|
||||
"date": "2024-04-17T17:40:32+08:00",
|
||||
"hash": "6744257b43560181412a76eadeb7de564b886ad4",
|
||||
"date": "2024-07-26T11:46:54+01:00",
|
||||
"committer": "GitHub",
|
||||
"subject": "chore: upgrade globals v15 (#241)"
|
||||
"subject": "chore(master): release 17.10.1 (#319)"
|
||||
},
|
||||
"eslint-plugin-react": {
|
||||
"hash": "4467db503e38b9356517cf6926d11be544ccf4b1",
|
||||
"date": "2024-03-16T12:54:58+09:00",
|
||||
"hash": "983b88dd3cb5e07919517d3fde4085f60883ded7",
|
||||
"date": "2024-07-24T15:26:33-07:00",
|
||||
"committer": "Jordan Harband",
|
||||
"subject": "[Fix] `boolean-prop-naming`: avoid a crash with a non-TSTypeReference type"
|
||||
"subject": "[Tests] `no-array-index-key`: actually run valid tests"
|
||||
},
|
||||
"jsx-ast-utils": {
|
||||
"hash": "5943318eaf23764eec3ff397ebb969613d728a95",
|
||||
|
||||
39
src/env.ts
Normal file
39
src/env.ts
Normal file
@ -0,0 +1,39 @@
|
||||
import * as fs from 'node:fs';
|
||||
import { resolve } from 'node:path';
|
||||
import { Middleware, storybook } from './index';
|
||||
import { react, reactRefresh } from './presets/react';
|
||||
import { tailwind } from './presets/tailwind';
|
||||
import { reactQuery } from './presets/misc';
|
||||
|
||||
export function* checkEnv(): Generator<Middleware> {
|
||||
const rootDir = process.cwd();
|
||||
|
||||
const pkgJsonPath = resolve(rootDir, 'package.json');
|
||||
const pkgJson = fs.existsSync(pkgJsonPath)
|
||||
? JSON.parse(fs.readFileSync(pkgJsonPath, 'utf-8'))
|
||||
: {};
|
||||
|
||||
const deps = new Set(
|
||||
Object.keys({
|
||||
...pkgJson.dependencies,
|
||||
...pkgJson.devDependencies,
|
||||
...pkgJson.peerDependencies,
|
||||
}),
|
||||
);
|
||||
|
||||
if (deps.has('react')) {
|
||||
yield react;
|
||||
}
|
||||
if (deps.has('@vitejs/plugin-react') && deps.has('eslint-plugin-react-refresh')) {
|
||||
yield reactRefresh;
|
||||
}
|
||||
if (deps.has('tailwindcss') && deps.has('eslint-plugin-tailwindcss')) {
|
||||
yield tailwind;
|
||||
}
|
||||
if (deps.has('storybook') && deps.has('eslint-plugin-storybook')) {
|
||||
yield storybook;
|
||||
}
|
||||
if (deps.has('@tanstack/react-query') && deps.has('@tanstack/eslint-plugin-query')) {
|
||||
yield reactQuery;
|
||||
}
|
||||
}
|
||||
209
src/index.ts
209
src/index.ts
@ -1,19 +1,30 @@
|
||||
/// <reference path="./modules.d.ts" />
|
||||
import './redirect';
|
||||
import fs from 'node:fs';
|
||||
import { uniq } from 'lodash';
|
||||
import type { Merge, SetRequired } from 'type-fest';
|
||||
import type { Rule } from 'eslint';
|
||||
import type { ESLintUtils } from '@typescript-eslint/utils';
|
||||
import type { ESLintConfig, Rules } from 'eslint-define-config';
|
||||
import { typescriptRules } from './presets/typescript';
|
||||
import { unicornRules } from './presets/unicorn';
|
||||
import type {
|
||||
ESLintConfig,
|
||||
Extends,
|
||||
KnownExtends,
|
||||
Plugin,
|
||||
Rules,
|
||||
Settings,
|
||||
} from '@aet/eslint-define-config';
|
||||
|
||||
import { importTypeScript } from './presets/typescript';
|
||||
import { unicorn } from './presets/unicorn';
|
||||
import { eslintRules } from './presets/eslint';
|
||||
import { reactRules } from './presets/react';
|
||||
import { importRules } from './presets/import';
|
||||
import { jsDocRules } from './presets/jsdoc';
|
||||
import { graphqlRules } from './presets/graphql';
|
||||
import { localRules } from './presets/local';
|
||||
import { local } from './presets/local';
|
||||
import { error, warn, off } from './constants';
|
||||
import { tailwindRules } from './presets/tailwind';
|
||||
import { checkEnv } from './env';
|
||||
|
||||
export { graphql } from './presets/graphql';
|
||||
export { jsdoc } from './presets/jsdoc';
|
||||
export { storybook } from './presets/misc';
|
||||
export { react, reactRefresh } from './presets/react';
|
||||
export { tailwind } from './presets/tailwind';
|
||||
|
||||
export { error, warn, off };
|
||||
|
||||
@ -35,12 +46,6 @@ const ensureArray = <T>(value?: T | T[]): T[] =>
|
||||
type RuleLevel = 'error' | 'warn' | 'off' | 0 | 1 | 2;
|
||||
type RuleEntry<Options> = RuleLevel | [RuleLevel, Partial<Options>];
|
||||
|
||||
declare module 'eslint-define-config' {
|
||||
interface NoUnknownPropertyOption {
|
||||
extends: ('next' | 'emotion')[];
|
||||
}
|
||||
}
|
||||
|
||||
export interface LocalRuleOptions {
|
||||
/** Bans import from the specifier '.' and '..' and replaces it with '.+/index' */
|
||||
'rules/no-import-dot': RuleEntry<unknown>;
|
||||
@ -62,6 +67,8 @@ export interface CustomRule {
|
||||
options?: RuleLevel;
|
||||
}
|
||||
|
||||
export type Middleware = (config: MiddlewareConfig, helpers: MiddlewareFunctions) => void;
|
||||
|
||||
/**
|
||||
* ESLint Configuration.
|
||||
* @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/)
|
||||
@ -71,7 +78,7 @@ export type InputConfig = Omit<ESLintConfig, 'rules'> & {
|
||||
* Rules.
|
||||
* @see [Rules](https://eslint.org/docs/latest/user-guide/configuring/rules)
|
||||
*/
|
||||
rules?: RuleOptions;
|
||||
rules?: Partial<RuleOptions>;
|
||||
|
||||
/**
|
||||
* Glob pattern to find paths to custom rule files in JavaScript or TypeScript.
|
||||
@ -79,12 +86,38 @@ export type InputConfig = Omit<ESLintConfig, 'rules'> & {
|
||||
* this is statically analyzed.
|
||||
*/
|
||||
customRuleFiles?: string | string[];
|
||||
|
||||
/**
|
||||
* Automatically detect project types, dependencies and deduct the plugins.
|
||||
*/
|
||||
auto?: boolean;
|
||||
};
|
||||
|
||||
type OptionalObjectKey<T> = Exclude<
|
||||
{
|
||||
[Key in keyof T]: undefined | any[] extends T[Key]
|
||||
? Key
|
||||
: undefined | Record<any, any> extends T[Key]
|
||||
? Key
|
||||
: never;
|
||||
}[keyof T],
|
||||
undefined
|
||||
>;
|
||||
|
||||
type MiddlewareConfig = Merge<
|
||||
SetRequired<ESLintConfig, OptionalObjectKey<ESLintConfig>>,
|
||||
{ extends: KnownExtends[] }
|
||||
>;
|
||||
|
||||
interface MiddlewareFunctions {
|
||||
addRules(rules: Partial<RuleOptions>): void;
|
||||
addSettings(settings: Partial<Settings>): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a ESLint config object.
|
||||
*
|
||||
* By default, it includes `["@typescript-eslint", "import", "prettier"]` configs.
|
||||
* By default, it includes `["@typescript-eslint", "import-x", "prettier", "unicorn"]` configs.
|
||||
* Additional bundled plugins include:
|
||||
*
|
||||
* 1. [`react`](https://github.com/jsx-eslint/eslint-plugin-react#list-of-supported-rules)
|
||||
@ -93,122 +126,82 @@ export type InputConfig = Omit<ESLintConfig, 'rules'> & {
|
||||
* 2. [`react-refresh`](https://github.com/ArnaudBarre/eslint-plugin-react-refresh)
|
||||
* 3. [`jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#supported-rules)
|
||||
* 4. [`unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn#rules)
|
||||
* 5. [`n`](https://github.com/eslint-community/eslint-plugin-n#-rules) (Node.js specific)
|
||||
* 5. [`n`](https://github.com/eslint-community/eslint-plugin-n#-rules) (Node.js specific,
|
||||
* requires `minimatch`)
|
||||
* 6. [`jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc#rules)
|
||||
*
|
||||
* Non bundled:
|
||||
* 1. [`graphql`](https://the-guild.dev/graphql/eslint/rules)
|
||||
*/
|
||||
export function extendConfig(of: InputConfig = {}): ESLintConfig {
|
||||
export function extendConfig(
|
||||
of: InputConfig & {
|
||||
middlewares: Middleware[];
|
||||
} = {
|
||||
middlewares: [],
|
||||
},
|
||||
): ESLintConfig {
|
||||
const {
|
||||
plugins = [],
|
||||
settings,
|
||||
auto = true,
|
||||
plugins: _plugins = [],
|
||||
settings = {},
|
||||
rules,
|
||||
extends: _extends,
|
||||
overrides,
|
||||
customRuleFiles,
|
||||
parserOptions,
|
||||
middlewares: _middlewares = [],
|
||||
// @ts-expect-error
|
||||
localRules: _,
|
||||
...rest
|
||||
} = of;
|
||||
|
||||
const hasReact = plugins.includes('react');
|
||||
const hasReactRefresh = plugins.includes('react-refresh');
|
||||
const hasUnicorn = plugins.includes('unicorn');
|
||||
const hasJsDoc = plugins.includes('jsdoc');
|
||||
const hasGraphQL = plugins.includes('@graphql-eslint');
|
||||
const hasNext = ensureArray(_extends).some(name => name.includes(':@next/next'));
|
||||
const hasTailwind = ensureArray(_extends).some(name =>
|
||||
name.includes('plugin:tailwindcss/'),
|
||||
);
|
||||
let plugins: Plugin[] = [..._plugins];
|
||||
let extend: Extends[] = ensureArray(_extends);
|
||||
|
||||
const ruleDir = false; // ?? findCacheDirectory({ name: '_eslint-rules' });
|
||||
if (ruleDir) {
|
||||
fs.rmSync(ruleDir, { recursive: true, force: true });
|
||||
fs.mkdirSync(ruleDir, { recursive: true });
|
||||
}
|
||||
const middlewares: Middleware[] = uniq([
|
||||
importTypeScript,
|
||||
unicorn,
|
||||
local,
|
||||
...(auto ? checkEnv() : []),
|
||||
..._middlewares,
|
||||
]);
|
||||
|
||||
const result: InputConfig = {
|
||||
const result: MiddlewareConfig = {
|
||||
root: true,
|
||||
parser: '@typescript-eslint/parser',
|
||||
plugins: unique('@typescript-eslint', 'import', 'rules', plugins),
|
||||
plugins: unique('rules', plugins),
|
||||
env: { node: true, browser: true, es2023: true },
|
||||
reportUnusedDisableDirectives: true,
|
||||
parserOptions: {
|
||||
project: true,
|
||||
...parserOptions,
|
||||
},
|
||||
extends: unique(
|
||||
'eslint:recommended',
|
||||
'prettier',
|
||||
'plugin:@typescript-eslint/recommended-type-checked',
|
||||
'plugin:import/errors',
|
||||
'plugin:import/typescript',
|
||||
hasReact && [
|
||||
'plugin:react/recommended',
|
||||
'plugin:react-hooks/recommended',
|
||||
'plugin:jsx-a11y/recommended',
|
||||
],
|
||||
hasJsDoc && 'plugin:jsdoc/recommended-typescript',
|
||||
hasGraphQL && 'plugin:@graphql-eslint/recommended',
|
||||
_extends,
|
||||
),
|
||||
settings: {
|
||||
'import/parsers': {
|
||||
'@typescript-eslint/parser': ['.ts', '.tsx', '.mts', '.cts'],
|
||||
},
|
||||
'import/resolver': {
|
||||
typescript: {
|
||||
alwaysTryTypes: true,
|
||||
},
|
||||
},
|
||||
react: {
|
||||
version: 'detect',
|
||||
},
|
||||
...settings,
|
||||
},
|
||||
ignorePatterns: [],
|
||||
globals: {},
|
||||
extends: ['eslint:recommended', 'prettier', ...(extend as string[])],
|
||||
settings,
|
||||
overrides: [
|
||||
{
|
||||
files: ['.eslintrc.js', '.eslintrc.cjs', '*.config.js', 'index.js'],
|
||||
extends: ['plugin:@typescript-eslint/disable-type-checked'],
|
||||
rules: {
|
||||
'rules/restrict-template-expressions': off,
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ['*.d.ts'],
|
||||
rules: {
|
||||
'@typescript-eslint/consistent-type-imports': off,
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ['repl.ts', 'scripts/**/*.ts'],
|
||||
rules: {
|
||||
'no-console': off,
|
||||
},
|
||||
},
|
||||
{ files: ['repl.ts', 'scripts/**/*.ts'], rules: { 'no-console': off } },
|
||||
...(overrides ?? []),
|
||||
],
|
||||
rules: {
|
||||
...eslintRules,
|
||||
...typescriptRules,
|
||||
...importRules,
|
||||
...localRules,
|
||||
...(hasReact && {
|
||||
...reactRules,
|
||||
'react/no-unknown-property': [
|
||||
error,
|
||||
{ ignore: hasNext ? ['css', 'next'] : ['css'] },
|
||||
],
|
||||
}),
|
||||
...(hasReactRefresh && {
|
||||
'react-refresh/only-export-components': [warn, { allowConstantExport: true }],
|
||||
}),
|
||||
...(hasUnicorn && unicornRules),
|
||||
...(hasJsDoc && jsDocRules),
|
||||
...(hasGraphQL && graphqlRules),
|
||||
...(hasTailwind && tailwindRules),
|
||||
...rules,
|
||||
},
|
||||
rules: { ...eslintRules, ...rules },
|
||||
...rest,
|
||||
};
|
||||
|
||||
const functions: MiddlewareFunctions = {
|
||||
addRules(newRules) {
|
||||
Object.assign(result.rules, newRules);
|
||||
},
|
||||
addSettings(newSettings) {
|
||||
Object.assign(result.settings, newSettings);
|
||||
},
|
||||
};
|
||||
|
||||
for (const fn of middlewares) {
|
||||
fn(result, functions);
|
||||
}
|
||||
|
||||
result.plugins = unique(result.plugins);
|
||||
result.extends = unique(result.extends);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
@ -8,7 +8,6 @@ import type { Node, Property } from 'estree';
|
||||
|
||||
// https://github.com/gulpjs/interpret
|
||||
const transpilers = [
|
||||
'esbin/register',
|
||||
'esbuild-register',
|
||||
'ts-node/register/transpile-only',
|
||||
'@swc/register',
|
||||
|
||||
164
src/presets/_restrictedGlobals.json
Normal file
164
src/presets/_restrictedGlobals.json
Normal file
@ -0,0 +1,164 @@
|
||||
[
|
||||
"addEventListener",
|
||||
"blur",
|
||||
"caches",
|
||||
"captureEvents",
|
||||
"clientInformation",
|
||||
"close",
|
||||
"closed",
|
||||
"crossOriginIsolated",
|
||||
"devicePixelRatio",
|
||||
"dispatchEvent",
|
||||
"event",
|
||||
"external",
|
||||
"focus",
|
||||
"innerHeight",
|
||||
"innerWidth",
|
||||
"length",
|
||||
"locationbar",
|
||||
"menubar",
|
||||
"name",
|
||||
"onabort",
|
||||
"onafterprint",
|
||||
"onanimationcancel",
|
||||
"onanimationend",
|
||||
"onanimationiteration",
|
||||
"onanimationstart",
|
||||
"onauxclick",
|
||||
"onbeforeinput",
|
||||
"onbeforeprint",
|
||||
"onbeforetoggle",
|
||||
"onbeforeunload",
|
||||
"onblur",
|
||||
"oncancel",
|
||||
"oncanplay",
|
||||
"oncanplaythrough",
|
||||
"onchange",
|
||||
"onclick",
|
||||
"onclose",
|
||||
"oncontextmenu",
|
||||
"oncopy",
|
||||
"oncuechange",
|
||||
"oncut",
|
||||
"ondblclick",
|
||||
"ondevicemotion",
|
||||
"ondeviceorientation",
|
||||
"ondeviceorientationabsolute",
|
||||
"ondrag",
|
||||
"ondragend",
|
||||
"ondragenter",
|
||||
"ondragleave",
|
||||
"ondragover",
|
||||
"ondragstart",
|
||||
"ondrop",
|
||||
"ondurationchange",
|
||||
"onemptied",
|
||||
"onended",
|
||||
"onerror",
|
||||
"onfocus",
|
||||
"onformdata",
|
||||
"ongamepadconnected",
|
||||
"ongamepaddisconnected",
|
||||
"ongotpointercapture",
|
||||
"onhashchange",
|
||||
"oninput",
|
||||
"oninvalid",
|
||||
"onkeydown",
|
||||
"onkeypress",
|
||||
"onkeyup",
|
||||
"onlanguagechange",
|
||||
"onload",
|
||||
"onloadeddata",
|
||||
"onloadedmetadata",
|
||||
"onloadstart",
|
||||
"onlostpointercapture",
|
||||
"onmessage",
|
||||
"onmessageerror",
|
||||
"onmousedown",
|
||||
"onmouseenter",
|
||||
"onmouseleave",
|
||||
"onmousemove",
|
||||
"onmouseout",
|
||||
"onmouseover",
|
||||
"onmouseup",
|
||||
"onoffline",
|
||||
"ononline",
|
||||
"onorientationchange",
|
||||
"onpagehide",
|
||||
"onpageshow",
|
||||
"onpaste",
|
||||
"onpause",
|
||||
"onplay",
|
||||
"onplaying",
|
||||
"onpointercancel",
|
||||
"onpointerdown",
|
||||
"onpointerenter",
|
||||
"onpointerleave",
|
||||
"onpointermove",
|
||||
"onpointerout",
|
||||
"onpointerover",
|
||||
"onpointerup",
|
||||
"onpopstate",
|
||||
"onprogress",
|
||||
"onratechange",
|
||||
"onrejectionhandled",
|
||||
"onreset",
|
||||
"onresize",
|
||||
"onscroll",
|
||||
"onscrollend",
|
||||
"onsecuritypolicyviolation",
|
||||
"onseeked",
|
||||
"onseeking",
|
||||
"onselect",
|
||||
"onselectionchange",
|
||||
"onselectstart",
|
||||
"onslotchange",
|
||||
"onstalled",
|
||||
"onstorage",
|
||||
"onsubmit",
|
||||
"onsuspend",
|
||||
"ontimeupdate",
|
||||
"ontoggle",
|
||||
"ontouchcancel",
|
||||
"ontouchend",
|
||||
"ontouchmove",
|
||||
"ontouchstart",
|
||||
"ontransitioncancel",
|
||||
"ontransitionend",
|
||||
"ontransitionrun",
|
||||
"ontransitionstart",
|
||||
"onunhandledrejection",
|
||||
"onunload",
|
||||
"onvolumechange",
|
||||
"onwaiting",
|
||||
"onwebkitanimationend",
|
||||
"onwebkitanimationiteration",
|
||||
"onwebkitanimationstart",
|
||||
"onwebkittransitionend",
|
||||
"onwheel",
|
||||
"orientation",
|
||||
"origin",
|
||||
"outerHeight",
|
||||
"outerWidth",
|
||||
"pageXOffset",
|
||||
"pageYOffset",
|
||||
"personalbar",
|
||||
"releaseEvents",
|
||||
"removeEventListener",
|
||||
"reportError",
|
||||
"screenLeft",
|
||||
"screenTop",
|
||||
"screenX",
|
||||
"screenY",
|
||||
"scroll",
|
||||
"scrollbars",
|
||||
"scrollBy",
|
||||
"scrollTo",
|
||||
"scrollX",
|
||||
"scrollY",
|
||||
"status",
|
||||
"statusbar",
|
||||
"stop",
|
||||
"toolbar",
|
||||
"top"
|
||||
]
|
||||
@ -1,9 +1,10 @@
|
||||
import { error, warn, off } from '../constants';
|
||||
import { ESLintRules } from 'eslint-define-config/rules/eslint';
|
||||
import { EslintRulesObject } from '@aet/eslint-define-config/src/rules/eslint';
|
||||
import restrictedGlobals from './_restrictedGlobals.json';
|
||||
|
||||
export const eslintRules: Partial<ESLintRules> = {
|
||||
export const eslintRules: Partial<EslintRulesObject> = {
|
||||
'arrow-body-style': [error, 'as-needed'],
|
||||
'class-methods-use-this': off,
|
||||
'class-methods-use-this': warn,
|
||||
'func-style': [error, 'declaration', { allowArrowFunctions: true }],
|
||||
'no-async-promise-executor': off,
|
||||
'no-case-declarations': off,
|
||||
@ -14,7 +15,7 @@ export const eslintRules: Partial<ESLintRules> = {
|
||||
'no-empty': [error, { allowEmptyCatch: true }],
|
||||
'no-inner-declarations': off,
|
||||
'no-lonely-if': error,
|
||||
'no-restricted-globals': [error, 'event', 'name', 'length'],
|
||||
'no-restricted-globals': [error, ...restrictedGlobals],
|
||||
'no-restricted-imports': [
|
||||
error,
|
||||
{
|
||||
@ -30,7 +31,7 @@ export const eslintRules: Partial<ESLintRules> = {
|
||||
'no-template-curly-in-string': error,
|
||||
'no-var': error,
|
||||
'object-shorthand': [error, 'always', { ignoreConstructors: true }],
|
||||
'one-var': [error, { var: 'never', let: 'never' }],
|
||||
'one-var': [error, { var: 'never', let: 'never', const: 'never' }],
|
||||
'prefer-arrow-callback': error,
|
||||
'prefer-const': [error, { destructuring: 'all' }],
|
||||
'prefer-destructuring': [
|
||||
@ -42,7 +43,15 @@ export const eslintRules: Partial<ESLintRules> = {
|
||||
'prefer-spread': warn,
|
||||
'quote-props': [error, 'as-needed'],
|
||||
'sort-imports': [warn, { ignoreDeclarationSort: true }],
|
||||
'spaced-comment': [error, 'always', { markers: ['/', '#', '@'] }],
|
||||
'spaced-comment': [
|
||||
error,
|
||||
'always',
|
||||
{
|
||||
markers: ['/', '#', '@'],
|
||||
// allow /*@__PURE__*/
|
||||
block: { exceptions: ['@'] },
|
||||
},
|
||||
],
|
||||
complexity: [warn, { max: 100 }],
|
||||
curly: [error, 'multi-line', 'consistent'],
|
||||
eqeqeq: [error, 'smart'],
|
||||
|
||||
@ -1,4 +1,11 @@
|
||||
import { GraphQLRules } from 'eslint-define-config/rules/graphql-eslint';
|
||||
import { GraphQLRulesObject } from '@aet/eslint-define-config/src/rules/graphql-eslint';
|
||||
import type { Middleware } from '../index';
|
||||
|
||||
// https://the-guild.dev/graphql/eslint/rules
|
||||
export const graphqlRules: Partial<GraphQLRules> = {};
|
||||
const graphqlRules: Partial<GraphQLRulesObject> = {};
|
||||
|
||||
export const graphql: Middleware = (config, { addRules }) => {
|
||||
config.plugins.push('@graphql-eslint');
|
||||
config.extends.push('plugin:@graphql-eslint/recommended');
|
||||
addRules(graphqlRules);
|
||||
};
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
import { error, off } from '../constants';
|
||||
import { ImportRules } from 'eslint-define-config/rules/import';
|
||||
|
||||
export const importRules: Partial<ImportRules> = {
|
||||
'import/export': off,
|
||||
'import/no-duplicates': error,
|
||||
'import/order': [error, { groups: ['builtin', 'external'] }],
|
||||
};
|
||||
@ -1,3 +1,10 @@
|
||||
import { JSDocRules } from 'eslint-define-config/rules/jsdoc';
|
||||
import { JSDocRulesObject } from '@aet/eslint-define-config/src/rules/jsdoc';
|
||||
import type { Middleware } from '../index';
|
||||
|
||||
export const jsDocRules: Partial<JSDocRules> = {};
|
||||
const jsdocRules: Partial<JSDocRulesObject> = {};
|
||||
|
||||
export const jsdoc: Middleware = (config, { addRules }) => {
|
||||
config.plugins.push('jsdoc');
|
||||
config.extends.push('plugin:jsdoc/recommended-typescript');
|
||||
addRules(jsdocRules);
|
||||
};
|
||||
|
||||
@ -1,7 +1,11 @@
|
||||
import type { LocalRuleOptions } from '../index';
|
||||
import type { LocalRuleOptions, Middleware } from '../index';
|
||||
import { error } from '../constants';
|
||||
|
||||
export const localRules: Partial<LocalRuleOptions> = {
|
||||
const localRules: Partial<LocalRuleOptions> = {
|
||||
'rules/no-import-dot': error,
|
||||
'rules/restrict-template-expressions': error,
|
||||
};
|
||||
|
||||
export const local: Middleware = (_, { addRules }) => {
|
||||
addRules(localRules);
|
||||
};
|
||||
|
||||
9
src/presets/misc.ts
Normal file
9
src/presets/misc.ts
Normal file
@ -0,0 +1,9 @@
|
||||
import type { Middleware } from '../index';
|
||||
|
||||
export const storybook: Middleware = config => {
|
||||
config.extends.push('plugin:storybook/recommended');
|
||||
};
|
||||
|
||||
export const reactQuery: Middleware = config => {
|
||||
config.extends.push('plugin:@tanstack/eslint-plugin-query/recommended');
|
||||
};
|
||||
@ -1,9 +1,35 @@
|
||||
import { error, off } from '../constants';
|
||||
import { ReactRules } from 'eslint-define-config/rules/react';
|
||||
import type { Middleware } from '../index';
|
||||
import { error, off, warn } from '../constants';
|
||||
import { ReactRulesObject } from '@aet/eslint-define-config/src/rules/react';
|
||||
import { ReactRefreshRulesObject } from '@aet/eslint-define-config/src/rules/react-refresh';
|
||||
|
||||
export const reactRules: Partial<ReactRules> = {
|
||||
'react/display-name': off,
|
||||
'react/no-children-prop': error,
|
||||
'react/prop-types': off,
|
||||
'react/react-in-jsx-scope': off,
|
||||
const reactRules: Partial<ReactRulesObject> = {
|
||||
'@eslint-react/no-missing-component-display-name': off,
|
||||
'@eslint-react/no-children-prop': error,
|
||||
};
|
||||
|
||||
export const react: Middleware = (config, { addRules }) => {
|
||||
config.plugins.push('@eslint-react/eslint-plugin', 'react-hooks');
|
||||
config.extends.push(
|
||||
'plugin:@eslint-react/recommended-legacy',
|
||||
'plugin:@eslint-react/dom-legacy',
|
||||
'plugin:react-hooks/recommended',
|
||||
'plugin:jsx-a11y/recommended',
|
||||
);
|
||||
config.overrides.push({
|
||||
files: ['*.tsx'],
|
||||
rules: {
|
||||
'@eslint-react/no-leaked-conditional-rendering': error,
|
||||
},
|
||||
});
|
||||
addRules(reactRules);
|
||||
};
|
||||
|
||||
const refreshRules: Partial<ReactRefreshRulesObject> = {
|
||||
'react-refresh/only-export-components': [warn, { allowConstantExport: true }],
|
||||
};
|
||||
|
||||
export const reactRefresh: Middleware = (config, { addRules }) => {
|
||||
config.plugins.push('react-refresh');
|
||||
addRules(refreshRules);
|
||||
};
|
||||
|
||||
@ -1,5 +1,12 @@
|
||||
import type { Middleware } from '../index';
|
||||
import { off } from '../constants';
|
||||
import type { TailwindRulesObject } from '@aet/eslint-define-config/src/rules/tailwind';
|
||||
|
||||
export const tailwindRules = {
|
||||
const tailwindRules: Partial<TailwindRulesObject> = {
|
||||
'tailwindcss/no-custom-classname': off,
|
||||
} as const;
|
||||
|
||||
export const tailwind: Middleware = (config, { addRules }) => {
|
||||
config.extends.push('plugin:tailwindcss/recommended');
|
||||
addRules(tailwindRules);
|
||||
};
|
||||
|
||||
@ -1,7 +1,15 @@
|
||||
import { error, off, warn } from '../constants';
|
||||
import type { TypeScriptRules } from 'eslint-define-config/rules/typescript-eslint';
|
||||
import type { TypeScriptRulesObject } from '@aet/eslint-define-config/src/rules/typescript-eslint';
|
||||
import type { ImportXRulesObject } from '@aet/eslint-define-config/src/rules/import-x';
|
||||
import type { Middleware } from '../index';
|
||||
|
||||
export const typescriptRules: Partial<TypeScriptRules> = {
|
||||
const importRules: Partial<ImportXRulesObject> = {
|
||||
'import-x/export': off,
|
||||
'import-x/no-duplicates': error,
|
||||
'import-x/order': [error, { groups: ['builtin', 'external'] }],
|
||||
};
|
||||
|
||||
const typescriptRules: Partial<TypeScriptRulesObject> = {
|
||||
'@typescript-eslint/ban-ts-comment': [
|
||||
error,
|
||||
{
|
||||
@ -37,3 +45,39 @@ export const typescriptRules: Partial<TypeScriptRules> = {
|
||||
'@typescript-eslint/triple-slash-reference': off,
|
||||
'@typescript-eslint/unbound-method': off,
|
||||
};
|
||||
|
||||
export const importTypeScript: Middleware = (config, { addRules, addSettings }) => {
|
||||
config.parser = '@typescript-eslint/parser';
|
||||
config.plugins.push('@typescript-eslint', 'import-x');
|
||||
config.extends.push(
|
||||
'plugin:@typescript-eslint/recommended-type-checked',
|
||||
'plugin:import-x/errors',
|
||||
'plugin:import-x/typescript',
|
||||
);
|
||||
addSettings({
|
||||
'import-x/parsers': {
|
||||
'@typescript-eslint/parser': ['.ts', '.tsx', '.mts', '.cts'],
|
||||
},
|
||||
'import-x/resolver': {
|
||||
typescript: true,
|
||||
},
|
||||
});
|
||||
config.overrides.push(
|
||||
{
|
||||
files: ['.eslintrc.js', '.eslintrc.cjs', '*.config.js', 'index.js'],
|
||||
extends: ['plugin:@typescript-eslint/disable-type-checked'],
|
||||
rules: {
|
||||
'rules/restrict-template-expressions': off,
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ['*.d.ts'],
|
||||
rules: {
|
||||
'@typescript-eslint/consistent-type-imports': off,
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
addRules(importRules);
|
||||
addRules(typescriptRules);
|
||||
};
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
import type { Middleware } from '../index';
|
||||
import { error, warn } from '../constants';
|
||||
import { UnicornRules } from 'eslint-define-config/rules/unicorn';
|
||||
import { UnicornRulesObject } from '@aet/eslint-define-config/src/rules/unicorn';
|
||||
|
||||
const suggest = (suggest: string) => ({ suggest, fix: false });
|
||||
|
||||
// https://github.com/sindresorhus/eslint-plugin-unicorn/tree/28e7498ad06679bb92343db53bb40a7b5ba2990a
|
||||
export const unicornRules: Partial<UnicornRules> = {
|
||||
const unicornRules: Partial<UnicornRulesObject> = {
|
||||
'unicorn/better-regex': error,
|
||||
'unicorn/consistent-function-scoping': warn,
|
||||
'unicorn/escape-case': error,
|
||||
@ -69,3 +70,8 @@ export const unicornRules: Partial<UnicornRules> = {
|
||||
],
|
||||
'unicorn/template-indent': warn,
|
||||
};
|
||||
|
||||
export const unicorn: Middleware = (config, { addRules }) => {
|
||||
config.plugins.push('unicorn');
|
||||
addRules(unicornRules);
|
||||
};
|
||||
|
||||
@ -4,12 +4,10 @@ const { name } = [require][0]('./package.json');
|
||||
const _resolveFilename = Module._resolveFilename;
|
||||
const alias = new Set([
|
||||
'eslint-import-resolver-typescript',
|
||||
'eslint-plugin-import',
|
||||
'eslint-plugin-jsx-a11y',
|
||||
'eslint-plugin-local',
|
||||
'eslint-plugin-n',
|
||||
'eslint-plugin-react-hooks',
|
||||
'eslint-plugin-react',
|
||||
'eslint-plugin-rules',
|
||||
]);
|
||||
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
import type { Rule } from 'eslint';
|
||||
import type { ESLintUtils } from '@typescript-eslint/utils';
|
||||
|
||||
import noImportDot from './no-import-dot';
|
||||
import noEmptyObjectLiteral from './no-empty-object-literal';
|
||||
import noImportDot from './no-import-dot';
|
||||
import restrictTemplateExpressions from './restrict-template-expressions';
|
||||
|
||||
export const rules: Record<
|
||||
string,
|
||||
Rule.RuleModule | ESLintUtils.RuleModule<string, unknown[]>
|
||||
> = {
|
||||
'no-import-dot': noImportDot,
|
||||
'no-empty-object-literal': noEmptyObjectLiteral,
|
||||
'no-import-dot': noImportDot,
|
||||
'restrict-template-expressions': restrictTemplateExpressions,
|
||||
};
|
||||
|
||||
171
src/types/config/env.d.ts
vendored
171
src/types/config/env.d.ts
vendored
@ -1,171 +0,0 @@
|
||||
/**
|
||||
* An environment provides predefined global variables.
|
||||
*
|
||||
* @see [Environments](https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments)
|
||||
*/
|
||||
export interface Environments extends Partial<Record<string, boolean>> {
|
||||
/**
|
||||
* Browser global variables.
|
||||
*/
|
||||
browser?: boolean;
|
||||
|
||||
/**
|
||||
* Node.js global variables and Node.js scoping.
|
||||
*/
|
||||
node?: boolean;
|
||||
|
||||
/**
|
||||
* CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack).
|
||||
*/
|
||||
commonjs?: boolean;
|
||||
|
||||
/**
|
||||
* Globals common to both Node.js and Browser.
|
||||
*/
|
||||
'shared-node-browser'?: boolean;
|
||||
|
||||
/**
|
||||
* Enable all ECMAScript 6 features except for modules (this automatically sets the `ecmaVersion` parser option to 6).
|
||||
*/
|
||||
es6?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2016 globals and automatically sets the `ecmaVersion` parser option to 7.
|
||||
*/
|
||||
es2016?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2017 globals and automatically sets the `ecmaVersion` parser option to 8.
|
||||
*/
|
||||
es2017?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2018 globals and automatically sets the `ecmaVersion` parser option to 9.
|
||||
*/
|
||||
es2018?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2019 globals and automatically sets the `ecmaVersion` parser option to 10.
|
||||
*/
|
||||
es2019?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2020 globals and automatically sets the `ecmaVersion` parser option to 11.
|
||||
*/
|
||||
es2020?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2021 globals and automatically sets the `ecmaVersion` parser option to 12.
|
||||
*/
|
||||
es2021?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2022 globals and automatically sets the `ecmaVersion` parser option to 13.
|
||||
*/
|
||||
es2022?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all ECMAScript 2023 globals and automatically sets the `ecmaVersion` parser option to 14.
|
||||
*/
|
||||
es2023?: boolean;
|
||||
|
||||
/**
|
||||
* Web workers global variables.
|
||||
*/
|
||||
worker?: boolean;
|
||||
|
||||
/**
|
||||
* Defines `require()` and `define()` as global variables as per the amd spec.
|
||||
*/
|
||||
amd?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all of the Mocha testing global variables.
|
||||
*/
|
||||
mocha?: boolean;
|
||||
|
||||
/**
|
||||
* Adds all of the Jasmine testing global variables for version 1.3 and 2.0.
|
||||
*/
|
||||
jasmine?: boolean;
|
||||
|
||||
/**
|
||||
* Jest global variables.
|
||||
*/
|
||||
jest?: boolean;
|
||||
|
||||
/**
|
||||
* PhantomJS global variables.
|
||||
*/
|
||||
phantomjs?: boolean;
|
||||
|
||||
/**
|
||||
* Protractor global variables.
|
||||
*/
|
||||
protractor?: boolean;
|
||||
|
||||
/**
|
||||
* QUnit global variables.
|
||||
*/
|
||||
qunit?: boolean;
|
||||
|
||||
/**
|
||||
* jQuery global variables.
|
||||
*/
|
||||
jquery?: boolean;
|
||||
|
||||
/**
|
||||
* Prototype.js global variables.
|
||||
*/
|
||||
prototypejs?: boolean;
|
||||
|
||||
/**
|
||||
* ShellJS global variables.
|
||||
*/
|
||||
shelljs?: boolean;
|
||||
|
||||
/**
|
||||
* Meteor global variables.
|
||||
*/
|
||||
meteor?: boolean;
|
||||
|
||||
/**
|
||||
* MongoDB global variables.
|
||||
*/
|
||||
mongo?: boolean;
|
||||
|
||||
/**
|
||||
* AppleScript global variables.
|
||||
*/
|
||||
applescript?: boolean;
|
||||
|
||||
/**
|
||||
* Java 8 Nashorn global variables.
|
||||
*/
|
||||
nashorn?: boolean;
|
||||
|
||||
/**
|
||||
* Service Worker global variables.
|
||||
*/
|
||||
serviceworker?: boolean;
|
||||
|
||||
/**
|
||||
* Atom test helper globals.
|
||||
*/
|
||||
atomtest?: boolean;
|
||||
|
||||
/**
|
||||
* Ember test helper globals.
|
||||
*/
|
||||
embertest?: boolean;
|
||||
|
||||
/**
|
||||
* WebExtensions globals.
|
||||
*/
|
||||
webextensions?: boolean;
|
||||
|
||||
/**
|
||||
* GreaseMonkey globals.
|
||||
*/
|
||||
greasemonkey?: boolean;
|
||||
}
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint EslintComments extends.
|
||||
*
|
||||
* @see [Eslint EslintComments extends](https://mysticatea.github.io/eslint-plugin-eslint-comments/#%F0%9F%93%96-usage)
|
||||
*/
|
||||
export type EslintCommentsExtends = 'plugin:eslint-comments/recommended';
|
||||
@ -1,11 +0,0 @@
|
||||
/**
|
||||
* Eslint GraphQL extends.
|
||||
*
|
||||
* @see [Eslint GraphQL extends](https://the-guild.dev/graphql/eslint/docs/configs)
|
||||
*/
|
||||
export type GraphqlExtends =
|
||||
| 'plugin:@graphql-eslint/operations-all'
|
||||
| 'plugin:@graphql-eslint/operations-recommended'
|
||||
| 'plugin:@graphql-eslint/relay'
|
||||
| 'plugin:@graphql-eslint/schema-all'
|
||||
| 'plugin:@graphql-eslint/schema-recommended';
|
||||
@ -1,9 +0,0 @@
|
||||
/**
|
||||
* Eslint import extends.
|
||||
*
|
||||
* @see [Eslint import extends](https://github.com/benmosher/eslint-plugin-import#installation)
|
||||
*/
|
||||
export type ImportExtends =
|
||||
| 'plugin:import/errors'
|
||||
| 'plugin:import/warnings'
|
||||
| 'plugin:import/typescript';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint JSDoc extends.
|
||||
*
|
||||
* @see [Eslint JSDoc extends](https://github.com/gajus/eslint-plugin-jsdoc#configuration)
|
||||
*/
|
||||
export type JsdocExtends = 'plugin:jsdoc/recommended';
|
||||
@ -1,13 +0,0 @@
|
||||
/**
|
||||
* Eslint Jsonc extends.
|
||||
*
|
||||
* @see [Eslint Jsonc extends](https://github.com/ota-meshi/eslint-plugin-jsonc#configuration)
|
||||
*/
|
||||
export type JsoncExtends =
|
||||
| 'plugin:jsdoc/base'
|
||||
| 'plugin:jsdoc/recommended'
|
||||
| 'plugin:jsonc/recommended-with-json'
|
||||
| 'plugin:jsonc/recommended-with-jsonc'
|
||||
| 'plugin:jsonc/recommended-with-json5'
|
||||
| 'plugin:jsonc/prettier'
|
||||
| 'plugin:jsonc/all';
|
||||
@ -1,8 +0,0 @@
|
||||
/**
|
||||
* Eslint JSX A11y extends.
|
||||
*
|
||||
* @see [Eslint JSX A11y extends](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
|
||||
*/
|
||||
export type JsxA11yExtends =
|
||||
| 'plugin:jsx-a11y/strict'
|
||||
| 'plugin:jsx-a11y/recommended';
|
||||
10
src/types/config/extends/eslint-plugin-mdx.d.ts
vendored
10
src/types/config/extends/eslint-plugin-mdx.d.ts
vendored
@ -1,10 +0,0 @@
|
||||
/**
|
||||
* Eslint MDX extends.
|
||||
*
|
||||
* @see [Eslint MDX extends](https://github.com/mdx-js/eslint-mdx/tree/master/packages/eslint-plugin-mdx)
|
||||
*/
|
||||
export type MdxExtends =
|
||||
| 'plugin:mdx/base'
|
||||
| 'plugin:mdx/code-blocks'
|
||||
| 'plugin:mdx/overrides'
|
||||
| 'plugin:mdx/recommended';
|
||||
@ -1,9 +0,0 @@
|
||||
/**
|
||||
* Eslint N (Node) extends.
|
||||
*
|
||||
* @see [Eslint N extends](https://github.com/eslint-community/eslint-plugin-n#-configs)
|
||||
*/
|
||||
export type NExtends =
|
||||
| 'plugin:n/recommended'
|
||||
| 'plugin:n/recommended-module'
|
||||
| 'plugin:n/recommended-script';
|
||||
@ -1,9 +0,0 @@
|
||||
/**
|
||||
* Eslint Node extends.
|
||||
*
|
||||
* @see [Eslint Node extends](https://github.com/mysticatea/eslint-plugin-node#-configs)
|
||||
*/
|
||||
export type NodeExtends =
|
||||
| 'plugin:node/recommended'
|
||||
| 'plugin:node/recommended-module'
|
||||
| 'plugin:node/recommended-script';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint Prettier extends.
|
||||
*
|
||||
* @see [Eslint Prettier extends](https://github.com/prettier/eslint-plugin-prettier#recommended-configuration)
|
||||
*/
|
||||
export type PrettierExtends = 'plugin:prettier/recommended' | 'prettier';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint promise extends.
|
||||
*
|
||||
* @see [Eslint promise extends](https://github.com/eslint-community/eslint-plugin-promise#usage)
|
||||
*/
|
||||
export type PromiseExtends = 'plugin:promise/recommended';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint ReactHooks extends.
|
||||
*
|
||||
* @see [Eslint ReactHooks extends](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
|
||||
*/
|
||||
export type ReactHooksExtends = 'plugin:react-hooks/recommended';
|
||||
@ -1,9 +0,0 @@
|
||||
/**
|
||||
* Eslint React extends.
|
||||
*
|
||||
* @see [Eslint React extends](https://github.com/jsx-eslint/eslint-plugin-react)
|
||||
*/
|
||||
export type ReactExtends =
|
||||
| 'plugin:react/all'
|
||||
| 'plugin:react/jsx-runtime'
|
||||
| 'plugin:react/recommended';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint Sonarjs extends.
|
||||
*
|
||||
* @see [Eslint Sonarjs extends](https://github.com/SonarSource/eslint-plugin-sonarjs#available-configurations)
|
||||
*/
|
||||
export type SonarjsExtends = 'plugin:sonarjs/recommended';
|
||||
@ -1,11 +0,0 @@
|
||||
/**
|
||||
* Eslint TestingLibrary extends.
|
||||
*
|
||||
* @see [Eslint TestingLibrary extends](https://github.com/testing-library/eslint-plugin-testing-library)
|
||||
*/
|
||||
export type TestingLibraryExtends =
|
||||
| 'plugin:testing-library/angular'
|
||||
| 'plugin:testing-library/dom'
|
||||
| 'plugin:testing-library/marko'
|
||||
| 'plugin:testing-library/react'
|
||||
| 'plugin:testing-library/vue';
|
||||
@ -1,8 +0,0 @@
|
||||
/**
|
||||
* Eslint Unicorn extends.
|
||||
*
|
||||
* @see [Eslint Unicorn extends](https://github.com/sindresorhus/eslint-plugin-unicorn)
|
||||
*/
|
||||
export type UnicornExtends =
|
||||
| 'plugin:unicorn/recommended'
|
||||
| 'plugin:unicorn/all';
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint Vitest extends.
|
||||
*
|
||||
* @see [Eslint Vitest extends](https://eslint.vuejs.org/user-guide/#usage)
|
||||
*/
|
||||
export type VitestExtends = 'plugin:vitest/all' | 'plugin:vitest/recommended';
|
||||
@ -1,13 +0,0 @@
|
||||
/**
|
||||
* Eslint Vue Pug extends.
|
||||
*
|
||||
* @see [Eslint Vue Pug extends](https://github.com/rashfael/eslint-plugin-vue-pug#usage)
|
||||
*/
|
||||
export type VuePugExtends =
|
||||
| 'plugin:vue-pug/base'
|
||||
| 'plugin:vue-pug/vue3-essential'
|
||||
| 'plugin:vue-pug/vue3-strongly-recommended'
|
||||
| 'plugin:vue-pug/vue3-recommended'
|
||||
| 'plugin:vue-pug/essential'
|
||||
| 'plugin:vue-pug/strongly-recommended'
|
||||
| 'plugin:vue-pug/recommended';
|
||||
13
src/types/config/extends/eslint-plugin-vue.d.ts
vendored
13
src/types/config/extends/eslint-plugin-vue.d.ts
vendored
@ -1,13 +0,0 @@
|
||||
/**
|
||||
* Eslint Vue extends.
|
||||
*
|
||||
* @see [Eslint Vue extends](https://eslint.vuejs.org/user-guide/#usage)
|
||||
*/
|
||||
export type VueExtends =
|
||||
| 'plugin:vue/base'
|
||||
| 'plugin:vue/vue3-essential'
|
||||
| 'plugin:vue/vue3-strongly-recommended'
|
||||
| 'plugin:vue/vue3-recommended'
|
||||
| 'plugin:vue/essential'
|
||||
| 'plugin:vue/strongly-recommended'
|
||||
| 'plugin:vue/recommended';
|
||||
4
src/types/config/extends/eslint.d.ts
vendored
4
src/types/config/extends/eslint.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
/**
|
||||
* Eslint extends.
|
||||
*/
|
||||
export type EslintExtends = 'eslint:recommended' | 'eslint:all';
|
||||
82
src/types/config/extends/index.d.ts
vendored
82
src/types/config/extends/index.d.ts
vendored
@ -1,82 +0,0 @@
|
||||
import type { LiteralUnion } from '../../utility-types';
|
||||
import type { EslintExtends } from './eslint';
|
||||
import type { EslintCommentsExtends } from './eslint-plugin-eslint-comment';
|
||||
import type { GraphqlExtends } from './eslint-plugin-graphql';
|
||||
import type { ImportExtends } from './eslint-plugin-import';
|
||||
import type { JsdocExtends } from './eslint-plugin-jsdoc';
|
||||
import type { JsoncExtends } from './eslint-plugin-jsonc';
|
||||
import type { MdxExtends } from './eslint-plugin-mdx';
|
||||
import type { NExtends } from './eslint-plugin-n';
|
||||
import type { NodeExtends } from './eslint-plugin-node';
|
||||
import type { PrettierExtends } from './eslint-plugin-prettier';
|
||||
import type { PromiseExtends } from './eslint-plugin-promise';
|
||||
import type { ReactExtends } from './eslint-plugin-react';
|
||||
import type { ReactHooksExtends } from './eslint-plugin-react-hooks';
|
||||
import type { SonarjsExtends } from './eslint-plugin-sonarjs';
|
||||
import type { TestingLibraryExtends } from './eslint-plugin-testing-library';
|
||||
import type { UnicornExtends } from './eslint-plugin-unicorn';
|
||||
import type { VitestExtends } from './eslint-plugin-vitest';
|
||||
import type { VueExtends } from './eslint-plugin-vue';
|
||||
import type { VuePugExtends } from './eslint-plugin-vue-pug';
|
||||
import type { IntlifyVueI18nExtends } from './intlify-vue-i18n';
|
||||
import type { TypescriptEslintExtends } from './typescript-eslint';
|
||||
|
||||
/**
|
||||
* This is a special exported interface for other packages to declare
|
||||
* additional extensions that should bail out for eslint extensions. For example
|
||||
* `'@typescript-eslint/eslint-plugin'` can declare it like so in its `d.ts`:
|
||||
*
|
||||
* ```ts
|
||||
* declare module 'eslint-define-config' {
|
||||
* export interface CustomExtends {
|
||||
* 'plugin:@typescript-eslint/all': void;
|
||||
* 'plugin:@typescript-eslint/base': void;
|
||||
* 'plugin:@typescript-eslint/disable-type-checked': void;
|
||||
* 'plugin:@typescript-eslint/eslint-recommended': void;
|
||||
* 'plugin:@typescript-eslint/recommended-type-checked': void;
|
||||
* 'plugin:@typescript-eslint/recommended': void;
|
||||
* 'plugin:@typescript-eslint/strict-type-checked': void;
|
||||
* 'plugin:@typescript-eslint/strict': void;
|
||||
* 'plugin:@typescript-eslint/stylistic-type-checked': void;
|
||||
* 'plugin:@typescript-eslint/stylistic': void;
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface CustomExtends {}
|
||||
|
||||
/**
|
||||
* All known extends.
|
||||
*/
|
||||
export type KnownExtends = LiteralUnion<
|
||||
| EslintCommentsExtends
|
||||
| EslintExtends
|
||||
| GraphqlExtends
|
||||
| ImportExtends
|
||||
| IntlifyVueI18nExtends
|
||||
| JsdocExtends
|
||||
| JsoncExtends
|
||||
| MdxExtends
|
||||
| NExtends
|
||||
| NodeExtends
|
||||
| PrettierExtends
|
||||
| PromiseExtends
|
||||
| ReactExtends
|
||||
| ReactHooksExtends
|
||||
| SonarjsExtends
|
||||
| TestingLibraryExtends
|
||||
| TypescriptEslintExtends
|
||||
| UnicornExtends
|
||||
| VitestExtends
|
||||
| VueExtends
|
||||
| VuePugExtends
|
||||
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
|
||||
| keyof CustomExtends
|
||||
>;
|
||||
|
||||
/**
|
||||
* Extending Configuration Files.
|
||||
*
|
||||
* @see [Extends](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
|
||||
*/
|
||||
export type Extends = KnownExtends | KnownExtends[];
|
||||
@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Eslint Intlify VueI18n extends.
|
||||
*
|
||||
* @see [Eslint Intlify VueI18n extends](https://eslint-plugin-vue-i18n.intlify.dev/started.html)
|
||||
*/
|
||||
export type IntlifyVueI18nExtends = 'plugin:@intlify/vue-i18n/recommended';
|
||||
17
src/types/config/extends/typescript-eslint.d.ts
vendored
17
src/types/config/extends/typescript-eslint.d.ts
vendored
@ -1,17 +0,0 @@
|
||||
/**
|
||||
* Typescript eslint extends.
|
||||
*
|
||||
* @see [Typescript eslint extends](https://typescript-eslint.io/linting/configs#recommended-configurations)
|
||||
*/
|
||||
export type TypescriptEslintExtends =
|
||||
| 'plugin:@typescript-eslint/all'
|
||||
| 'plugin:@typescript-eslint/base'
|
||||
| 'plugin:@typescript-eslint/disable-type-checked'
|
||||
| 'plugin:@typescript-eslint/eslint-recommended'
|
||||
| 'plugin:@typescript-eslint/recommended-requiring-type-checking' // this requiring-type-checking is deprecated and only for @typescript-eslint/eslint-plugin@v5
|
||||
| 'plugin:@typescript-eslint/recommended-type-checked'
|
||||
| 'plugin:@typescript-eslint/recommended'
|
||||
| 'plugin:@typescript-eslint/strict-type-checked'
|
||||
| 'plugin:@typescript-eslint/strict'
|
||||
| 'plugin:@typescript-eslint/stylistic-type-checked'
|
||||
| 'plugin:@typescript-eslint/stylistic';
|
||||
121
src/types/config/index.d.ts
vendored
121
src/types/config/index.d.ts
vendored
@ -1,121 +0,0 @@
|
||||
import type { Parser, ParserOptions } from '../parser-options';
|
||||
import type { Rules } from '../rules';
|
||||
import type { Environments } from './env';
|
||||
import type { Extends } from './extends';
|
||||
import type { Overrides } from './overrides';
|
||||
import type { Plugin } from './plugin';
|
||||
import type { Settings } from './settings';
|
||||
|
||||
/**
|
||||
* ESLint Configuration.
|
||||
*
|
||||
* @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/)
|
||||
*/
|
||||
export interface ESLintConfig {
|
||||
/**
|
||||
* @see [Using Configuration Files](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#using-configuration-files)
|
||||
*/
|
||||
root?: boolean;
|
||||
|
||||
/**
|
||||
* Tell ESLint to ignore specific files and directories.
|
||||
*
|
||||
* @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code)
|
||||
*/
|
||||
ignorePatterns?: string[];
|
||||
|
||||
/**
|
||||
* An environment provides predefined global variables.
|
||||
*
|
||||
* @see [Environments](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments)
|
||||
*/
|
||||
env?: Environments;
|
||||
|
||||
/**
|
||||
* Extending Configuration Files.
|
||||
*
|
||||
* @see [Extends](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#extending-configuration-files)
|
||||
*/
|
||||
extends?: Extends;
|
||||
|
||||
/**
|
||||
* Specifying Globals.
|
||||
*
|
||||
* @see [Globals](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-globals)
|
||||
*/
|
||||
globals?: Record<
|
||||
string,
|
||||
'readonly' | 'writable' | false | 'readable' | true | 'writeable' | 'off'
|
||||
>;
|
||||
|
||||
/**
|
||||
* Parser.
|
||||
*
|
||||
* @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers)
|
||||
* @see [Specifying Parser](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-a-parser)
|
||||
*/
|
||||
parser?: Parser;
|
||||
|
||||
/**
|
||||
* Parser Options.
|
||||
*
|
||||
* @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers)
|
||||
* @see [Specifying Parser Options](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options)
|
||||
*/
|
||||
parserOptions?: ParserOptions;
|
||||
|
||||
/**
|
||||
* Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.
|
||||
*
|
||||
* @see [Configuring Plugins](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-plugins)
|
||||
*/
|
||||
plugins?: Plugin[];
|
||||
|
||||
/**
|
||||
* Specifying Processor.
|
||||
*
|
||||
* @see [processor](https://eslint.org/docs/latest/user-guide/configuring/plugins#specify-a-processor)
|
||||
*/
|
||||
processor?: string;
|
||||
|
||||
/**
|
||||
* Rules.
|
||||
*
|
||||
* @see [Rules](https://eslint.org/docs/latest/user-guide/configuring/rules)
|
||||
*/
|
||||
rules?: Partial<Rules>;
|
||||
|
||||
/**
|
||||
* Overrides.
|
||||
*
|
||||
* @see [How do overrides work](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#how-do-overrides-work)
|
||||
*/
|
||||
overrides?: Overrides;
|
||||
|
||||
/**
|
||||
* Settings.
|
||||
*
|
||||
* @see [Settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#adding-shared-settings)
|
||||
*/
|
||||
settings?: Settings;
|
||||
|
||||
/**
|
||||
* Disabling Inline Comments.
|
||||
*
|
||||
* @see [Disabling Inline Comments](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-inline-comments)
|
||||
*/
|
||||
noInlineConfig?: boolean;
|
||||
|
||||
/**
|
||||
* Report unused `ESLint-disable` comments.
|
||||
*
|
||||
* @see [Report unused `ESLint-disable` comments](https://eslint.org/docs/latest/user-guide/configuring/rules#report-unused-eslint-disable-comments)
|
||||
*/
|
||||
reportUnusedDisableDirectives?: boolean;
|
||||
}
|
||||
|
||||
export * from './env';
|
||||
export * from './extends';
|
||||
export * from './overrides';
|
||||
export * from './plugin';
|
||||
export * from './settings';
|
||||
96
src/types/config/overrides.d.ts
vendored
96
src/types/config/overrides.d.ts
vendored
@ -1,96 +0,0 @@
|
||||
import type { Parser, ParserOptions } from '../parser-options';
|
||||
import type { Rules } from '../rules';
|
||||
import type { Environments } from './env';
|
||||
import type { Extends } from './extends';
|
||||
import type { Plugin } from './plugin';
|
||||
import type { Settings } from './settings';
|
||||
|
||||
/**
|
||||
* OverrideConfigData.
|
||||
*/
|
||||
export interface Override {
|
||||
/**
|
||||
* The glob patterns for target files.
|
||||
*/
|
||||
// https://github.com/eslint/eslint/blob/762a8727fb3b5619cff900826053b643ca5f1162/lib/shared/types.js#L61
|
||||
files: string[] | string;
|
||||
|
||||
/**
|
||||
* The glob patterns for excluded files.
|
||||
*/
|
||||
// https://github.com/eslint/eslint/blob/762a8727fb3b5619cff900826053b643ca5f1162/lib/shared/types.js#L59
|
||||
excludedFiles?: string | string[];
|
||||
|
||||
/**
|
||||
* An environment provides predefined global variables.
|
||||
*
|
||||
* @see [Environments](https://eslint.org/docs/user-guide/configuring/language-options#specifying-environments)
|
||||
*/
|
||||
env?: Environments;
|
||||
|
||||
/**
|
||||
* Extending Configuration Files.
|
||||
*
|
||||
* @see [Extends](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files)
|
||||
*/
|
||||
extends?: Extends;
|
||||
|
||||
/**
|
||||
* Specifying Globals.
|
||||
*
|
||||
* @see [Globals](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-globals)
|
||||
*/
|
||||
globals?: Record<
|
||||
string,
|
||||
'readonly' | 'writable' | false | 'readable' | true | 'writeable' | 'off'
|
||||
>;
|
||||
|
||||
/**
|
||||
* Parser.
|
||||
*
|
||||
* @see [Working with Custom Parsers](https://eslint.org/docs/developer-guide/working-with-custom-parsers)
|
||||
* @see [Specifying Parser](https://eslint.org/docs/user-guide/configuring/plugins#specifying-parser)
|
||||
*/
|
||||
parser?: Parser;
|
||||
|
||||
/**
|
||||
* Parser Options.
|
||||
*
|
||||
* @see [Working with Custom Parsers](https://eslint.org/docs/developer-guide/working-with-custom-parsers)
|
||||
* @see [Specifying Parser Options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options)
|
||||
*/
|
||||
parserOptions?: ParserOptions;
|
||||
|
||||
/**
|
||||
* Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.
|
||||
*
|
||||
* @see [Configuring Plugins](https://eslint.org/docs/user-guide/configuring/plugins#configuring-plugins)
|
||||
*/
|
||||
plugins?: Plugin[];
|
||||
|
||||
/**
|
||||
* Specifying Processor.
|
||||
*
|
||||
* @see [processor](https://eslint.org/docs/user-guide/configuring/plugins#specifying-processor)
|
||||
*/
|
||||
processor?: string;
|
||||
|
||||
/**
|
||||
* Rules.
|
||||
*
|
||||
* @see [Rules](https://eslint.org/docs/user-guide/configuring/rules)
|
||||
*/
|
||||
rules?: Partial<Rules>;
|
||||
|
||||
/**
|
||||
* Settings.
|
||||
*
|
||||
* @see [Settings](https://eslint.org/docs/user-guide/configuring/configuration-files#adding-shared-settings)
|
||||
*/
|
||||
settings?: Settings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Overrides.
|
||||
*/
|
||||
export type Overrides = Override[];
|
||||
40
src/types/config/plugin.d.ts
vendored
40
src/types/config/plugin.d.ts
vendored
@ -1,40 +0,0 @@
|
||||
import type { LiteralUnion } from '../utility-types';
|
||||
|
||||
/**
|
||||
* This is a special exported interface for other packages to declare
|
||||
* additional plugins that should bail out for eslint plugins. For example
|
||||
* `'@typescript-eslint/eslint-plugin'` can declare it like so in its `d.ts`:
|
||||
*
|
||||
* ```ts
|
||||
* declare module 'eslint-define-config' {
|
||||
* export interface CustomPlugins {
|
||||
* '@typescript-eslint': void;
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface CustomPlugins {}
|
||||
|
||||
/** Plugin. */
|
||||
export type Plugin = LiteralUnion<
|
||||
| '@graphql-eslint'
|
||||
| '@typescript-eslint'
|
||||
| 'deprecation'
|
||||
| 'import'
|
||||
| 'inclusive-language'
|
||||
| 'jsdoc'
|
||||
| 'jsx-a11y'
|
||||
| 'mdx'
|
||||
| 'prettier'
|
||||
| 'promise'
|
||||
| 'react-hooks'
|
||||
| 'react'
|
||||
| 'sonarjs'
|
||||
| 'spellcheck'
|
||||
| 'testing-library'
|
||||
| 'unicorn'
|
||||
| 'vitest'
|
||||
| 'vue'
|
||||
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
|
||||
| keyof CustomPlugins
|
||||
>;
|
||||
66
src/types/config/settings/import.d.ts
vendored
66
src/types/config/settings/import.d.ts
vendored
@ -1,66 +0,0 @@
|
||||
import type { Parser } from '../../parser-options';
|
||||
|
||||
/**
|
||||
* Import settings.
|
||||
*/
|
||||
export interface ImportSettings {
|
||||
/**
|
||||
* A list of file extensions that will be parsed as modules and inspected for `export`s.
|
||||
*
|
||||
* @see [import/extensions](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importextensions)
|
||||
*/
|
||||
'import/extensions'?: string[];
|
||||
|
||||
/**
|
||||
* If you require more granular extension definitions.
|
||||
*
|
||||
* @see [import/resolver](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importresolver)
|
||||
*/
|
||||
'import/resolver'?: string | Record<string, unknown>;
|
||||
|
||||
/**
|
||||
* A list of regex strings that, if matched by a path, will not report the matching module if no `exports` are found.
|
||||
*
|
||||
* @see [import/ignore](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importignore)
|
||||
*/
|
||||
'import/ignore'?: string[];
|
||||
|
||||
/**
|
||||
* An array of additional modules to consider as "core" modules--modules that should be considered resolved but have no path on the filesystem.
|
||||
*
|
||||
* @see [import/core-modules](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importcore-modules)
|
||||
*/
|
||||
'import/core-modules'?: string[];
|
||||
|
||||
/**
|
||||
* An array of folders. Resolved modules only from those folders will be considered as "external".
|
||||
*
|
||||
* @default ["node_modules"]
|
||||
*
|
||||
* @see [import/external-module-folders](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importexternal-module-folders)
|
||||
*/
|
||||
'import/external-module-folders'?: string[];
|
||||
|
||||
/**
|
||||
* A map from parsers to file extension arrays.
|
||||
*
|
||||
* @see [import/parsers](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importparsers)
|
||||
*/
|
||||
'import/parsers'?: Partial<Record<Parser, string[]>>;
|
||||
|
||||
/**
|
||||
* Settings for cache behavior.
|
||||
*
|
||||
* @see [import/cache](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importcache)
|
||||
*/
|
||||
'import/cache'?: { lifetime?: number } & Record<string, unknown>;
|
||||
|
||||
/**
|
||||
* A regex for packages should be treated as internal.
|
||||
*
|
||||
* Useful when you are utilizing a monorepo setup or developing a set of packages that depend on each other.
|
||||
*
|
||||
* @see [import/internal-regex](https://github.com/benmosher/eslint-plugin-import/blob/master/README.md#importinternal-regex)
|
||||
*/
|
||||
'import/internal-regex'?: string;
|
||||
}
|
||||
36
src/types/config/settings/index.d.ts
vendored
36
src/types/config/settings/index.d.ts
vendored
@ -1,36 +0,0 @@
|
||||
import type { ImportSettings } from './import';
|
||||
import type { JSDocSettings } from './jsdoc';
|
||||
import type { JsxA11ySettings } from './jsx-a11y';
|
||||
import type { MdxSettings } from './mdx';
|
||||
import type { NodeSettings } from './node';
|
||||
import type { ReactSettings } from './react';
|
||||
|
||||
/**
|
||||
* This is a special exported interface for other packages to declare
|
||||
* additional settings that should bail out for eslint settings. For example
|
||||
* `'eslint-plugin-jsx-a11y'` can declare it like so in its `d.ts`:
|
||||
*
|
||||
* ```ts
|
||||
* declare module 'eslint-define-config' {
|
||||
* export interface CustomSettings {
|
||||
* 'jsx-a11y': {
|
||||
* components?: Record<string, string>;
|
||||
* };
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface CustomSettings {}
|
||||
|
||||
/**
|
||||
* Settings.
|
||||
*/
|
||||
export interface Settings
|
||||
extends ImportSettings,
|
||||
JSDocSettings,
|
||||
JsxA11ySettings,
|
||||
MdxSettings,
|
||||
NodeSettings,
|
||||
ReactSettings,
|
||||
Partial<CustomSettings>,
|
||||
Partial<Record<string, unknown>> {}
|
||||
59
src/types/config/settings/jsdoc.d.ts
vendored
59
src/types/config/settings/jsdoc.d.ts
vendored
@ -1,59 +0,0 @@
|
||||
/**
|
||||
* JSDoc settings.
|
||||
*/
|
||||
export interface JSDocSetting extends Partial<Record<string, unknown>> {
|
||||
/**
|
||||
* Disables all rules for the comment block on which a `@private` tag (or `@access private`) occurs.
|
||||
*
|
||||
* Defaults to `false`.
|
||||
*
|
||||
* Note: This has no effect with the rule `check-access` (whose purpose is to check access modifiers) or `empty-tags` (which checks `@private` itself).
|
||||
*
|
||||
* @see [mode](https://github.com/gajus/eslint-plugin-jsdoc#allow-tags-private-or-internal-to-disable-rules-for-that-comment-block)
|
||||
*/
|
||||
ignorePrivate?: boolean;
|
||||
|
||||
/**
|
||||
* Disables all rules for the comment block on which a `@internal` tag occurs.
|
||||
*
|
||||
* Defaults to `false`.
|
||||
*
|
||||
* Note: This has no effect with the rule `empty-tags` (which checks `@internal` itself).
|
||||
*
|
||||
* @see [mode](https://github.com/gajus/eslint-plugin-jsdoc#allow-tags-private-or-internal-to-disable-rules-for-that-comment-block)
|
||||
*/
|
||||
ignoreInternal?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `typescript`, `closure`, or `jsdoc` (the default unless the `@typescript-eslint` parser is in use in which case `typescript` will be the default).
|
||||
*
|
||||
* @see [mode](https://github.com/gajus/eslint-plugin-jsdoc#mode)
|
||||
*/
|
||||
mode?: 'typescript' | 'closure' | 'jsdoc';
|
||||
|
||||
/**
|
||||
* Configure a preferred alias name for a JSDoc tag.
|
||||
*
|
||||
* @see [Alias Preference](https://github.com/gajus/eslint-plugin-jsdoc#alias-preference)
|
||||
*/
|
||||
tagNamePreference?: Record<
|
||||
string,
|
||||
string | { message: string; replacement?: string } | false
|
||||
>;
|
||||
overrideReplacesDocs?: boolean;
|
||||
augmentsExtendsReplacesDocs?: boolean;
|
||||
implementsReplacesDocs?: boolean;
|
||||
preferredTypes?: unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* JSDoc settings.
|
||||
*/
|
||||
export interface JSDocSettings {
|
||||
/**
|
||||
* JSDoc settings.
|
||||
*
|
||||
* @see [JSDoc settings](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-settings)
|
||||
*/
|
||||
jsdoc?: JSDocSetting;
|
||||
}
|
||||
10
src/types/config/settings/jsx-a11y.d.ts
vendored
10
src/types/config/settings/jsx-a11y.d.ts
vendored
@ -1,10 +0,0 @@
|
||||
/**
|
||||
* JSX A11y settings.
|
||||
*
|
||||
* @see [JSX A11y settings](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
|
||||
*/
|
||||
export interface JsxA11ySettings extends Partial<Record<string, unknown>> {
|
||||
'jsx-a11y'?: {
|
||||
components?: Record<string, string>;
|
||||
};
|
||||
}
|
||||
6
src/types/config/settings/mdx.d.ts
vendored
6
src/types/config/settings/mdx.d.ts
vendored
@ -1,6 +0,0 @@
|
||||
import type { ESLintMdxSettings } from 'eslint-plugin-mdx';
|
||||
|
||||
/**
|
||||
* MDX settings.
|
||||
*/
|
||||
export type MdxSettings = ESLintMdxSettings;
|
||||
18
src/types/config/settings/node.d.ts
vendored
18
src/types/config/settings/node.d.ts
vendored
@ -1,18 +0,0 @@
|
||||
/**
|
||||
* Node settings.
|
||||
*/
|
||||
export interface NodeSetting extends Partial<Record<string, unknown>> {
|
||||
allowModules?: string[];
|
||||
resolvePaths?: string[];
|
||||
tryExtensions?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Node settings.
|
||||
*/
|
||||
export interface NodeSettings {
|
||||
/**
|
||||
* Node settings.
|
||||
*/
|
||||
node?: NodeSetting;
|
||||
}
|
||||
103
src/types/config/settings/react.d.ts
vendored
103
src/types/config/settings/react.d.ts
vendored
@ -1,103 +0,0 @@
|
||||
import type { LiteralUnion } from '../../utility-types';
|
||||
|
||||
/**
|
||||
* React settings.
|
||||
*
|
||||
* @see [React settings](https://github.com/jsx-eslint/eslint-plugin-react)
|
||||
*/
|
||||
export interface ReactSettings extends Partial<Record<string, unknown>> {
|
||||
react?: {
|
||||
/**
|
||||
* Regex for Component Factory to use.
|
||||
*
|
||||
* @default 'createReactClass'
|
||||
*/
|
||||
createClass?: LiteralUnion<'createReactClass'>;
|
||||
|
||||
/**
|
||||
* Pragma to use.
|
||||
*
|
||||
* @default 'React'
|
||||
*/
|
||||
pragma?: LiteralUnion<'React'>;
|
||||
|
||||
/**
|
||||
* Fragment to use (may be a property of <pragma>).
|
||||
*
|
||||
* @default 'Fragment'
|
||||
*/
|
||||
fragment?: LiteralUnion<'Fragment'>;
|
||||
|
||||
/**
|
||||
* React version. "detect" automatically picks the version you have installed.
|
||||
*
|
||||
* You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
|
||||
*
|
||||
* It will default to "latest" and warn if missing, and to "detect" in the future.
|
||||
*
|
||||
* @default 'latest'
|
||||
*/
|
||||
version?: LiteralUnion<'latest' | 'detect'>;
|
||||
|
||||
/**
|
||||
* Flow version.
|
||||
*/
|
||||
flowVersion?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* The names of any function used to wrap propTypes, e.g. `forbidExtraProps`.
|
||||
*
|
||||
* If this isn't set, any propTypes wrapped in a function will be skipped.
|
||||
*/
|
||||
propWrapperFunctions?: Array<
|
||||
| string
|
||||
| {
|
||||
property: string;
|
||||
object?: string;
|
||||
/**
|
||||
* For rules that check exact prop wrappers.
|
||||
*/
|
||||
exact?: boolean;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
[k: string]: any;
|
||||
}
|
||||
>;
|
||||
|
||||
/**
|
||||
* The name of any function used to wrap components, e.g. Mobx `observer` function.
|
||||
*
|
||||
* If this isn't set, components wrapped by these functions will be skipped.
|
||||
*/
|
||||
componentWrapperFunctions?: Array<
|
||||
| string
|
||||
| {
|
||||
property: string;
|
||||
object?: string;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
[k: string]: any;
|
||||
}
|
||||
>;
|
||||
|
||||
/**
|
||||
* Components used as alternatives to <form> for forms, eg. <Form endpoint={ url } />.
|
||||
*/
|
||||
formComponents?: Array<
|
||||
| string
|
||||
| {
|
||||
name: string;
|
||||
formAttribute: string;
|
||||
}
|
||||
>;
|
||||
|
||||
/**
|
||||
* Components used as alternatives to <a> for linking, eg. <Link to={ url } />.
|
||||
*/
|
||||
linkComponents?: Array<
|
||||
| string
|
||||
| {
|
||||
name: string;
|
||||
linkAttribute: string;
|
||||
}
|
||||
>;
|
||||
}
|
||||
24
src/types/config/settings/testing-library.d.ts
vendored
24
src/types/config/settings/testing-library.d.ts
vendored
@ -1,24 +0,0 @@
|
||||
import type { LiteralUnion } from '../../utility-types';
|
||||
|
||||
/**
|
||||
* Testing Library settings.
|
||||
*
|
||||
* @see [Testing Library settings](https://github.com/testing-library/eslint-plugin-testing-library)
|
||||
*/
|
||||
export interface TestingLibrarySettings
|
||||
extends Partial<Record<string, unknown>> {
|
||||
/**
|
||||
* @see [testing-library/custom-queries](https://github.com/testing-library/eslint-plugin-testing-library#testing-librarycustom-queries)
|
||||
*/
|
||||
'testing-library/custom-queries'?: 'off' | string[];
|
||||
|
||||
/**
|
||||
* @see [testing-library/custom-renders](https://github.com/testing-library/eslint-plugin-testing-library#testing-librarycustom-renders)
|
||||
*/
|
||||
'testing-library/custom-renders'?: 'off' | string[];
|
||||
|
||||
/**
|
||||
* @see [testing-library/utils-module](https://github.com/testing-library/eslint-plugin-testing-library#testing-libraryutils-module)
|
||||
*/
|
||||
'testing-library/utils-module'?: LiteralUnion<'off'>;
|
||||
}
|
||||
80
src/types/flat-config/index.d.ts
vendored
80
src/types/flat-config/index.d.ts
vendored
@ -1,80 +0,0 @@
|
||||
import type { ESLint, Linter } from 'eslint';
|
||||
import type { Rules } from '../rules';
|
||||
import type { LanguageOptions } from './language-options';
|
||||
import type { LinterOptions } from './linter-options';
|
||||
|
||||
/**
|
||||
* Flat ESLint Configuration.
|
||||
*
|
||||
* @see [Configuration Files (New)](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new)
|
||||
*/
|
||||
export interface FlatESLintConfigItem {
|
||||
/**
|
||||
* An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files.
|
||||
*
|
||||
* @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
|
||||
*/
|
||||
files?: string[];
|
||||
|
||||
/**
|
||||
* An array of glob patterns indicating the files that the configuration object should not apply to. If not specified, the configuration object applies to all files matched by files.
|
||||
*
|
||||
* @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#excluding-files-with-ignores)
|
||||
*/
|
||||
ignores?: string[];
|
||||
|
||||
/**
|
||||
* An object containing settings related to how JavaScript is configured for linting.
|
||||
*
|
||||
* @see [Configuring language options](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-language-options)
|
||||
*/
|
||||
languageOptions?: LanguageOptions;
|
||||
|
||||
/**
|
||||
* An object containing settings related to the linting process.
|
||||
*/
|
||||
linterOptions?: LinterOptions;
|
||||
|
||||
/**
|
||||
* Either an object containing `preprocess()` and `postprocess()` methods or a string indicating the name of a processor inside of a plugin (i.e., `"pluginName/processorName"`).
|
||||
*
|
||||
* @see [Using processors](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-processors)
|
||||
*/
|
||||
processor?: string | Linter.Processor;
|
||||
|
||||
/**
|
||||
* An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
|
||||
*
|
||||
* @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
|
||||
*/
|
||||
plugins?: Record<string, ESLint.Plugin>;
|
||||
|
||||
/**
|
||||
* An object containing the configured rules. When `files` or `ignores` are specified, these rule configurations are only available to the matching files.
|
||||
*
|
||||
* @see [Configuring rules](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-rules)
|
||||
*/
|
||||
rules?: Partial<Rules>;
|
||||
|
||||
/**
|
||||
* An object containing name-value pairs of information that should be available to all rules.
|
||||
*
|
||||
* @see [Configuring shared settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-shared-settings)
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
settings?: Record<string, any>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Predefined configurations.
|
||||
*
|
||||
* @see [Using predefined configurations](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-predefined-configurations)
|
||||
*
|
||||
* @deprecated The predefined string configurations are deprecated and will be replaced by the @eslint/js package.
|
||||
*/
|
||||
export type PredefinedConfig = 'eslint:recommended' | 'eslint:all';
|
||||
|
||||
export type FlatESLintConfig = FlatESLintConfigItem | PredefinedConfig;
|
||||
|
||||
export * from './language-options';
|
||||
export * from './linter-options';
|
||||
64
src/types/flat-config/language-options.d.ts
vendored
64
src/types/flat-config/language-options.d.ts
vendored
@ -1,64 +0,0 @@
|
||||
import type {
|
||||
EcmaVersion,
|
||||
Parser,
|
||||
ParserOptions,
|
||||
SourceType,
|
||||
} from '../parser-options';
|
||||
|
||||
export type ParserModule =
|
||||
| {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
parse(text: string, options?: any): any;
|
||||
}
|
||||
| {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
parseForESLint(text: string, options?: any): any;
|
||||
};
|
||||
|
||||
/**
|
||||
* An object containing settings related to how JavaScript is configured for linting
|
||||
*/
|
||||
export interface LanguageOptions {
|
||||
/**
|
||||
* The version of ECMAScript to support. May be any year (i.e., `2022`) or version (i.e., `5`). Set to `"latest"` for the most recent supported version.
|
||||
*
|
||||
* @default "latest"
|
||||
* @see [Configuring the JavaScript version](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-the-javascript-version)
|
||||
*/
|
||||
ecmaVersion?: EcmaVersion;
|
||||
|
||||
/**
|
||||
* The type of JavaScript source code. Possible values are `"script"` for traditional script files, `"module"` for ECMAScript modules (ESM), and `"commonjs"` for CommonJS files.
|
||||
*
|
||||
* (default: `"module"` for .js and .mjs files; `"commonjs"` for .cjs files)
|
||||
*
|
||||
* @see [Configuring the JavaScript source type](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-the-javascript-source-type)
|
||||
*/
|
||||
sourceType?: SourceType | 'commonjs';
|
||||
|
||||
/**
|
||||
* An object specifying additional objects that should be added to the global scope during linting.
|
||||
*
|
||||
* @see [Configuring global variables](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-global-variables)
|
||||
*/
|
||||
globals?: Record<
|
||||
string,
|
||||
'readonly' | 'writable' | false | 'readable' | true | 'writeable' | 'off'
|
||||
>;
|
||||
|
||||
/**
|
||||
* Either an object containing a `parse()` method or a string indicating the name of a parser inside of a plugin (i.e., `"pluginName/parserName"`).
|
||||
*
|
||||
* @default "@/espree"
|
||||
*
|
||||
* @see [Configuring a custom parser and its options](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-a-custom-parser-and-its-options)
|
||||
*/
|
||||
parser?: Parser | ParserModule;
|
||||
|
||||
/**
|
||||
* An object specifying additional options that are passed directly to the `parser()` method on the parser. The available options are parser-dependent.
|
||||
*
|
||||
* @see [Configuring a custom parser and its options](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#configuring-a-custom-parser-and-its-options)
|
||||
*/
|
||||
parserOptions?: ParserOptions;
|
||||
}
|
||||
18
src/types/flat-config/linter-options.d.ts
vendored
18
src/types/flat-config/linter-options.d.ts
vendored
@ -1,18 +0,0 @@
|
||||
/**
|
||||
* An object containing settings related to the linting process.
|
||||
*/
|
||||
export interface LinterOptions {
|
||||
/**
|
||||
* A boolean value indicating if inline configuration is allowed.
|
||||
*
|
||||
* @see [Disabling inline configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#disabling-inline-configuration)
|
||||
*/
|
||||
noInlineConfig?: boolean;
|
||||
|
||||
/**
|
||||
* A boolean value indicating if unused disable directives should be tracked and reported.
|
||||
*
|
||||
* @see [Reporting unused disable directives](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#reporting-unused-disable-directives)
|
||||
*/
|
||||
reportUnusedDisableDirectives?: boolean;
|
||||
}
|
||||
4
src/types/index.d.ts
vendored
4
src/types/index.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
export type * from './config';
|
||||
export type * from './flat-config';
|
||||
export type * from './parser-options';
|
||||
export type * from './rules';
|
||||
402
src/types/parser-options.d.ts
vendored
402
src/types/parser-options.d.ts
vendored
@ -1,402 +0,0 @@
|
||||
import type { LiteralUnion } from './utility-types';
|
||||
|
||||
// Some types copied from `@types/eslint` `Linter.ParserOptions`
|
||||
|
||||
/**
|
||||
* Any valid ECMAScript version number or 'latest':
|
||||
*
|
||||
* - A version: es3, es5, es6, es7, es8, es9, es10, es11, es12, es13, es14, ...
|
||||
* - A year: es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, ...
|
||||
* - 'latest'
|
||||
*
|
||||
* @see https://typescript-eslint.io/architecture/parser/#ecmaversion
|
||||
*/
|
||||
export type EcmaVersion =
|
||||
| 3
|
||||
| 5
|
||||
| 6
|
||||
| 7
|
||||
| 8
|
||||
| 9
|
||||
| 10
|
||||
| 11
|
||||
| 12
|
||||
| 13
|
||||
| 14
|
||||
| 2015
|
||||
| 2016
|
||||
| 2017
|
||||
| 2018
|
||||
| 2019
|
||||
| 2020
|
||||
| 2021
|
||||
| 2022
|
||||
| 2023
|
||||
| 'latest';
|
||||
|
||||
/**
|
||||
* Set to "script" (default) or "module" if your code is in ECMAScript modules.
|
||||
*/
|
||||
export type SourceType = 'script' | 'module';
|
||||
|
||||
/**
|
||||
* An object indicating which additional language features you'd like to use.
|
||||
*
|
||||
* @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options
|
||||
* @see https://typescript-eslint.io/architecture/parser#ecmafeatures
|
||||
*/
|
||||
export interface EcmaFeatures extends Partial<Record<string, boolean>> {
|
||||
/**
|
||||
* Allow `return` statements in the global scope.
|
||||
*/
|
||||
globalReturn?: boolean;
|
||||
|
||||
/**
|
||||
* Enable global [strict mode](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode) (if `ecmaVersion` is 5 or greater).
|
||||
*/
|
||||
impliedStrict?: boolean;
|
||||
|
||||
/**
|
||||
* Enable [JSX](https://facebook.github.io/jsx).
|
||||
*/
|
||||
jsx?: boolean;
|
||||
}
|
||||
|
||||
/** Lib. */
|
||||
export type Lib = LiteralUnion<
|
||||
| 'es5'
|
||||
| 'es6'
|
||||
| 'es2015'
|
||||
| 'es7'
|
||||
| 'es2016'
|
||||
| 'es2017'
|
||||
| 'es2018'
|
||||
| 'es2019'
|
||||
| 'es2020'
|
||||
| 'esnext'
|
||||
| 'dom'
|
||||
| 'dom.iterable'
|
||||
| 'webworker'
|
||||
| 'webworker.importscripts'
|
||||
| 'webworker.iterable'
|
||||
| 'scripthost'
|
||||
| 'es2015.core'
|
||||
| 'es2015.collection'
|
||||
| 'es2015.generator'
|
||||
| 'es2015.iterable'
|
||||
| 'es2015.promise'
|
||||
| 'es2015.proxy'
|
||||
| 'es2015.reflect'
|
||||
| 'es2015.symbol'
|
||||
| 'es2015.symbol.wellknown'
|
||||
| 'es2016.array.include'
|
||||
| 'es2017.object'
|
||||
| 'es2017.sharedmemory'
|
||||
| 'es2017.string'
|
||||
| 'es2017.intl'
|
||||
| 'es2017.typedarrays'
|
||||
| 'es2018.asyncgenerator'
|
||||
| 'es2018.asynciterable'
|
||||
| 'es2018.intl'
|
||||
| 'es2018.promise'
|
||||
| 'es2018.regexp'
|
||||
| 'es2019.array'
|
||||
| 'es2019.object'
|
||||
| 'es2019.string'
|
||||
| 'es2019.symbol'
|
||||
| 'es2020.bigint'
|
||||
| 'es2020.promise'
|
||||
| 'es2020.sharedmemory'
|
||||
| 'es2020.string'
|
||||
| 'es2020.symbol.wellknown'
|
||||
| 'es2020.intl'
|
||||
| 'esnext.array'
|
||||
| 'esnext.symbol'
|
||||
| 'esnext.asynciterable'
|
||||
| 'esnext.intl'
|
||||
| 'esnext.bigint'
|
||||
| 'esnext.string'
|
||||
| 'esnext.promise'
|
||||
| 'esnext.weakref'
|
||||
| 'es2016.full'
|
||||
| 'es2017.full'
|
||||
| 'es2018.full'
|
||||
| 'es2019.full'
|
||||
| 'es2020.full'
|
||||
| 'esnext.full'
|
||||
| 'lib'
|
||||
>;
|
||||
|
||||
/** DebugLevel. */
|
||||
export type DebugLevel =
|
||||
| boolean
|
||||
| Array<'eslint' | 'typescript' | 'typescript-eslint'>;
|
||||
|
||||
/**
|
||||
* This is a special exported interface for other packages to declare
|
||||
* additional parsers that should bail out for eslint parsers. For example
|
||||
* `'@typescript-eslint/eslint-plugin'` can declare it like so in its `d.ts`:
|
||||
*
|
||||
* ```ts
|
||||
* declare module 'eslint-define-config' {
|
||||
* export interface CustomParsers {
|
||||
* '@typescript-eslint/parser': void;
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface CustomParsers {}
|
||||
|
||||
/** Parser. */
|
||||
export type Parser = LiteralUnion<
|
||||
| 'babel-eslint'
|
||||
| '@typescript-eslint/parser'
|
||||
| 'jsonc-eslint-parser'
|
||||
| 'vue-eslint-parser'
|
||||
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
|
||||
| keyof CustomParsers
|
||||
>;
|
||||
|
||||
/**
|
||||
* This is a special exported interface for other packages to declare
|
||||
* additional parser options that should bail out for eslint parser options. For example
|
||||
* `@typescript-eslint/eslint-plugin` can declare it like so in its `d.ts`:
|
||||
*
|
||||
* ```ts
|
||||
* declare module 'eslint-define-config' {
|
||||
* export interface CustomParserOptions {
|
||||
* /**
|
||||
* * This option allows you to provide the root directory for relative tsconfig paths specified in the `project` option above.
|
||||
* *
|
||||
* * \@see [tsconfigRootDir](https://typescript-eslint.io/architecture/parser/#tsconfigrootdir)
|
||||
* *\/
|
||||
* tsconfigRootDir?: string;
|
||||
*
|
||||
* useJSXTextNode?: boolean;
|
||||
*
|
||||
* /**
|
||||
* * This option allows you to toggle the warning that the parser will give you if you use a version of TypeScript which is not explicitly supported.
|
||||
* *
|
||||
* * \@default true
|
||||
* *
|
||||
* * \@see [warnOnUnsupportedTypeScriptVersion](https://typescript-eslint.io/architecture/parser/#warnonunsupportedtypescriptversion)
|
||||
* *\/
|
||||
* warnOnUnsupportedTypeScriptVersion?: boolean;
|
||||
*
|
||||
* /**
|
||||
* * This option allow you to tell parser to act as if `emitDecoratorMetadata: true` is set in `tsconfig.json`, but without [type-aware linting](https://typescript-eslint.io/linting/typed-linting).
|
||||
* * In other words, you don't have to specify `parserOptions.project` in this case, making the linting process faster.
|
||||
* *
|
||||
* * \@default undefined
|
||||
* *
|
||||
* * \@see [emitDecoratorMetadata](https://typescript-eslint.io/architecture/parser/#emitdecoratormetadata)
|
||||
* *\/
|
||||
* emitDecoratorMetadata?: boolean;
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export interface CustomParserOptions {}
|
||||
|
||||
/**
|
||||
* Parser options.
|
||||
*
|
||||
* @see [Specifying Parser Options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options)
|
||||
*/
|
||||
export interface ParserOptions
|
||||
extends Partial<CustomParserOptions>,
|
||||
Partial<Record<string, unknown>> {
|
||||
/**
|
||||
* Accepts any valid ECMAScript version number or `'latest'`:
|
||||
*
|
||||
* - A version: es3, es5, es6, es7, es8, es9, es10, es11, es12, es13, es14, ..., or
|
||||
* - A year: es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, ..., or
|
||||
* - `'latest'`
|
||||
*
|
||||
* When it's a version or a year, the value must be a number - so do not include the `es` prefix.
|
||||
*
|
||||
* Specifies the version of ECMAScript syntax you want to use. This is used by the parser to determine how to perform scope analysis, and it affects the default
|
||||
*
|
||||
* @default 2018
|
||||
*
|
||||
* @see https://typescript-eslint.io/architecture/parser/#ecmaversion
|
||||
*/
|
||||
ecmaVersion?: EcmaVersion;
|
||||
|
||||
/**
|
||||
* Set to "script" (default) or "module" if your code is in ECMAScript modules.
|
||||
*
|
||||
* @default 'script'
|
||||
*
|
||||
* @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options
|
||||
*/
|
||||
sourceType?: SourceType;
|
||||
|
||||
/**
|
||||
* An object indicating which additional language features you'd like to use.
|
||||
*
|
||||
* @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options
|
||||
* @see https://typescript-eslint.io/architecture/parser#ecmafeatures
|
||||
*/
|
||||
ecmaFeatures?: EcmaFeatures;
|
||||
|
||||
/**
|
||||
* The identifier that's used for JSX Elements creation (after transpilation).
|
||||
* If you're using a library other than React (like `preact`), then you should change this value.
|
||||
* If you are using the [new JSX transform](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) you can set this to `null`.
|
||||
*
|
||||
* This should not be a member expression - just the root identifier (i.e. use `"React"` instead of `"React.createElement"`).
|
||||
*
|
||||
* If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
|
||||
*
|
||||
* @default 'React'
|
||||
*
|
||||
* @see [jsxPragma](https://typescript-eslint.io/architecture/parser#jsxpragma)
|
||||
*/
|
||||
jsxPragma?: string;
|
||||
|
||||
/**
|
||||
* The identifier that's used for JSX fragment elements (after transpilation).
|
||||
* If `null`, assumes transpilation will always use a member of the configured `jsxPragma`.
|
||||
* This should not be a member expression - just the root identifier (i.e. use `"h"` instead of `"h.Fragment"`).
|
||||
*
|
||||
* If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
|
||||
*
|
||||
* @default null
|
||||
*
|
||||
* @see [jsxFragmentName](https://typescript-eslint.io/architecture/parser#jsxfragmentname)
|
||||
*/
|
||||
jsxFragmentName?: string | null;
|
||||
|
||||
/**
|
||||
* For valid options, see the [TypeScript compiler options](https://www.typescriptlang.org/tsconfig#lib).
|
||||
*
|
||||
* Specifies the TypeScript `libs` that are available.
|
||||
* This is used by the scope analyser to ensure there are global variables declared for the types exposed by TypeScript.
|
||||
*
|
||||
* If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
|
||||
*
|
||||
* @default ['es2018']
|
||||
*
|
||||
* @see [lib](https://typescript-eslint.io/architecture/parser/#lib)
|
||||
*/
|
||||
lib?: Lib[];
|
||||
|
||||
comment?: boolean;
|
||||
|
||||
debugLevel?: DebugLevel;
|
||||
|
||||
errorOnTypeScriptSyntacticAndSemanticIssues?: boolean;
|
||||
|
||||
errorOnUnknownASTType?: boolean;
|
||||
|
||||
/**
|
||||
* This option allows you to provide one or more additional file extensions which should be considered in the TypeScript Program compilation.
|
||||
*
|
||||
* The default extensions are `.ts`, `.tsx`, `.js`, and `.jsx`. Add extensions starting with `.`, followed by the file extension.
|
||||
* E.g. for a `.vue` file use `"extraFileExtensions: [".vue"]`.
|
||||
*
|
||||
* @see [extraFileExtensions](https://typescript-eslint.io/architecture/parser/#extrafileextensions)
|
||||
*/
|
||||
extraFileExtensions?: string[];
|
||||
|
||||
filePath?: string;
|
||||
|
||||
loc?: boolean;
|
||||
|
||||
/**
|
||||
* Parser.
|
||||
*
|
||||
* @see [Working with Custom Parsers](https://eslint.org/docs/developer-guide/working-with-custom-parsers)
|
||||
* @see [Specifying Parser](https://eslint.org/docs/user-guide/configuring/plugins#specifying-parser)
|
||||
*/
|
||||
parser?: Parser;
|
||||
|
||||
/**
|
||||
* This option allows you to provide a path to your project's `tsconfig.json`.
|
||||
* **This setting is required if you want to use rules which require type information.**
|
||||
* Relative paths are interpreted relative to the current working directory if `tsconfigRootDir` is not set.
|
||||
* If you intend on running ESLint from directories other than the project root, you should consider using `tsconfigRootDir`.
|
||||
*
|
||||
* @default undefined
|
||||
*
|
||||
* @see [project](https://typescript-eslint.io/architecture/parser/#project)
|
||||
*/
|
||||
project?: string | string[] | true | null;
|
||||
|
||||
/**
|
||||
* This option allows you to ignore folders from being included in your provided list of `project`s.
|
||||
* This is useful if you have configured glob patterns, but want to make sure you ignore certain folders.
|
||||
*
|
||||
* It accepts an array of globs to exclude from the `project` globs.
|
||||
*
|
||||
* For example, by default it will ensure that a glob like `./**/tsconfig.json` will not match any `tsconfigs` within your `node_modules` folder (some npm packages do not exclude their source files from their published packages).
|
||||
*
|
||||
* @default ['**/node_modules/**']
|
||||
*
|
||||
* @see [projectFolderIgnoreList](https://typescript-eslint.io/architecture/parser/#projectfolderignorelist)
|
||||
*/
|
||||
projectFolderIgnoreList?: Array<string | RegExp>;
|
||||
|
||||
range?: boolean;
|
||||
|
||||
tokens?: boolean;
|
||||
|
||||
/**
|
||||
* This option allows you to provide the root directory for relative tsconfig paths specified in the `project` option above.
|
||||
*
|
||||
* @see [tsconfigRootDir](https://typescript-eslint.io/architecture/parser/#tsconfigrootdir)
|
||||
*/
|
||||
tsconfigRootDir?: string;
|
||||
|
||||
useJSXTextNode?: boolean;
|
||||
|
||||
/**
|
||||
* This option allows you to toggle the warning that the parser will give you if you use a version of TypeScript which is not explicitly supported.
|
||||
*
|
||||
* @default true
|
||||
*
|
||||
* @see [warnOnUnsupportedTypeScriptVersion](https://typescript-eslint.io/architecture/parser/#warnonunsupportedtypescriptversion)
|
||||
*/
|
||||
warnOnUnsupportedTypeScriptVersion?: boolean;
|
||||
|
||||
/**
|
||||
* This option allow you to tell parser to act as if `emitDecoratorMetadata: true` is set in `tsconfig.json`, but without [type-aware linting](https://typescript-eslint.io/linting/typed-linting).
|
||||
* In other words, you don't have to specify `parserOptions.project` in this case, making the linting process faster.
|
||||
*
|
||||
* @default undefined
|
||||
*
|
||||
* @see [emitDecoratorMetadata](https://typescript-eslint.io/architecture/parser/#emitdecoratormetadata)
|
||||
*/
|
||||
emitDecoratorMetadata?: boolean;
|
||||
|
||||
/**
|
||||
* @see [vueFeatures](https://github.com/vuejs/vue-eslint-parser#parseroptionsvuefeatures)
|
||||
*/
|
||||
vueFeatures?: {
|
||||
/**
|
||||
* You can use `parserOptions.vueFeatures.filter` property to specify whether to parse the Vue2 filter.
|
||||
*
|
||||
* If you specify `false`, the parser does not parse `|` as a filter.
|
||||
*
|
||||
* @see [filter](https://github.com/vuejs/vue-eslint-parser#parseroptionsvuefeaturesfilter)
|
||||
*/
|
||||
filter?: boolean;
|
||||
|
||||
/**
|
||||
* You can use `parserOptions.vueFeatures.interpolationAsNonHTML` property to specify whether to parse the interpolation as HTML.
|
||||
*
|
||||
* If you specify `true`, the parser handles the interpolation as non-HTML (However, you can use HTML escaping in the interpolation).
|
||||
*
|
||||
* @see [interpolationAsNonHTML](https://github.com/vuejs/vue-eslint-parser#parseroptionsvuefeaturesinterpolationasnonhtml)
|
||||
*/
|
||||
interpolationAsNonHTML?: boolean;
|
||||
};
|
||||
|
||||
/**
|
||||
* @see [templateTokenizer](https://github.com/rashfael/eslint-plugin-vue-pug#usage)
|
||||
*/
|
||||
templateTokenizer?: {
|
||||
pug?: LiteralUnion<'vue-eslint-parser-template-tokenizer-pug'>;
|
||||
};
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user