@heyq02/rslint-config 0.0.1 → 0.0.2

package/dist/index.js

@@ -0,0 +1,665 @@
+import { globalIgnores, globals, importPlugin, jestPlugin, js, jsxA11yPlugin, nodePlugin, promisePlugin, reactHooksPlugin, reactPlugin, rstestPlugin, ts, unicornPlugin } from "@rslint/core";
+import { createRequire } from "node:module";
+import node_process from "node:process";
+const GLOB_SRC_EXT = '?([cm])[jt]s?(x)';
+const GLOB_SRC = `**/*.${GLOB_SRC_EXT}`;
+const GLOB_JS = '**/*.?([cm])js';
+const GLOB_JSX = '**/*.jsx';
+const GLOB_TS = '**/*.?([cm])ts';
+const GLOB_TSX = '**/*.tsx';
+const GLOB_TESTS = [
+    `**/__tests__/**/*.${GLOB_SRC_EXT}`,
+    `**/*.spec.${GLOB_SRC_EXT}`,
+    `**/*.test.${GLOB_SRC_EXT}`,
+    `**/*.bench.${GLOB_SRC_EXT}`,
+    `**/*.benchmark.${GLOB_SRC_EXT}`
+];
+const GLOB_NODE_MODULES = '**/node_modules';
+const GLOB_DIST = '**/dist';
+const GLOB_LOCKFILE = [
+    '**/package-lock.json',
+    '**/yarn.lock',
+    '**/pnpm-lock.yaml',
+    '**/bun.lock',
+    '**/bun.lockb'
+];
+const GLOB_EXCLUDE = [
+    GLOB_NODE_MODULES,
+    GLOB_DIST,
+    ...GLOB_LOCKFILE,
+    '**/coverage',
+    '**/temp',
+    '**/tmp',
+    '**/fixtures',
+    '**/output',
+    '**/.vitepress/cache',
+    '**/.nuxt',
+    '**/.next',
+    '**/.vercel',
+    '**/.changeset',
+    '**/.idea',
+    '**/.output',
+    '**/.vite-inspect',
+    '**/.nitro',
+    '**/.turbo',
+    '**/CHANGELOG*.md',
+    '**/*.min.*',
+    '**/LICENSE*',
+    '**/__snapshots__',
+    '**/auto-import?(s).d.ts',
+    '**/components.d.ts'
+];
+const ignores = (extra = [])=>[
+        {
+            ...globalIgnores([
+                ...GLOB_EXCLUDE,
+                ...extra
+            ]),
+            name: 'heyq02/global-ignores'
+        }
+    ];
+const imports = (options = {})=>[
+        {
+            ...importPlugin.configs.recommended,
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/imports/recommended'
+        },
+        {
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/imports',
+            rules: {
+                'import/first': 'error',
+                'import/no-default-export': 'error',
+                'import/no-duplicates': [
+                    'error',
+                    {
+                        'prefer-inline': true
+                    }
+                ],
+                'import/no-mutable-exports': 'error',
+                'import/no-named-default': 'error',
+                ...options.typescript ? {
+                    'import/default': 'off',
+                    'import/named': 'off',
+                    'import/namespace': 'off',
+                    'import/no-unresolved': 'off'
+                } : {}
+            }
+        }
+    ];
+const restrictedSyntaxJs = [
+    'ForInStatement',
+    'LabeledStatement'
+];
+const javascript = ()=>[
+        {
+            ...js.configs.recommended,
+            name: 'heyq02/js/recommended'
+        },
+        {
+            files: [
+                GLOB_SRC
+            ],
+            languageOptions: {
+                ecmaVersion: 'latest',
+                globals: {
+                    ...globals.browser,
+                    ...globals.es2026,
+                    ...globals.nodeBuiltin
+                },
+                sourceType: 'module'
+            },
+            name: 'heyq02/js',
+            rules: {
+                'array-callback-return': 'error',
+                'block-scoped-var': 'error',
+                'dot-notation': 'warn',
+                eqeqeq: [
+                    'error',
+                    'smart'
+                ],
+                'no-alert': 'warn',
+                'no-console': [
+                    'warn',
+                    {
+                        allow: [
+                            'warn',
+                            'error',
+                            'info',
+                            'clear'
+                        ]
+                    }
+                ],
+                'no-debugger': 'warn',
+                'no-duplicate-imports': 'error',
+                'no-empty': [
+                    'error',
+                    {
+                        allowEmptyCatch: true
+                    }
+                ],
+                'no-fallthrough': [
+                    'warn',
+                    {
+                        commentPattern: String.raw`break[\s\w]*omitted`
+                    }
+                ],
+                'no-inner-declarations': 'error',
+                'no-lonely-if': 'error',
+                'no-multi-str': 'error',
+                'no-restricted-syntax': [
+                    'error',
+                    ...restrictedSyntaxJs
+                ],
+                'no-unused-expressions': [
+                    'error',
+                    {
+                        allowShortCircuit: true,
+                        allowTaggedTemplates: true,
+                        allowTernary: true
+                    }
+                ],
+                'no-unused-vars': [
+                    'error',
+                    {
+                        args: 'after-used',
+                        argsIgnorePattern: '^_',
+                        ignoreRestSiblings: true,
+                        varsIgnorePattern: '^_'
+                    }
+                ],
+                'no-useless-call': 'error',
+                'no-useless-computed-key': 'error',
+                'no-useless-constructor': 'error',
+                'no-useless-rename': 'error',
+                'no-var': 'error',
+                'no-void': 'error',
+                'object-shorthand': [
+                    'error',
+                    'always',
+                    {
+                        avoidQuotes: true,
+                        ignoreConstructors: false
+                    }
+                ],
+                'one-var': [
+                    'error',
+                    {
+                        initialized: 'never'
+                    }
+                ],
+                'prefer-arrow-callback': [
+                    'error',
+                    {
+                        allowNamedFunctions: false,
+                        allowUnboundThis: true
+                    }
+                ],
+                'prefer-const': [
+                    'warn',
+                    {
+                        destructuring: 'all',
+                        ignoreReadBeforeAssign: true
+                    }
+                ],
+                'prefer-exponentiation-operator': 'error',
+                'prefer-regex-literals': [
+                    'error',
+                    {
+                        disallowRedundantWrapping: true
+                    }
+                ],
+                'prefer-rest-params': 'error',
+                'prefer-spread': 'error',
+                'prefer-template': 'error',
+                'require-await': 'error',
+                'unicode-bom': [
+                    'error',
+                    'never'
+                ],
+                'use-isnan': [
+                    'error',
+                    {
+                        enforceForIndexOf: true,
+                        enforceForSwitchCase: true
+                    }
+                ],
+                'valid-typeof': [
+                    'error',
+                    {
+                        requireStringLiterals: true
+                    }
+                ],
+                'vars-on-top': 'error'
+            }
+        }
+    ];
+const jest = ()=>[
+        {
+            ...jestPlugin.configs.recommended,
+            files: [
+                ...GLOB_TESTS
+            ],
+            name: 'heyq02/jest/recommended'
+        },
+        {
+            ...jestPlugin.configs.style,
+            files: [
+                ...GLOB_TESTS
+            ],
+            name: 'heyq02/jest/style'
+        }
+    ];
+const node = (preset = 'module')=>{
+    if ('mixed' === preset) return nodePlugin.configs.recommended.map((entry, index)=>({
+            ...entry,
+            name: entry.name ?? `heyq02/node/recommended-${index}`
+        }));
+    if ("script" === preset) return [
+        {
+            ...nodePlugin.configs.recommendedScript,
+            files: [
+                GLOB_SRC
+            ],
+            name: "heyq02/node/recommended-script"
+        }
+    ];
+    return [
+        {
+            ...nodePlugin.configs.recommendedModule,
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/node/recommended-module'
+        },
+        {
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/node',
+            plugins: [
+                'node'
+            ],
+            rules: {
+                'node/handle-callback-err': [
+                    'error',
+                    '^(err|error)$'
+                ],
+                'node/no-deprecated-api': 'error',
+                'node/no-exports-assign': 'error',
+                'node/no-new-require': 'error',
+                'node/no-path-concat': 'error',
+                'node/prefer-global/buffer': [
+                    'error',
+                    'never'
+                ],
+                'node/prefer-global/process': [
+                    'error',
+                    'never'
+                ],
+                'node/process-exit-as-throw': 'error'
+            }
+        }
+    ];
+};
+const promise = ()=>[
+        {
+            ...promisePlugin.configs.recommended,
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/promise/recommended'
+        },
+        {
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/promise',
+            rules: {
+                'promise/always-return': 'off',
+                'promise/catch-or-return': 'off',
+                'promise/no-nesting': 'off'
+            }
+        }
+    ];
+const reactFiles = [
+    GLOB_JSX,
+    GLOB_TSX,
+    '**/*.{jsx,tsx}'
+];
+const jsxA11y = ()=>[
+        {
+            ...jsxA11yPlugin.configs.recommended,
+            files: reactFiles,
+            name: 'heyq02/jsx-a11y/recommended'
+        }
+    ];
+const react = (options = {})=>{
+    const configs = [
+        {
+            ...reactPlugin.configs.recommended,
+            files: reactFiles,
+            name: 'heyq02/react/recommended'
+        },
+        {
+            ...reactHooksPlugin.configs.recommended,
+            files: reactFiles,
+            name: 'heyq02/react-hooks/recommended'
+        }
+    ];
+    if (false !== options.jsxA11y) configs.push(...jsxA11y());
+    return configs;
+};
+const rstest = ()=>[
+        {
+            ...rstestPlugin.configs.recommended,
+            files: [
+                ...GLOB_TESTS
+            ],
+            name: 'heyq02/rstest/recommended'
+        }
+    ];
+const specialCases = ()=>[
+        {
+            files: [
+                "**/scripts/*",
+                '**/cli.*',
+                '**/bin/**'
+            ],
+            name: 'heyq02/special/cli',
+            rules: {
+                'no-console': 'off'
+            }
+        },
+        {
+            files: [
+                `**/*.{test,spec}.${GLOB_SRC_EXT}`
+            ],
+            name: 'heyq02/special/tests',
+            rules: {
+                'no-unused-expressions': 'off',
+                "@typescript-eslint/no-unused-expressions": 'off'
+            }
+        },
+        {
+            files: [
+                `**/*config*.${GLOB_SRC_EXT}`,
+                `**/{views,pages,routes,middleware,plugins,api,modules}/${GLOB_SRC}`,
+                `**/{index,vite,esbuild,rollup,rolldown,webpack,rspack,farm,unloader,nuxt,rslint}.${GLOB_SRC_EXT}`,
+                '**/*.d.ts',
+                '**/.prettierrc*'
+            ],
+            name: 'heyq02/special/allow-default-export',
+            rules: {
+                'import/no-default-export': 'off'
+            }
+        },
+        {
+            files: [
+                '**/ISSUE_TEMPLATE/**'
+            ],
+            name: 'heyq02/special/github',
+            rules: {
+                'unicorn/filename-case': 'off'
+            }
+        },
+        {
+            files: [
+                GLOB_JSX,
+                GLOB_TSX
+            ],
+            name: 'heyq02/special/components',
+            rules: {
+                'unicorn/no-anonymous-default-export': 'off',
+                'import/no-default-export': 'off'
+            }
+        }
+    ];
+function resolveTypeScriptOptions(options) {
+    if (true === options) return {
+        typeChecked: false,
+        strict: false,
+        stylistic: true
+    };
+    return {
+        typeChecked: options.typeChecked ?? false,
+        strict: options.strict ?? false,
+        stylistic: options.stylistic ?? true,
+        projectService: options.projectService
+    };
+}
+const typescript = (options = true)=>{
+    const opts = resolveTypeScriptOptions(options);
+    const baseline = opts.strict && opts.typeChecked ? ts.configs.strictTypeChecked : opts.strict ? ts.configs.strict : opts.typeChecked ? ts.configs.recommendedTypeChecked : ts.configs.recommended;
+    const stylistic = opts.stylistic ? opts.typeChecked ? ts.configs.stylisticTypeChecked : ts.configs.stylistic : [];
+    const enableProjectService = opts.projectService ?? (opts.typeChecked ? true : void 0);
+    return [
+        ...baseline,
+        ...stylistic,
+        {
+            files: [
+                GLOB_TS,
+                GLOB_TSX
+            ],
+            name: "heyq02/typescript",
+            ...void 0 === enableProjectService ? {} : {
+                languageOptions: {
+                    parserOptions: {
+                        projectService: enableProjectService
+                    }
+                }
+            },
+            rules: {
+                "@typescript-eslint/ban-ts-comment": 'off',
+                "@typescript-eslint/consistent-type-assertions": [
+                    'error',
+                    {
+                        assertionStyle: 'as',
+                        objectLiteralTypeAssertions: 'allow-as-parameter'
+                    }
+                ],
+                "@typescript-eslint/consistent-type-imports": [
+                    'error',
+                    {
+                        disallowTypeAnnotations: false,
+                        fixStyle: 'inline-type-imports'
+                    }
+                ],
+                "@typescript-eslint/method-signature-style": [
+                    'error',
+                    'property'
+                ],
+                "@typescript-eslint/no-empty-object-type": 'off',
+                "@typescript-eslint/no-explicit-any": 'off',
+                "@typescript-eslint/no-import-type-side-effects": 'error',
+                "@typescript-eslint/no-non-null-assertion": 'off',
+                "@typescript-eslint/no-redeclare": 'error',
+                "@typescript-eslint/no-unused-expressions": [
+                    'error',
+                    {
+                        allowShortCircuit: true,
+                        allowTaggedTemplates: true,
+                        allowTernary: true
+                    }
+                ],
+                "@typescript-eslint/no-unused-vars": [
+                    'error',
+                    {
+                        args: 'after-used',
+                        argsIgnorePattern: '^_',
+                        ignoreRestSiblings: true,
+                        varsIgnorePattern: '^_'
+                    }
+                ],
+                "@typescript-eslint/no-useless-constructor": 'error',
+                "@typescript-eslint/prefer-as-const": 'warn',
+                "@typescript-eslint/prefer-literal-enum-member": [
+                    'error',
+                    {
+                        allowBitwiseExpressions: true
+                    }
+                ],
+                'no-restricted-syntax': [
+                    'error',
+                    ...restrictedSyntaxJs,
+                    'TSEnumDeclaration[const=true]'
+                ],
+                'no-unused-vars': 'off'
+            }
+        },
+        {
+            files: [
+                '**/*.d.ts'
+            ],
+            name: "heyq02/typescript/dts-rules",
+            rules: {
+                'import/no-duplicates': 'off',
+                'no-restricted-syntax': 'off'
+            }
+        },
+        {
+            files: [
+                GLOB_JS,
+                '**/*.cjs'
+            ],
+            name: "heyq02/typescript/cjs-rules",
+            rules: {
+                "@typescript-eslint/no-require-imports": 'off'
+            }
+        }
+    ];
+};
+const unicorn = ()=>[
+        {
+            ...unicornPlugin.configs.recommended,
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/unicorn/recommended'
+        },
+        {
+            files: [
+                GLOB_SRC
+            ],
+            name: 'heyq02/unicorn',
+            rules: {
+                'unicorn/filename-case': [
+                    'error',
+                    {
+                        cases: {
+                            kebabCase: true,
+                            pascalCase: true
+                        },
+                        ignore: [
+                            String.raw`^[A-Z]+\..*$`,
+                            String.raw`^[a-z]{2}-[A-Z]{2}$`,
+                            String.raw`import_map\.json`
+                        ]
+                    }
+                ],
+                'unicorn/no-null': 'off',
+                'unicorn/no-this-assignment': 'off',
+                'unicorn/prefer-ternary': 'off',
+                'unicorn/no-process-exit': 'off'
+            }
+        }
+    ];
+const env_require = createRequire(import.meta.url);
+const cwd = node_process.cwd();
+function isPackageExists(name) {
+    try {
+        env_require.resolve(name, {
+            paths: [
+                cwd
+            ]
+        });
+        return true;
+    } catch  {
+        return false;
+    }
+}
+const hasTypeScript = ()=>isPackageExists("typescript");
+const hasReact = ()=>isPackageExists('react') || isPackageExists('react-dom') || isPackageExists('next') || isPackageExists('preact') || isPackageExists('@remix-run/react');
+const hasJest = ()=>isPackageExists('jest') || isPackageExists('@jest/globals');
+const hasRstest = ()=>isPackageExists('rstest') || isPackageExists('@rstest/core') || isPackageExists('@rstest/adapter');
+function isInEditorEnv() {
+    if (node_process.env.CI) return false;
+    if (isInGitHooksOrLintStaged()) return false;
+    return !!(node_process.env.VSCODE_PID || node_process.env.VSCODE_CWD || node_process.env.JETBRAINS_IDE || node_process.env.VIM || node_process.env.NVIM);
+}
+function isInGitHooksOrLintStaged() {
+    return !!(node_process.env.GIT_PARAMS || node_process.env.VSCODE_GIT_COMMAND || node_process.env.npm_lifecycle_script?.startsWith('lint-staged'));
+}
+function flattenConfigs(...configs) {
+    const result = [];
+    for (const config of configs)if (config) {
+        if (Array.isArray(config)) {
+            result.push(...flattenConfigs(...config));
+            continue;
+        }
+        result.push(config);
+    }
+    return result;
+}
+function toArray(value) {
+    return Array.isArray(value) ? value : [
+        value
+    ];
+}
+const presetJavaScript = ()=>[
+        ...ignores(),
+        ...javascript(),
+        ...imports({
+            typescript: false
+        }),
+        ...unicorn(),
+        ...node(),
+        ...promise()
+    ];
+const presetBasic = (typescriptOptions = true)=>[
+        ...ignores(),
+        ...javascript(),
+        ...typescript(typescriptOptions),
+        ...imports({
+            typescript: true
+        }),
+        ...unicorn(),
+        ...node(),
+        ...promise()
+    ];
+const presetAll = ()=>heyq02({
+        typescript: true,
+        react: true,
+        jest: true,
+        rstest: true,
+        jsxA11y: true
+    });
+function heyq02(options = {}, ...userConfigs) {
+    const { ignores: extraIgnores = [], javascript: enableJavaScript = true, typescript: enableTypeScript = hasTypeScript(), unicorn: enableUnicorn = true, imports: enableImports = true, node: enableNode = true, promise: enablePromise = true, react: enableReact = hasReact(), jsxA11y: enableJsxA11y, jest: enableJest = hasJest(), rstest: enableRstest = hasRstest() } = options;
+    const configs = [
+        ...ignores(extraIgnores)
+    ];
+    if (enableJavaScript) configs.push(...javascript());
+    if (enableTypeScript) configs.push(...typescript(true === enableTypeScript ? true : enableTypeScript));
+    if (enableImports) configs.push(...imports({
+        typescript: Boolean(enableTypeScript)
+    }));
+    if (enableUnicorn) configs.push(...unicorn());
+    if (enableNode) configs.push(...node(true === enableNode ? 'module' : enableNode));
+    if (enablePromise) configs.push(...promise());
+    if (enableReact) configs.push(...react({
+        jsxA11y: enableJsxA11y ?? true
+    }));
+    else if (enableJsxA11y) configs.push(...jsxA11y());
+    if (enableJest) configs.push(...jest());
+    if (enableRstest) configs.push(...rstest());
+    configs.push(...specialCases());
+    configs.push(...flattenConfigs(...userConfigs));
+    return configs;
+}
+const rslintConfig = heyq02;
+export { GLOB_DIST, GLOB_EXCLUDE, GLOB_JS, GLOB_JSX, GLOB_LOCKFILE, GLOB_NODE_MODULES, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TS, GLOB_TSX, flattenConfigs, hasJest, hasReact, hasRstest, hasTypeScript, heyq02, ignores, imports, isInEditorEnv, isInGitHooksOrLintStaged, javascript, jest, jsxA11y, node, presetAll, presetBasic, presetJavaScript, promise, react, restrictedSyntaxJs, rslintConfig, rstest, specialCases, toArray, typescript, unicorn };

