@seanblonien/eslint-config-react 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -9
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -50,22 +50,22 @@ export default [
|
|
|
50
50
|
|
|
51
51
|
### Next.js Projects
|
|
52
52
|
|
|
53
|
-
Use the `configWithNext` named export for Next.js projects (includes Next.js recommended rules and Core Web Vitals):
|
|
53
|
+
Use the `configWithNext` named export for Next.js projects (includes Next.js recommended rules and Core Web Vitals). This helper is **async**, so your `eslint.config.ts` must support top-level `await` (ESLint 9+ flat config):
|
|
54
54
|
|
|
55
55
|
```ts
|
|
56
56
|
// eslint.config.ts
|
|
57
57
|
import { configWithNext } from '@seanblonien/eslint-config-react';
|
|
58
58
|
|
|
59
59
|
export default [
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
60
|
+
...(await configWithNext()),
|
|
61
|
+
{
|
|
62
|
+
rules: {
|
|
63
|
+
// Override rules as needed
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
ignores: ['dist/**', 'build/**', '.next/**'],
|
|
68
|
+
},
|
|
69
69
|
];
|
|
70
70
|
```
|
|
71
71
|
|
package/dist/index.d.ts
CHANGED
|
@@ -9,9 +9,9 @@ declare const config: Linter.Config[];
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* import { configWithNext } from '@seanblonien/eslint-config-react';
|
|
11
11
|
*
|
|
12
|
-
* export default
|
|
12
|
+
* export default await configWithNext();
|
|
13
13
|
* ```
|
|
14
14
|
*/
|
|
15
|
-
declare const configWithNext: () => Linter.Config[]
|
|
15
|
+
declare const configWithNext: () => Promise<Linter.Config[]>;
|
|
16
16
|
|
|
17
17
|
export { configWithNext, config as default };
|
package/dist/index.js
CHANGED
|
@@ -1,10 +1,3 @@
|
|
|
1
|
-
var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
|
|
2
|
-
get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
|
|
3
|
-
}) : x)(function(x) {
|
|
4
|
-
if (typeof require !== "undefined") return require.apply(this, arguments);
|
|
5
|
-
throw Error('Dynamic require of "' + x + '" is not supported');
|
|
6
|
-
});
|
|
7
|
-
|
|
8
1
|
// src/index.ts
|
|
9
2
|
import baseConfig, { booleanNameConvention } from "@seanblonien/eslint-config-base";
|
|
10
3
|
import jsxA11y from "eslint-plugin-jsx-a11y";
|
|
@@ -126,9 +119,10 @@ var config = [
|
|
|
126
119
|
}
|
|
127
120
|
}
|
|
128
121
|
];
|
|
129
|
-
var configWithNext = () => {
|
|
122
|
+
var configWithNext = async () => {
|
|
130
123
|
try {
|
|
131
|
-
const
|
|
124
|
+
const mod = await import("@next/eslint-plugin-next");
|
|
125
|
+
const nextPlugin = "default" in mod ? mod.default : mod;
|
|
132
126
|
return [
|
|
133
127
|
...config,
|
|
134
128
|
{
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention -- config file */\nimport baseConfig, { booleanNameConvention } from '@seanblonien/eslint-config-base';\n// @ts-expect-error - no types available\nimport jsxA11y from 'eslint-plugin-jsx-a11y';\nimport reactPlugin from 'eslint-plugin-react';\nimport reactCompilerPlugin from 'eslint-plugin-react-compiler';\nimport reactHooks from 'eslint-plugin-react-hooks';\nimport reactHooksAddonsPlugin from 'eslint-plugin-react-hooks-addons';\nimport type { Linter } from 'eslint';\n\nconst config: Linter.Config[] = [\n // Spread base config\n ...baseConfig,\n\n // React compiler and hooks addons\n reactCompilerPlugin.configs.recommended,\n reactHooksAddonsPlugin.configs.recommended,\n reactPlugin.configs.flat.recommended,\n (reactHooks.configs as unknown as { flat: { recommended: Linter.Config } }\n ).flat.recommended,\n // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- incorrect type definition from package\n jsxA11y.flatConfigs.recommended as Linter.Config,\n\n // React plugin configuration\n {\n files: ['**/*.{tsx,jsx}'],\n languageOptions: {\n globals: {\n React: 'readonly',\n },\n parserOptions: {\n ecmaFeatures: {\n jsx: true,\n },\n },\n },\n settings: {\n react: {\n version: 'detect',\n },\n },\n rules: {\n // TS rule overrides for JSX files\n '@typescript-eslint/no-magic-numbers': 'off',\n '@typescript-eslint/restrict-template-expressions': 'off',\n '@typescript-eslint/no-use-before-define': 'off',\n 'unicorn/filename-case': [\n 'warn',\n {\n cases: { pascalCase: true, kebabCase: true },\n },\n ],\n 'padding-line-between-statements': [\n 'warn',\n { blankLine: 'always', prev: '*', next: 'return' },\n ],\n\n // --- React Rules ---\n // General React rules\n 'react/style-prop-object': 'off', // Keep off for RN\n 'react/prop-types': 'off',\n 'react/react-in-jsx-scope': 'off', // Not needed with new JSX transform\n 'react/no-multi-comp': ['error', { ignoreStateless: true }],\n 'react/no-array-index-key': 'warn',\n 'react/void-dom-elements-no-children': 'error',\n 'react/destructuring-assignment': ['warn', 'always'],\n 'react/boolean-prop-naming': ['warn', { rule: booleanNameConvention }],\n\n // Component definition rules\n 'react/function-component-definition': ['error', { namedComponents: 'arrow-function' }],\n 'react/jsx-filename-extension': ['error', { extensions: ['.tsx'] }],\n 'react/self-closing-comp': 'warn',\n\n // JSX formatting rules\n 'react/jsx-curly-brace-presence': 'warn',\n 'react/jsx-closing-bracket-location': ['warn', 'line-aligned'],\n 'react/jsx-no-useless-fragment': ['warn', { allowExpressions: true }],\n 'react/jsx-first-prop-new-line': ['warn'],\n 'react/jsx-tag-spacing': ['warn', { beforeClosing: 'never' }],\n 'react/jsx-key': 'error',\n 'react/jsx-max-depth': ['error', { max: 6 }],\n 'react/jsx-no-comment-textnodes': 'warn',\n 'react/jsx-boolean-value': ['error', 'never'],\n 'react/jsx-props-no-multi-spaces': 'error',\n\n // JSX multiline formatting\n '@stylistic/multiline-ternary': ['warn', 'always-multiline', { ignoreJSX: true }],\n '@stylistic/jsx-wrap-multilines': [\n 'warn',\n {\n declaration: 'parens-new-line',\n assignment: 'parens-new-line',\n return: 'parens-new-line',\n arrow: 'parens-new-line',\n condition: 'ignore',\n logical: 'ignore',\n prop: 'ignore',\n },\n ],\n\n // Props handling rules\n 'react/jsx-sort-props': ['warn', { shorthandFirst: true, callbacksLast: true, reservedFirst: true }],\n 'react/jsx-props-no-spreading': [\n 'error',\n {\n exceptions: [\n 'ScrollView',\n 'Component',\n 'Container',\n 'Screen',\n 'AppProvider',\n 'Checkbox.Item',\n 'TextInputPaper',\n 'StatusIcon',\n 'CircularProgressBase',\n 'CircularProgress',\n ],\n },\n ],\n\n // --- React Hooks Rules ---\n 'react-hooks-addons/no-unused-deps': 'warn',\n 'react-hooks/exhaustive-deps': [\n 'warn',\n {\n additionalHooks:\n '(useEffectIgnoreFirstRender|useAsyncEffect|useEffectDebounce|useEffectIgnoreFirstRender|useEffectInterval|useMemoCache|useMemoCacheKey|useMemoTiming|useCallbackThrottle)',\n },\n ],\n },\n },\n];\n\n/**\n * React ESLint config with Next.js plugin support.\n * Requires @next/eslint-plugin-next to be installed as a peer dependency.\n *\n * @example\n * ```ts\n * import { configWithNext } from '@seanblonien/eslint-config-react';\n *\n * export default
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention -- config file */\nimport baseConfig, { booleanNameConvention } from '@seanblonien/eslint-config-base';\n// @ts-expect-error - no types available\nimport jsxA11y from 'eslint-plugin-jsx-a11y';\nimport reactPlugin from 'eslint-plugin-react';\nimport reactCompilerPlugin from 'eslint-plugin-react-compiler';\nimport reactHooks from 'eslint-plugin-react-hooks';\nimport reactHooksAddonsPlugin from 'eslint-plugin-react-hooks-addons';\nimport type { Linter } from 'eslint';\n\nconst config: Linter.Config[] = [\n // Spread base config\n ...baseConfig,\n\n // React compiler and hooks addons\n reactCompilerPlugin.configs.recommended,\n reactHooksAddonsPlugin.configs.recommended,\n reactPlugin.configs.flat.recommended,\n (reactHooks.configs as unknown as { flat: { recommended: Linter.Config } }\n ).flat.recommended,\n // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- incorrect type definition from package\n jsxA11y.flatConfigs.recommended as Linter.Config,\n\n // React plugin configuration\n {\n files: ['**/*.{tsx,jsx}'],\n languageOptions: {\n globals: {\n React: 'readonly',\n },\n parserOptions: {\n ecmaFeatures: {\n jsx: true,\n },\n },\n },\n settings: {\n react: {\n version: 'detect',\n },\n },\n rules: {\n // TS rule overrides for JSX files\n '@typescript-eslint/no-magic-numbers': 'off',\n '@typescript-eslint/restrict-template-expressions': 'off',\n '@typescript-eslint/no-use-before-define': 'off',\n 'unicorn/filename-case': [\n 'warn',\n {\n cases: { pascalCase: true, kebabCase: true },\n },\n ],\n 'padding-line-between-statements': [\n 'warn',\n { blankLine: 'always', prev: '*', next: 'return' },\n ],\n\n // --- React Rules ---\n // General React rules\n 'react/style-prop-object': 'off', // Keep off for RN\n 'react/prop-types': 'off',\n 'react/react-in-jsx-scope': 'off', // Not needed with new JSX transform\n 'react/no-multi-comp': ['error', { ignoreStateless: true }],\n 'react/no-array-index-key': 'warn',\n 'react/void-dom-elements-no-children': 'error',\n 'react/destructuring-assignment': ['warn', 'always'],\n 'react/boolean-prop-naming': ['warn', { rule: booleanNameConvention }],\n\n // Component definition rules\n 'react/function-component-definition': ['error', { namedComponents: 'arrow-function' }],\n 'react/jsx-filename-extension': ['error', { extensions: ['.tsx'] }],\n 'react/self-closing-comp': 'warn',\n\n // JSX formatting rules\n 'react/jsx-curly-brace-presence': 'warn',\n 'react/jsx-closing-bracket-location': ['warn', 'line-aligned'],\n 'react/jsx-no-useless-fragment': ['warn', { allowExpressions: true }],\n 'react/jsx-first-prop-new-line': ['warn'],\n 'react/jsx-tag-spacing': ['warn', { beforeClosing: 'never' }],\n 'react/jsx-key': 'error',\n 'react/jsx-max-depth': ['error', { max: 6 }],\n 'react/jsx-no-comment-textnodes': 'warn',\n 'react/jsx-boolean-value': ['error', 'never'],\n 'react/jsx-props-no-multi-spaces': 'error',\n\n // JSX multiline formatting\n '@stylistic/multiline-ternary': ['warn', 'always-multiline', { ignoreJSX: true }],\n '@stylistic/jsx-wrap-multilines': [\n 'warn',\n {\n declaration: 'parens-new-line',\n assignment: 'parens-new-line',\n return: 'parens-new-line',\n arrow: 'parens-new-line',\n condition: 'ignore',\n logical: 'ignore',\n prop: 'ignore',\n },\n ],\n\n // Props handling rules\n 'react/jsx-sort-props': ['warn', { shorthandFirst: true, callbacksLast: true, reservedFirst: true }],\n 'react/jsx-props-no-spreading': [\n 'error',\n {\n exceptions: [\n 'ScrollView',\n 'Component',\n 'Container',\n 'Screen',\n 'AppProvider',\n 'Checkbox.Item',\n 'TextInputPaper',\n 'StatusIcon',\n 'CircularProgressBase',\n 'CircularProgress',\n ],\n },\n ],\n\n // --- React Hooks Rules ---\n 'react-hooks-addons/no-unused-deps': 'warn',\n 'react-hooks/exhaustive-deps': [\n 'warn',\n {\n additionalHooks:\n '(useEffectIgnoreFirstRender|useAsyncEffect|useEffectDebounce|useEffectIgnoreFirstRender|useEffectInterval|useMemoCache|useMemoCacheKey|useMemoTiming|useCallbackThrottle)',\n },\n ],\n },\n },\n];\n\ntype NextPlugin = {\n configs: {\n 'core-web-vitals': Linter.Config;\n 'recommended': Linter.Config;\n };\n};\n\n/**\n * React ESLint config with Next.js plugin support.\n * Requires @next/eslint-plugin-next to be installed as a peer dependency.\n *\n * @example\n * ```ts\n * import { configWithNext } from '@seanblonien/eslint-config-react';\n *\n * export default await configWithNext();\n * ```\n */\nexport const configWithNext = async (): Promise<Linter.Config[]> => {\n try {\n const mod = (await import('@next/eslint-plugin-next')) as NextPlugin | { default: NextPlugin };\n const nextPlugin: NextPlugin = 'default' in mod ? mod.default : mod;\n\n return [\n ...config,\n {\n plugins: {\n '@next/next': nextPlugin,\n },\n rules: {\n ...nextPlugin.configs.recommended.rules,\n ...nextPlugin.configs['core-web-vitals'].rules,\n },\n },\n ];\n } catch {\n throw new Error(\n '@next/eslint-plugin-next is required to use configWithNext. ' +\n 'Install it with: pnpm add -D @next/eslint-plugin-next',\n );\n }\n};\n\nexport default config;\n\n/* eslint-enable @typescript-eslint/naming-convention */\n"],"mappings":";AACA,OAAO,cAAc,6BAA6B;AAElD,OAAO,aAAa;AACpB,OAAO,iBAAiB;AACxB,OAAO,yBAAyB;AAChC,OAAO,gBAAgB;AACvB,OAAO,4BAA4B;AAGnC,IAAM,SAA0B;AAAA;AAAA,EAE9B,GAAG;AAAA;AAAA,EAGH,oBAAoB,QAAQ;AAAA,EAC5B,uBAAuB,QAAQ;AAAA,EAC/B,YAAY,QAAQ,KAAK;AAAA,EACxB,WAAW,QACV,KAAK;AAAA;AAAA,EAEP,QAAQ,YAAY;AAAA;AAAA,EAGpB;AAAA,IACE,OAAO,CAAC,gBAAgB;AAAA,IACxB,iBAAiB;AAAA,MACf,SAAS;AAAA,QACP,OAAO;AAAA,MACT;AAAA,MACA,eAAe;AAAA,QACb,cAAc;AAAA,UACZ,KAAK;AAAA,QACP;AAAA,MACF;AAAA,IACF;AAAA,IACA,UAAU;AAAA,MACR,OAAO;AAAA,QACL,SAAS;AAAA,MACX;AAAA,IACF;AAAA,IACA,OAAO;AAAA;AAAA,MAEL,uCAAuC;AAAA,MACvC,oDAAoD;AAAA,MACpD,2CAA2C;AAAA,MAC3C,yBAAyB;AAAA,QACvB;AAAA,QACA;AAAA,UACE,OAAO,EAAE,YAAY,MAAM,WAAW,KAAK;AAAA,QAC7C;AAAA,MACF;AAAA,MACA,mCAAmC;AAAA,QACjC;AAAA,QACA,EAAE,WAAW,UAAU,MAAM,KAAK,MAAM,SAAS;AAAA,MACnD;AAAA;AAAA;AAAA,MAIA,2BAA2B;AAAA;AAAA,MAC3B,oBAAoB;AAAA,MACpB,4BAA4B;AAAA;AAAA,MAC5B,uBAAuB,CAAC,SAAS,EAAE,iBAAiB,KAAK,CAAC;AAAA,MAC1D,4BAA4B;AAAA,MAC5B,uCAAuC;AAAA,MACvC,kCAAkC,CAAC,QAAQ,QAAQ;AAAA,MACnD,6BAA6B,CAAC,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAAA;AAAA,MAGrE,uCAAuC,CAAC,SAAS,EAAE,iBAAiB,iBAAiB,CAAC;AAAA,MACtF,gCAAgC,CAAC,SAAS,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC;AAAA,MAClE,2BAA2B;AAAA;AAAA,MAG3B,kCAAkC;AAAA,MAClC,sCAAsC,CAAC,QAAQ,cAAc;AAAA,MAC7D,iCAAiC,CAAC,QAAQ,EAAE,kBAAkB,KAAK,CAAC;AAAA,MACpE,iCAAiC,CAAC,MAAM;AAAA,MACxC,yBAAyB,CAAC,QAAQ,EAAE,eAAe,QAAQ,CAAC;AAAA,MAC5D,iBAAiB;AAAA,MACjB,uBAAuB,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC;AAAA,MAC3C,kCAAkC;AAAA,MAClC,2BAA2B,CAAC,SAAS,OAAO;AAAA,MAC5C,mCAAmC;AAAA;AAAA,MAGnC,gCAAgC,CAAC,QAAQ,oBAAoB,EAAE,WAAW,KAAK,CAAC;AAAA,MAChF,kCAAkC;AAAA,QAChC;AAAA,QACA;AAAA,UACE,aAAa;AAAA,UACb,YAAY;AAAA,UACZ,QAAQ;AAAA,UACR,OAAO;AAAA,UACP,WAAW;AAAA,UACX,SAAS;AAAA,UACT,MAAM;AAAA,QACR;AAAA,MACF;AAAA;AAAA,MAGA,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,MAAM,eAAe,MAAM,eAAe,KAAK,CAAC;AAAA,MACnG,gCAAgC;AAAA,QAC9B;AAAA,QACA;AAAA,UACE,YAAY;AAAA,YACV;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA;AAAA,MAGA,qCAAqC;AAAA,MACrC,+BAA+B;AAAA,QAC7B;AAAA,QACA;AAAA,UACE,iBACE;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAoBO,IAAM,iBAAiB,YAAsC;AAClE,MAAI;AACF,UAAM,MAAO,MAAM,OAAO,0BAA0B;AACpD,UAAM,aAAyB,aAAa,MAAM,IAAI,UAAU;AAEhE,WAAO;AAAA,MACL,GAAG;AAAA,MACH;AAAA,QACE,SAAS;AAAA,UACP,cAAc;AAAA,QAChB;AAAA,QACA,OAAO;AAAA,UACL,GAAG,WAAW,QAAQ,YAAY;AAAA,UAClC,GAAG,WAAW,QAAQ,iBAAiB,EAAE;AAAA,QAC3C;AAAA,MACF;AAAA,IACF;AAAA,EACF,QAAQ;AACN,UAAM,IAAI;AAAA,MACR;AAAA,IAEF;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":[]}
|