@so1ve/eslint-config 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/index.d.ts

@@ -1 +1,211 @@
-export * from "C:/Data/Workspace/eslint-prettier-config/packages/eslint-config/src/index";
+import { FlatESLintConfigItem } from 'eslint-define-config';
+import { FlatGitignoreOptions } from 'eslint-config-flat-gitignore';
+export { default as pluginComments } from '@eslint-community/eslint-plugin-eslint-comments';
+export { default as pluginHtml } from '@html-eslint/eslint-plugin';
+export { default as parserHtml } from '@html-eslint/parser';
+export { default as pluginSo1ve } from '@so1ve/eslint-plugin';
+export { default as pluginSortImports } from '@so1ve/eslint-plugin-sort-imports';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as parserTs } from '@typescript-eslint/parser';
+export { default as parserMdx } from 'eslint-mdx';
+export { default as pluginArrayFunc } from 'eslint-plugin-array-func';
+export { default as pluginEtc } from 'eslint-plugin-etc';
+export { default as pluginHtmlJsSupport } from 'eslint-plugin-html';
+export { default as pluginImport } from 'eslint-plugin-i';
+export { default as pluginJestFormatting } from 'eslint-plugin-jest-formatting';
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+export { default as pluginJsonSchemaValidator } from 'eslint-plugin-json-schema-validator';
+export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+export { default as pluginMdx } from 'eslint-plugin-mdx';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginOnlyError } from 'eslint-plugin-only-error';
+export { default as pluginPromise } from 'eslint-plugin-promise';
+export { default as pluginRegexp } from 'eslint-plugin-regexp';
+export { default as pluginSolid } from 'eslint-plugin-solid';
+export { default as pluginToml } from 'eslint-plugin-toml';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as pluginVue } from 'eslint-plugin-vue';
+export { default as pluginYaml } from 'eslint-plugin-yml';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+export { default as parserToml } from 'toml-eslint-parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYaml } from 'yaml-eslint-parser';
+
+declare const comments: () => FlatESLintConfigItem[];
+
+declare const html: () => FlatESLintConfigItem[];
+
+declare const ignores: () => FlatESLintConfigItem[];
+
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptWithTypes {
+    tsconfigPath: string;
+    tsconfigRootDir?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsOverrides {
+    overrides?: FlatESLintConfigItem["rules"];
+}
+interface Options {
+    /**
+     * Enable gitignore support.
+     *
+     * Passing an object to configure the options.
+     *
+     * @default true
+     * @see https://github.com/antfu/eslint-config-flat-gitignore
+     */
+    gitignore?: boolean | FlatGitignoreOptions;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithTypes;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean;
+    /**
+     * Enable Solid.js support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    solid?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable TOML support.
+     *
+     * @default true
+     */
+    toml?: boolean;
+    /**
+     * Enable markdown and mdx support.
+     *
+     * @default true
+     */
+    mdx?: boolean;
+    /**
+     * Provide overrides for rules for each integration.
+     */
+    overrides?: {
+        javascript?: FlatESLintConfigItem["rules"];
+        typescript?: FlatESLintConfigItem["rules"];
+        typescriptWithTypes?: FlatESLintConfigItem["rules"];
+        test?: FlatESLintConfigItem["rules"];
+        vue?: FlatESLintConfigItem["rules"];
+        solid?: FlatESLintConfigItem["rules"];
+        jsonc?: FlatESLintConfigItem["rules"];
+        mdx?: FlatESLintConfigItem["rules"];
+        yaml?: FlatESLintConfigItem["rules"];
+        toml?: FlatESLintConfigItem["rules"];
+    };
+}
+
+declare const imports: (options?: Options) => FlatESLintConfigItem[];
+
+declare const javascript: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const jsdoc: () => FlatESLintConfigItem[];
+
+declare const jsonc: () => FlatESLintConfigItem[];
+
+declare const mdx: ({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const node: () => FlatESLintConfigItem[];
+
+declare const onlyError: () => FlatESLintConfigItem[];
+
+declare const promise: () => FlatESLintConfigItem[];
+
+declare const solid: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const sortImports: () => FlatESLintConfigItem[];
+
+declare const test: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const toml: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const typescript: ({ componentExts, overrides, }?: OptionsComponentExts & OptionsOverrides) => FlatESLintConfigItem[];
+declare const typescriptWithTypes: ({ componentExts, tsconfigPath, tsconfigRootDir, overrides, }: OptionsTypeScriptWithTypes & OptionsComponentExts & OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const unicorn: () => FlatESLintConfigItem[];
+
+declare const vue: ({ overrides, typescript, }?: OptionsHasTypeScript & OptionsOverrides) => FlatESLintConfigItem[];
+
+declare const yaml: ({ overrides, }?: OptionsOverrides) => FlatESLintConfigItem[];
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function so1ve(options?: Options, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+
+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_DTS = "**/*.d.?([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_ESLINTRC = "**/.eslintrc";
+declare const GLOB_MARKDOWN = "**/*.{md,mdx}";
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_TOML = "**/*.toml";
+declare const GLOB_HTML = "**/*.htm?(l)";
+declare const GLOB_PACKAGEJSON = "**/package.json";
+declare const GLOB_MARKDOWN_CODE = "**/*.{md,mdx}/**/*.?([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 const combine: (...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]) => FlatESLintConfigItem[];
+declare const renameRules: (rules: Record<string, any>, from: string, to: string) => {
+    [k: string]: any;
+};
+declare function recordRulesStateConfigs(configs: FlatESLintConfigItem[]): FlatESLintConfigItem[];
+declare function recordRulesState(rules: FlatESLintConfigItem["rules"]): FlatESLintConfigItem["rules"];
+declare function warnUnnecessaryOffRules(): void;
+
+export { GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScriptWithTypes, combine, comments, html, ignores, imports, javascript, jsdoc, jsonc, mdx, node, onlyError, promise, recordRulesState, recordRulesStateConfigs, renameRules, so1ve, solid, sortImports, test, toml, typescript, typescriptWithTypes, unicorn, vue, warnUnnecessaryOffRules, yaml };