@rebeccastevens/eslint-config 2.0.11 → 3.0.0-next.2

package/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Rebecca Stevens
+Copyright (c) 2024, Rebecca Stevens
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -5,16 +5,19 @@
 An [ESLint Shareable Config](https://eslint.org/docs/developer-guide/shareable-configs.html).
 
 [![npm version](https://img.shields.io/npm/v/@rebeccastevens/eslint-config.svg)](https://www.npmjs.com/package/@rebeccastevens/eslint-config)
-[![CI](https://github.com/RebeccaStevens/template-typescript-node-package/actions/workflows/release.yml/badge.svg)](https://github.com/RebeccaStevens/template-typescript-node-package/actions/workflows/release.yml)
+[![CI](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/actions/workflows/release.yml/badge.svg)](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/actions/workflows/release.yml)
+[![Coverage Status](https://codecov.io/gh/RebeccaStevens/eslint-config-rebeccastevens/branch/main/graph/badge.svg?token=MVpR1oAbIT)](https://codecov.io/gh/RebeccaStevens/eslint-config-rebeccastevens)\
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![GitHub Discussions](https://img.shields.io/github/discussions/RebeccaStevens/template-typescript-node-package?style=flat-square)](https://github.com/RebeccaStevens/template-typescript-node-package/discussions)
-[![BSD 3 Clause license](https://img.shields.io/github/license/RebeccaStevens/template-typescript-node-package.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
+[![GitHub Discussions](https://img.shields.io/github/discussions/RebeccaStevens/eslint-config-rebeccastevens?style=flat-square)](https://github.com/RebeccaStevens/eslint-config-rebeccastevens/discussions)
+[![BSD 3 Clause license](https://img.shields.io/github/license/RebeccaStevens/eslint-config-rebeccastevens.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
 
 </div>
 
-<br>
+## Donate
+
+[Any donations would be much appreciated](./DONATIONS.md). 😄
 
 ## Installation
 
@@ -32,95 +35,21 @@ Note: This project doesn't strictly follow semantic versioning so be sure to pin
 
 ## Usage
 
-### Language
-
-<details>
-  <summary>JavaScript (Modern)</summary>
-
-Install Peer Dependencies:
+```js
+// eslint.config.js
+import rsEslint from "@rebeccastevens/eslint-config";
 
-```sh
-pnpm add -D \
-  babel-eslint \
-  eslint-plugin-eslint-comments \
-  eslint-plugin-functional \
-  eslint-plugin-import \
-  eslint-import-resolver-typescript \
-  eslint-plugin-jsdoc \
-  eslint-plugin-markdown \
-  eslint-plugin-n \
-  eslint-plugin-optimize-regex \
-  eslint-plugin-promise \
-  eslint-plugin-sonarjs \
-  eslint-plugin-unicorn
-```
-
-Configure your project's `.eslintrc.json` file.
-
-```jsonc
-{
-  "root": true,
-  "extends": ["@rebeccastevens/eslint-config/modern"],
-  "rules": {
-    // Additional, per-project rules...
+export default rsEslint(
+  {
+    // general config.
   },
-  "overrides": [
-    {
-      "files": ["**/*.test.ts"],
-      "rules": {}
-    }
-  ]
-}
-```
-
-</details>
-
-<details>
-  <summary>TypeScript</summary>
-
-Install Peer Dependencies:
-
-```sh
-pnpm add -D  \
-  @typescript-eslint/parser \
-  @typescript-eslint/eslint-plugin \
-  eslint-plugin-eslint-comments \
-  eslint-plugin-functional \
-  eslint-plugin-import \
-  eslint-import-resolver-typescript \
-  eslint-plugin-jsdoc \
-  eslint-plugin-markdown \
-  eslint-plugin-n \
-  eslint-plugin-optimize-regex \
-  eslint-plugin-promise \
-  eslint-plugin-sonarjs \
-  eslint-plugin-unicorn
-```
-
-Configure your project's `.eslintrc.json` file.
-
-```jsonc
-{
-  "root": true,
-  "parserOptions": {
-    "project": "tsconfig.json"
+  {
+    // project specific config.
   },
-  "extends": [
-    "@rebeccastevens/eslint-config/modern",
-    "@rebeccastevens/eslint-config/typescript"
-  ],
-  "rules": {
-    // Additional, per-project rules...
+  {
+    // another project specific config.
   },
-  "overrides": [
-    {
-      "files": ["**/*.test.ts"],
-      "rules": {}
-    }
-  ]
-}
+);
 ```
 
-</details>
-
 See [ESLint configuration](http://eslint.org/docs/user-guide/configuring) for more information.

package/dist/index.d.mts

@@ -0,0 +1,279 @@
+/// <reference types="eslint" />
+/// <reference types="ript-eslint" />
+import { StylisticCustomizeOptions } from "@stylistic/eslint-plugin";
+import { ParserOptions } from "@typescript-eslint/parser";
+import { TSESLint } from "@typescript-eslint/utils";
+import { ESLint, Linter } from "eslint";
+import { Options as VueBlocksOptions } from "eslint-processor-vue-blocks";
+import { Options as PrettierOptions } from "prettier";
+import { RuleOptions } from "./typegen";
+import { FlatConfigComposer } from "eslint-flat-config-utils";
+type Awaitable<T> = T | Promise<T>;
+type Rules = RuleOptions;
+type FlatConfigItem = Omit<Linter.FlatConfig, "plugins" | "rules"> & {
+    /**
+     * Custom name of each config item
+     */
+    name?: string;
+    plugins?: Record<string, Readonly<ESLint.Plugin | TSESLint.FlatConfig.Plugin>>;
+    /**
+     * An object containing a name-value mapping of rules to use.
+     */
+    rules?: Record<string, Linter.RuleEntry> & Rules;
+};
+type OptionsFiles = {
+    /**
+     * Override the `files` option to provide custom globs.
+     */
+    files?: string[];
+};
+type OptionsVue = {
+    /**
+     * Create virtual files for Vue SFC blocks to enable linting.
+     *
+     * @see https://github.com/antfu/eslint-processor-vue-blocks
+     * @default true
+     */
+    sfcBlocks?: boolean | VueBlocksOptions;
+    /**
+     * Vue version. Apply different rules set from `eslint-plugin-vue`.
+     *
+     * @default 3
+     */
+    vueVersion?: 2 | 3;
+} & OptionsOverrides;
+type OptionsTypescript = ((OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides)) & OptionsTypeScriptUnsafeSeverity;
+type OptionsFormatters = {
+    js?: boolean;
+    ts?: boolean;
+    json?: boolean;
+    yaml?: boolean;
+    dts?: boolean;
+    css?: boolean;
+    html?: boolean;
+    markdown?: boolean;
+    graphql?: boolean;
+    prettierOptions?: PrettierOptions;
+    slidev?: boolean | {
+        files?: string[];
+    };
+};
+type OptionsComponentExts = {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     *
+     * @default []
+     */
+    componentExts?: string[];
+};
+type OptionsTypeScriptParserOptions = {
+    /**
+     * Additional parser options for TypeScript.
+     */
+    parserOptions?: Partial<ParserOptions>;
+    /**
+     * Glob patterns for files that should be type aware.
+     *
+     * @default ['**\/*.{ts,tsx}']
+     */
+    filesTypeAware?: string[];
+};
+type OptionsTypeScriptWithTypes = {
+    /**
+     * When this options is provided, type aware rules will be enabled.
+     *
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    tsconfig?: true | string | string[];
+};
+type OptionsTypeScriptUnsafeSeverity = {
+    unsafe?: "off" | "warn" | "error";
+};
+type OptionsHasTypeScript = {
+    typescript?: boolean;
+};
+type OptionsStylistic = {
+    stylistic?: boolean | StylisticConfig;
+};
+type StylisticConfig = {} & Pick<StylisticCustomizeOptions, "indent" | "quotes" | "jsx" | "semi">;
+type OptionsOverrides = {
+    overrides?: FlatConfigItem["rules"];
+};
+type OptionsIsInEditor = {
+    isInEditor?: boolean;
+};
+type OptionsUnoCSS = {
+    /**
+     * Enable attributify support.
+     */
+    attributify?: boolean;
+    /**
+     * Enable strict mode by throwing errors about blocklisted classes.
+     */
+    strict?: boolean;
+} & OptionsOverrides;
+type OptionsFunctional = {
+    functionalEnforcement?: "none" | "lite" | "default" | "strict";
+};
+type OptionsIgnores = Linter.FlatConfig["ignores"] | {
+    extend?: boolean;
+    files?: Linter.FlatConfig["ignores"];
+};
+type OptionsConfig = {
+    /**
+     * Core rules. Can't be disabled.
+     */
+    javascript?: OptionsOverrides;
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypescript;
+    /**
+     * Enable JSX related rules.
+     */
+    jsx?: boolean;
+    /**
+     * Enable test support.
+     */
+    test?: boolean | OptionsOverrides;
+    /**
+     * Enforce functional programming.
+     */
+    functional?: boolean | OptionsFunctional["functionalEnforcement"] | (OptionsOverrides & OptionsFunctional);
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean | OptionsVue;
+    /**
+     * Enable JSONC support.
+     */
+    jsonc?: boolean | OptionsOverrides;
+    /**
+     * Enable YAML support.
+     */
+    yaml?: boolean | OptionsOverrides;
+    /**
+     * Enable TOML support.
+     */
+    toml?: boolean | OptionsOverrides;
+    /**
+     * Enable linting for **code snippets** in Markdown.
+     *
+     * For formatting Markdown content, enable also `formatters.markdown`.
+     */
+    markdown?: boolean | OptionsOverrides;
+    /**
+     * Enable stylistic rules.
+     */
+    stylistic?: boolean | (StylisticConfig & OptionsOverrides);
+    /**
+     * Enable unocss rules.
+     */
+    unocss?: boolean | OptionsUnoCSS;
+    /**
+     * Use external formatters to format files.
+     *
+     * When set to `true`, it will enable all formatters.
+     */
+    formatters?: boolean | OptionsFormatters;
+    /**
+     * Control to disable some rules in editors.
+     */
+    isInEditor?: boolean;
+    /**
+     * Automatically rename plugins in the config.
+     */
+    autoRenamePlugins?: boolean;
+    ignores?: OptionsIgnores;
+} & OptionsComponentExts;
+declare function comments(options?: unknown): Promise<FlatConfigItem[]>;
+declare function formatters(opts?: OptionsFormatters | true, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
+declare function functional(options?: OptionsFunctional & OptionsStylistic & OptionsOverrides & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
+declare function ignores(options?: Readonly<{
+    ignores?: OptionsIgnores;
+}>): FlatConfigItem[];
+declare function imports(options?: OptionsStylistic & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions): Promise<FlatConfigItem[]>;
+declare function inEditor(options?: unknown): FlatConfigItem[];
+declare function javascript(options?: OptionsOverrides & OptionsFunctional): Promise<FlatConfigItem[]>;
+declare function jsdoc(options?: OptionsStylistic): Promise<FlatConfigItem[]>;
+declare function jsonc(options?: OptionsFiles & OptionsStylistic & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function markdown(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function node(options?: unknown): Promise<FlatConfigItem[]>;
+declare function overrides(): Promise<FlatConfigItem[]>;
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare function sortTsconfig(): FlatConfigItem[];
+declare const StylisticConfigDefaults: StylisticConfig;
+declare function stylistic(options?: StylisticConfig & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function test(options?: OptionsFiles & OptionsOverrides): Promise<FlatConfigItem[]>;
+declare function toml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
+declare function typescript(options?: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions & OptionsTypeScriptUnsafeSeverity): Promise<FlatConfigItem[]>;
+declare function unicorn(options?: unknown): Promise<FlatConfigItem[]>;
+declare function unocss(options?: OptionsUnoCSS): Promise<FlatConfigItem[]>;
+/* eslint-enable ts/naming-convention */
+declare function vue(options?: Readonly<OptionsVue & OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles>): Promise<FlatConfigItem[]>;
+declare function yaml(options?: OptionsOverrides & OptionsStylistic & OptionsFiles): Promise<FlatConfigItem[]>;
+declare const defaultPluginRenaming: {
+    "@stylistic": string;
+    "@typescript-eslint": string;
+    "import-x": string;
+    "optimize-regex": string;
+    n: string;
+    sonarjs: string;
+    vitest: string;
+    yml: string;
+};
+/**
+ * Construct an array of ESLint flat config items.
+ *
+ * @param {OptionsConfig & FlatConfigItem} options - The options for generating the ESLint configurations.
+ * @param {Awaitable<FlatConfigItem | FlatConfigItem[]>[]} userConfigs - The user configurations to be merged with the generated configurations.
+ * @returns {Promise<FlatConfigItem[]>} The merged ESLint configurations.
+ */
+declare function rsEslint(options?: OptionsConfig & FlatConfigItem, ...userConfigs: ReadonlyArray<Awaitable<FlatConfigItem | FlatConfigItem[]>>): FlatConfigComposer<FlatConfigItem>;
+type ResolvedOptions<T> = T extends boolean ? never : T extends string ? never : NonNullable<T>;
+declare function resolveSubOptions<K extends keyof OptionsConfig>(options: Readonly<OptionsConfig>, key: K): ResolvedOptions<OptionsConfig[K]>;
+declare function getOverrides<K extends keyof OptionsConfig>(options: Readonly<OptionsConfig>, key: K): (Record<string, import("eslint").Linter.RuleEntry<any[]>> & import("typegen").RuleOptions) | undefined;
+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])ts";
+declare const GLOB_TYPINGS = "typings/**/*.?([cm])ts";
+declare const GLOB_MJS = "**/*.mjs";
+declare const GLOB_MTS = "**/*.mts";
+declare const GLOB_CJS = "**/*.cjs";
+declare const GLOB_CTS = "**/*.cts";
+declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+declare const GLOB_CSS = "**/*.css";
+declare const GLOB_POSTCSS = "**/*.{p,post}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_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+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_GRAPHQL = "**/*.{g,graph}ql";
+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[];
+export { comments, formatters, functional, ignores, imports, inEditor, javascript, jsdoc, jsonc, markdown, node, overrides, sortTsconfig, StylisticConfigDefaults, stylistic, test, toml, typescript, unicorn, unocss, vue, yaml, defaultPluginRenaming, rsEslint, rsEslint as default, ResolvedOptions, resolveSubOptions, getOverrides, GLOB_SRC_EXT, GLOB_SRC, GLOB_JS, GLOB_JSX, GLOB_TS, GLOB_TSX, GLOB_DTS, GLOB_TYPINGS, GLOB_MJS, GLOB_MTS, GLOB_CJS, GLOB_CTS, GLOB_STYLE, GLOB_CSS, GLOB_POSTCSS, GLOB_LESS, GLOB_SCSS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_MARKDOWN, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_VUE, GLOB_YAML, GLOB_TOML, GLOB_HTML, GLOB_GRAPHQL, GLOB_MARKDOWN_CODE, GLOB_TESTS, GLOB_ALL_SRC, GLOB_EXCLUDE, Awaitable, Rules, FlatConfigItem, OptionsFiles, OptionsVue, OptionsTypescript, OptionsFormatters, OptionsComponentExts, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypeScriptUnsafeSeverity, OptionsHasTypeScript, OptionsStylistic, StylisticConfig, OptionsOverrides, OptionsIsInEditor, OptionsUnoCSS, OptionsFunctional, OptionsIgnores, OptionsConfig };