package/dist/presets.d.ts

@@ -0,0 +1,30 @@
+import type { Options, ResolvableConfig, TypeScriptOptions, TypedFlatConfig } from './types.js';
+/** Ignore common files and include JavaScript support. */
+export declare const presetJavaScript: () => TypedFlatConfig[];
+/** Includes `presetJavaScript` and TypeScript support. */
+export declare const presetBasic: (typescriptOptions?: true | TypeScriptOptions) => TypedFlatConfig[];
+/**
+ * Full opinionated preset:
+ * - JS + TS
+ * - Unicorn / import / node / promise
+ * - React / Jest / Rstest when detected
+ * - Special-case overrides
+ */
+export declare const presetAll: () => TypedFlatConfig[];
+/**
+ * `@heyq02`'s opinionated Rslint config preset.
+ *
+ * @example
+ * ```ts
+ * // rslint.config.ts
+ * import { heyq02 } from '@heyq02/rslint-config'
+ *
+ * export default heyq02({
+ *   typescript: { typeChecked: true, strict: true },
+ *   react: true,
+ * })
+ * ```
+ */
+export declare function heyq02(options?: Options, ...userConfigs: ResolvableConfig[]): TypedFlatConfig[];
+/** Alias of {@link heyq02}. */
+export declare const rslintConfig: typeof heyq02;