@vinicunca/eslint-config 2.0.0-beta.0 → 2.0.0-beta.5

package/dist/index.d.cts

@@ -0,0 +1,226 @@
+import * as eslint_define_config from 'eslint-define-config';
+import { FlatESLintConfigItem as FlatESLintConfigItem$1 } from 'eslint-define-config';
+import { ParserOptions } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
+export { default as pluginVinicunca } from '@vinicunca/eslint-plugin-vinicunca';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginComments } 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 pluginMarkdown } from 'eslint-plugin-markdown';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginReact } from 'eslint-plugin-react';
+export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
+export { default as pluginVue } from 'eslint-plugin-vue';
+import * as eslintPluginYml from 'eslint-plugin-yml';
+export { eslintPluginYml as pluginYaml };
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYaml } from 'yaml-eslint-parser';
+
+interface FlatESLintConfigItem extends FlatESLintConfigItem$1 {
+    /**
+     * The name of the configuration object.
+     */
+    name?: string;
+}
+interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * Additional options for the ignore rules.
+     */
+    ignores?: OptionsIgnores;
+    /**
+     * 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 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;
+    /**
+     * Enable sonarjs rules.
+     *
+     * @default true
+     */
+    sonar?: boolean;
+    /**
+     * Enable react support.
+     * In This plugin, react is not supported as a first class citizen. 😎
+     *
+     * @default false
+     */
+    react?: boolean;
+    /**
+     * 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?: FlatESLintConfigItem['rules'];
+        typescript?: FlatESLintConfigItem['rules'];
+        test?: FlatESLintConfigItem['rules'];
+        vue?: FlatESLintConfigItem['rules'];
+        jsonc?: FlatESLintConfigItem['rules'];
+        markdown?: FlatESLintConfigItem['rules'];
+        yaml?: FlatESLintConfigItem['rules'];
+        react?: FlatESLintConfigItem['rules'];
+    };
+}
+interface OptionsOverrides {
+    overrides?: FlatESLintConfigItem['rules'];
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsIgnores {
+    enableGitignore?: boolean;
+    items?: string[];
+    replace?: boolean;
+}
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptParserOptions {
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+}
+interface OptionsTypeScriptWithTypes {
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfigPath?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+
+declare function vinicuncaESLint({ options, userConfigs }: {
+    options?: OptionsConfig;
+    userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[];
+}): eslint_define_config.FlatESLintConfigItem[];
+
+declare function comments(): FlatESLintConfigItem[];
+
+declare function ignores({ enableGitignore, items, replace, }?: OptionsIgnores): FlatESLintConfigItem[];
+
+declare function imports(): FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function jsdoc(): FlatESLintConfigItem[];
+
+declare function jsonc(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function node(): FlatESLintConfigItem[];
+
+declare function react(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): FlatESLintConfigItem[];
+
+declare function stylistic(): FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): FlatESLintConfigItem[];
+
+declare function unicorn(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+declare function vue(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function yaml(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combineConfigs(...configs: (FlatESLintConfigItem$1 | FlatESLintConfigItem$1[])[]): FlatESLintConfigItem$1[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+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_EXCLUDE: string[];
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+
+export { FlatESLintConfigItem, GLOB_EXCLUDE, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, combineConfigs, comments, vinicuncaESLint as default, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vinicuncaESLint, vue, yaml };

package/dist/index.d.ts

@@ -0,0 +1,226 @@
+import * as eslint_define_config from 'eslint-define-config';
+import { FlatESLintConfigItem as FlatESLintConfigItem$1 } from 'eslint-define-config';
+import { ParserOptions } from '@typescript-eslint/parser';
+import * as parser from '@typescript-eslint/parser';
+export { parser as parserTs };
+export { default as pluginStylistic } from '@stylistic/eslint-plugin';
+export { default as pluginVinicunca } from '@vinicunca/eslint-plugin-vinicunca';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginComments } 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 pluginMarkdown } from 'eslint-plugin-markdown';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginReact } from 'eslint-plugin-react';
+export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
+export { default as pluginVue } from 'eslint-plugin-vue';
+import * as eslintPluginYml from 'eslint-plugin-yml';
+export { eslintPluginYml as pluginYaml };
+export { default as pluginVitest } from 'eslint-plugin-vitest';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYaml } from 'yaml-eslint-parser';
+
+interface FlatESLintConfigItem extends FlatESLintConfigItem$1 {
+    /**
+     * The name of the configuration object.
+     */
+    name?: string;
+}
+interface OptionsConfig extends OptionsComponentExts {
+    /**
+     * Additional options for the ignore rules.
+     */
+    ignores?: OptionsIgnores;
+    /**
+     * 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 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;
+    /**
+     * Enable sonarjs rules.
+     *
+     * @default true
+     */
+    sonar?: boolean;
+    /**
+     * Enable react support.
+     * In This plugin, react is not supported as a first class citizen. 😎
+     *
+     * @default false
+     */
+    react?: boolean;
+    /**
+     * 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?: FlatESLintConfigItem['rules'];
+        typescript?: FlatESLintConfigItem['rules'];
+        test?: FlatESLintConfigItem['rules'];
+        vue?: FlatESLintConfigItem['rules'];
+        jsonc?: FlatESLintConfigItem['rules'];
+        markdown?: FlatESLintConfigItem['rules'];
+        yaml?: FlatESLintConfigItem['rules'];
+        react?: FlatESLintConfigItem['rules'];
+    };
+}
+interface OptionsOverrides {
+    overrides?: FlatESLintConfigItem['rules'];
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsIgnores {
+    enableGitignore?: boolean;
+    items?: string[];
+    replace?: boolean;
+}
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptParserOptions {
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+}
+interface OptionsTypeScriptWithTypes {
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfigPath?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+
+declare function vinicuncaESLint({ options, userConfigs }: {
+    options?: OptionsConfig;
+    userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[];
+}): eslint_define_config.FlatESLintConfigItem[];
+
+declare function comments(): FlatESLintConfigItem[];
+
+declare function ignores({ enableGitignore, items, replace, }?: OptionsIgnores): FlatESLintConfigItem[];
+
+declare function imports(): FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function jsdoc(): FlatESLintConfigItem[];
+
+declare function jsonc(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function node(): FlatESLintConfigItem[];
+
+declare function react(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortPackageJson(): FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): FlatESLintConfigItem[];
+
+declare function stylistic(): FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): FlatESLintConfigItem[];
+
+declare function unicorn(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+declare function vue(options?: OptionsHasTypeScript & OptionsOverrides): FlatESLintConfigItem[];
+
+declare function yaml(options?: OptionsOverrides): FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combineConfigs(...configs: (FlatESLintConfigItem$1 | FlatESLintConfigItem$1[])[]): FlatESLintConfigItem$1[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+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_EXCLUDE: string[];
+declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+declare const GLOB_TESTS: string[];
+declare const GLOB_VUE = "**/*.vue";
+declare const GLOB_JSON = "**/*.json";
+declare const GLOB_JSON5 = "**/*.json5";
+declare const GLOB_JSONC = "**/*.jsonc";
+declare const GLOB_YAML = "**/*.y?(a)ml";
+declare const GLOB_MARKDOWN = "**/*.md";
+declare const GLOB_MARKDOWN_CODE = "**/*.md/**/*.?([cm])[jt]s?(x)";
+
+export { FlatESLintConfigItem, GLOB_EXCLUDE, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIgnores, OptionsIsInEditor, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, combineConfigs, comments, vinicuncaESLint as default, ignores, imports, javascript, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, stylistic, test, typescript, unicorn, vinicuncaESLint, vue, yaml };