@jsse/eslint-config 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,257 @@
+import { MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, YmlRules, NRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, RuleConfig, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { ParserOptions } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginEslintComments } from 'eslint-plugin-eslint-comments';
+import * as eslintPluginI from 'eslint-plugin-i';
+export { eslintPluginI as pluginImport };
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
+export { eslintPluginJsonc as pluginJsonc };
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginReact } from 'eslint-plugin-react';
+export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
+import * as eslintPluginReactRefresh from 'eslint-plugin-react-refresh';
+export { eslintPluginReactRefresh as pluginReactRefresh };
+import * as eslintPluginSortKeys from 'eslint-plugin-sort-keys';
+export { eslintPluginSortKeys as pluginSortKeys };
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+
+type Rules = MergeIntersection<RenamePrefix<TypeScriptRules, "@typescript-eslint/", "ts/"> & RenamePrefix<VitestRules, "vitest/", "test/"> & RenamePrefix<YmlRules, "yml/", "yaml/"> & RenamePrefix<NRules, "n/", "node/"> & ImportRules & EslintRules & JsoncRules & VueRules & UnicornRules & EslintCommentsRules & {
+    "test/no-only-tests": RuleConfig;
+}>;
+type ConfigItem = Omit<FlatESLintConfigItem<Rules, false>, "plugins"> & {
+    /**
+     * Custom name of each config item
+     */
+    name?: string;
+    /**
+     * 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, any>;
+};
+type OptionsComponentExts = {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+};
+type OptionsTypeScriptParserOptions = {
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+};
+type OptionsTypeScriptWithTypes = {
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfigPath?: string;
+};
+type OptionsHasTypeScript = {
+    typescript?: boolean;
+};
+type OptionsStylistic = {
+    stylistic?: boolean | StylisticConfig;
+};
+type StylisticConfig = {
+    indent?: number | "tab";
+    quotes?: "single" | "double";
+    jsx?: boolean;
+};
+type OptionsPrefix = {
+    prefix?: {
+        from: string;
+        to: string;
+    };
+};
+type OptionsOverrides = {
+    overrides?: ConfigItem["rules"];
+};
+type OptionsIsInEditor = {
+    isInEditor?: boolean;
+};
+type OptionsReact = {
+    react?: boolean;
+    reactRefresh?: boolean;
+};
+type OptionsConfig = {
+    /**
+     * Enable debug mode.
+     */
+    debug?: boolean;
+    tailwind?: boolean;
+    off?: string[];
+    /**
+     * Enable gitignore support.
+     *
+     * Passing an object to configure the options.
+     *
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
+     * @default true
+     */
+    gitignore?: boolean | FlatGitignoreOptions;
+    tsPrefix?: string;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithTypes;
+    react?: boolean;
+    reactRefresh?: boolean;
+    /**
+     * Enable JSX related rules.
+     *
+     * Currently only stylistic rules are included.
+     *
+     * @default true
+     */
+    jsx?: boolean;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable Markdown support.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+    /**
+     * Provide overrides for rules for each integration.
+     */
+    overrides?: {
+        javascript?: ConfigItem["rules"];
+        typescript?: ConfigItem["rules"];
+        test?: ConfigItem["rules"];
+        vue?: ConfigItem["rules"];
+        jsonc?: ConfigItem["rules"];
+        markdown?: ConfigItem["rules"];
+        yaml?: ConfigItem["rules"];
+    };
+} & OptionsComponentExts;
+
+declare function comments(): ConfigItem[];
+
+declare function ignores(): ConfigItem[];
+
+declare function imports(options?: OptionsStylistic): ConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides & {
+    reportUnusedDisableDirectives?: boolean;
+}): ConfigItem[];
+
+declare function jsdoc(options?: OptionsStylistic): ConfigItem[];
+
+declare function jsonc(options?: OptionsStylistic & OptionsOverrides): ConfigItem[];
+
+declare function node(): ConfigItem[];
+
+declare function reactHooks(): {
+    files: string[];
+    plugins: {
+        "react-hooks": any;
+    };
+    rules: {
+        "react-hooks/exhaustive-deps": string;
+        "react-hooks/rules-of-hooks": string;
+    };
+}[];
+declare function react(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact): ConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): ConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): ConfigItem[];
+
+declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix): ConfigItem[];
+
+declare function unicorn(): ConfigItem[];
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function jsse(options?: OptionsConfig & ConfigItem, ...userConfigs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+declare function renameRules<TRule = unknown>(rules: Record<string, TRule>, from: string, to: string): Record<string, TRule>;
+declare function isCI(): boolean;
+declare function isInEditor(): boolean;
+
+export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsPrefix, OptionsReact, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, combine, comments, jsse as default, ignores, imports, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, node, react, reactHooks, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };

package/dist/index.d.ts

@@ -0,0 +1,257 @@
+import { MergeIntersection, RenamePrefix, TypeScriptRules, VitestRules, YmlRules, NRules, ImportRules, EslintRules, JsoncRules, VueRules, UnicornRules, EslintCommentsRules, RuleConfig, FlatESLintConfigItem } from '@antfu/eslint-define-config';
+import { ParserOptions } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginEslintComments } from 'eslint-plugin-eslint-comments';
+import * as eslintPluginI from 'eslint-plugin-i';
+export { eslintPluginI as pluginImport };
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+import * as eslintPluginJsonc from 'eslint-plugin-jsonc';
+export { eslintPluginJsonc as pluginJsonc };
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginReact } from 'eslint-plugin-react';
+export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
+import * as eslintPluginReactRefresh from 'eslint-plugin-react-refresh';
+export { eslintPluginReactRefresh as pluginReactRefresh };
+import * as eslintPluginSortKeys from 'eslint-plugin-sort-keys';
+export { eslintPluginSortKeys as pluginSortKeys };
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginTailwind } from 'eslint-plugin-tailwindcss';
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+
+type Rules = MergeIntersection<RenamePrefix<TypeScriptRules, "@typescript-eslint/", "ts/"> & RenamePrefix<VitestRules, "vitest/", "test/"> & RenamePrefix<YmlRules, "yml/", "yaml/"> & RenamePrefix<NRules, "n/", "node/"> & ImportRules & EslintRules & JsoncRules & VueRules & UnicornRules & EslintCommentsRules & {
+    "test/no-only-tests": RuleConfig;
+}>;
+type ConfigItem = Omit<FlatESLintConfigItem<Rules, false>, "plugins"> & {
+    /**
+     * Custom name of each config item
+     */
+    name?: string;
+    /**
+     * 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, any>;
+};
+type OptionsComponentExts = {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+};
+type OptionsTypeScriptParserOptions = {
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+};
+type OptionsTypeScriptWithTypes = {
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfigPath?: string;
+};
+type OptionsHasTypeScript = {
+    typescript?: boolean;
+};
+type OptionsStylistic = {
+    stylistic?: boolean | StylisticConfig;
+};
+type StylisticConfig = {
+    indent?: number | "tab";
+    quotes?: "single" | "double";
+    jsx?: boolean;
+};
+type OptionsPrefix = {
+    prefix?: {
+        from: string;
+        to: string;
+    };
+};
+type OptionsOverrides = {
+    overrides?: ConfigItem["rules"];
+};
+type OptionsIsInEditor = {
+    isInEditor?: boolean;
+};
+type OptionsReact = {
+    react?: boolean;
+    reactRefresh?: boolean;
+};
+type OptionsConfig = {
+    /**
+     * Enable debug mode.
+     */
+    debug?: boolean;
+    tailwind?: boolean;
+    off?: string[];
+    /**
+     * Enable gitignore support.
+     *
+     * Passing an object to configure the options.
+     *
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
+     * @default true
+     */
+    gitignore?: boolean | FlatGitignoreOptions;
+    tsPrefix?: string;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithTypes;
+    react?: boolean;
+    reactRefresh?: boolean;
+    /**
+     * Enable JSX related rules.
+     *
+     * Currently only stylistic rules are included.
+     *
+     * @default true
+     */
+    jsx?: boolean;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable Markdown support.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean | StylisticConfig;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+    /**
+     * Provide overrides for rules for each integration.
+     */
+    overrides?: {
+        javascript?: ConfigItem["rules"];
+        typescript?: ConfigItem["rules"];
+        test?: ConfigItem["rules"];
+        vue?: ConfigItem["rules"];
+        jsonc?: ConfigItem["rules"];
+        markdown?: ConfigItem["rules"];
+        yaml?: ConfigItem["rules"];
+    };
+} & OptionsComponentExts;
+
+declare function comments(): ConfigItem[];
+
+declare function ignores(): ConfigItem[];
+
+declare function imports(options?: OptionsStylistic): ConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides & {
+    reportUnusedDisableDirectives?: boolean;
+}): ConfigItem[];
+
+declare function jsdoc(options?: OptionsStylistic): ConfigItem[];
+
+declare function jsonc(options?: OptionsStylistic & OptionsOverrides): ConfigItem[];
+
+declare function node(): ConfigItem[];
+
+declare function reactHooks(): {
+    files: string[];
+    plugins: {
+        "react-hooks": any;
+    };
+    rules: {
+        "react-hooks/exhaustive-deps": string;
+        "react-hooks/rules-of-hooks": string;
+    };
+}[];
+declare function react(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact): ConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): ConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): ConfigItem[];
+
+declare function test(options?: OptionsIsInEditor & OptionsOverrides): ConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsReact & OptionsPrefix): ConfigItem[];
+
+declare function unicorn(): ConfigItem[];
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function jsse(options?: OptionsConfig & ConfigItem, ...userConfigs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_JS = "**/*.?([cm])js";
+declare const GLOB_JSX = "**/*.?([cm])jsx";
+declare const GLOB_TS = "**/*.?([cm])ts";
+declare const GLOB_TSX = "**/*.?([cm])tsx";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_LESS = "**/*.less";
+declare const GLOB_SCSS = "**/*.scss";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_ALL_SRC: string[];
+declare const GLOB_EXCLUDE: string[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: (ConfigItem | ConfigItem[])[]): ConfigItem[];
+declare function renameRules<TRule = unknown>(rules: Record<string, TRule>, from: string, to: string): Record<string, TRule>;
+declare function isCI(): boolean;
+declare function isInEditor(): boolean;
+
+export { ConfigItem, GLOB_ALL_SRC, GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsOverrides, OptionsPrefix, OptionsReact, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, Rules, StylisticConfig, combine, comments, jsse as default, ignores, imports, isCI, isInEditor, javascript, jsdoc, jsonc, jsse, node, react, reactHooks, renameRules, sortPackageJson, sortTsconfig, test, typescript, unicorn };