@curev/eslint-config 0.3.0 → 0.3.2

package/src/types.ts

@@ -1,364 +0,0 @@
-import type { FlatGitignoreOptions } from "eslint-config-flat-gitignore";
-import type { ParserOptions } from "@typescript-eslint/parser";
-import type { Options as VueBlocksOptions } from "eslint-processor-vue-blocks";
-import type { Linter } from "eslint";
-import type {
-  EslintCommentsRules,
-  EslintRules,
-  FlatESLintConfigItem,
-  ImportRules,
-  JsoncRules,
-  MergeIntersection,
-  NRules,
-  Prefix,
-  ReactHooksRules,
-  ReactRules,
-  RenamePrefix,
-  RuleConfig,
-  VitestRules,
-  VueRules,
-  YmlRules
-} from "@antfu/eslint-define-config";
-import type { RuleOptions as JSDocRules } from "@eslint-types/jsdoc/types";
-import type { RuleOptions as TypeScriptRules } from "@eslint-types/typescript-eslint/types";
-import type { RuleOptions as UnicornRules } from "@eslint-types/unicorn/types";
-import type { Rules as AntfuRules } from "eslint-plugin-antfu";
-import type { StylisticCustomizeOptions, UnprefixedRuleOptions as StylisticRules } from "@stylistic/eslint-plugin";
-import type { VendoredPrettierOptions } from "./vender/prettier-types";
-
-export type WrapRuleConfig<T extends { [key: string]: any }> = {
-  [K in keyof T]: T[K] extends RuleConfig ? T[K] : RuleConfig<T[K]>
-};
-
-export type Awaitable<T> = T | Promise<T>;
-
-export type Rules = WrapRuleConfig<
-  MergeIntersection<
-    RenamePrefix<TypeScriptRules, "@typescript-eslint/", "ts/"> &
-    RenamePrefix<VitestRules, "vitest/", "test/"> &
-    RenamePrefix<YmlRules, "yml/", "yaml/"> &
-    RenamePrefix<NRules, "n/", "node/"> &
-    Prefix<StylisticRules, "style/"> &
-    Prefix<AntfuRules, "antfu/"> &
-    ReactHooksRules &
-    ReactRules &
-    JSDocRules &
-    ImportRules &
-    EslintRules &
-    JsoncRules &
-    VueRules &
-    UnicornRules &
-    EslintCommentsRules &
-    // TODO: TOML rules
-    {
-      "test/no-only-tests": RuleConfig<[]>;
-    }
-  >
->;
-
-export type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, "plugins"> & {
-  /**
-   * Custom name of each config item
-   */
-  name?: string;
-
-  // Relax plugins type limitation, as most of the plugins did not have correct type info yet.
-  /**
-   * 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>;
-};
-
-export type UserConfigItem = FlatConfigItem | Linter.FlatConfig;
-
-export interface OptionsFiles {
-  /**
-   * Override the `files` option to provide custom globs.
-   */
-  files?: string[];
-}
-
-export interface OptionsVue extends OptionsOverrides {
-  /**
-   * 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;
-}
-
-export type OptionsTypescript =
-  (OptionsTypeScriptWithTypes & OptionsOverrides)
-  | (OptionsTypeScriptParserOptions & OptionsOverrides);
-
-export interface OptionsFormatters {
-  /**
-   * Enable formatting support for CSS, Less, Sass, and SCSS.
-   *
-   * Currently only support Prettier.
-   */
-  css?: "prettier" | boolean;
-
-  /**
-   * Enable formatting support for HTML.
-   *
-   * Currently only support Prettier.
-   */
-  html?: "prettier" | boolean;
-
-  /**
-   * Enable formatting support for Markdown.
-   *
-   * Support both Prettier and dprint.
-   *
-   * When set to `true`, it will use Prettier.
-   */
-  markdown?: "prettier" | "dprint" | boolean;
-
-  /**
-   * Enable formatting support for GraphQL.
-   */
-  graphql?: "prettier" | boolean;
-
-  /**
-   * Custom options for Prettier.
-   *
-   * By default it's controlled by our own config.
-   */
-  prettierOptions?: VendoredPrettierOptions;
-
-  /**
-   * Custom options for dprint.
-   *
-   * By default it's controlled by our own config.
-   */
-  dprintOptions?: boolean;
-}
-
-export interface OptionsComponentExts {
-  /**
-   * Additional extensions for components.
-   *
-   * @example ['vue']
-   * @default []
-   */
-  componentExts?: string[];
-}
-
-export interface OptionsTypeScriptParserOptions {
-  /**
-   * Additional parser options for TypeScript.
-   */
-  parserOptions?: Partial<ParserOptions>;
-
-  /**
-   * Glob patterns for files that should be type aware.
-   * @default ['**\/*.{ts,tsx}']
-   */
-  filesTypeAware?: string[];
-}
-
-export interface OptionsTypeScriptWithTypes {
-  /**
-   * When this options is provided, type aware rules will be enabled.
-   * @see https://typescript-eslint.io/linting/typed-linting/
-   */
-  tsconfigPath?: string | string[];
-}
-
-export interface OptionsHasTypeScript {
-  typescript?: boolean;
-}
-
-export interface OptionsStylistic {
-  stylistic?: boolean | StylisticConfig;
-}
-
-export interface StylisticConfig extends StylisticCustomizeOptions {
-}
-
-export interface OptionsOverrides {
-  overrides?: FlatConfigItem["rules"];
-}
-
-export interface OptionsIsInEditor {
-  isInEditor?: boolean;
-}
-
-export interface OptionsUnoCSS extends OptionsOverrides {
-  /**
-   * Enable attributify support.
-   * @default true
-   */
-  attributify?: boolean;
-  /**
-   * Enable strict mode by throwing errors about blocklisted classes.
-   * @default false
-   */
-  strict?: boolean;
-}
-
-export interface OptionsConfig extends OptionsComponentExts {
-  /**
-   * Enable gitignore support.
-   *
-   * Passing an object to configure the options.
-   *
-   * @see https://github.com/antfu/eslint-config-flat-gitignore
-   * @default true
-   */
-  gitignore?: boolean | FlatGitignoreOptions;
-
-  /**
-   * 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.
-   *
-   * Currently only stylistic rules are included.
-   *
-   * @default true
-   */
-  jsx?: boolean;
-
-  /**
-   * Enable test support.
-   *
-   * @default true
-   */
-  test?: boolean | OptionsOverrides;
-
-  /**
-   * Enable Vue support.
-   *
-   * @default auto-detect based on the dependencies
-   */
-  vue?: boolean | OptionsVue;
-
-  /**
-   * Enable JSONC support.
-   *
-   * @default true
-   */
-  jsonc?: boolean | OptionsOverrides;
-
-  /**
-   * Enable YAML support.
-   *
-   * @default true
-   */
-  yaml?: boolean | OptionsOverrides;
-
-  /**
-   * Enable TOML support.
-   *
-   * @default true
-   */
-  toml?: boolean | OptionsOverrides;
-
-  /**
-   * Enable linting for **code snippets** in Markdown.
-   *
-   * For formatting Markdown content, enable also `formatters.markdown`.
-   *
-   * @default true
-   */
-  markdown?: boolean | OptionsOverrides;
-
-  /**
-   * Enable stylistic rules.
-   *
-   * @default true
-   */
-  stylistic?: boolean | (StylisticConfig & OptionsOverrides);
-
-  /**
-   * Enable react rules.
-   *
-   * Requires installing:
-   * - `eslint-plugin-react`
-   * - `eslint-plugin-react-hooks`
-   * - `eslint-plugin-react-refresh`
-   *
-   * @default false
-   */
-  react?: boolean | OptionsOverrides;
-
-  /**
-   * Enable svelte rules.
-   *
-   * Requires installing:
-   * - `eslint-plugin-svelte`
-   *
-   * @default false
-   */
-  svelte?: boolean;
-
-  /**
-   * Enable unocss rules.
-   *
-   * Requires installing:
-   * - `@unocss/eslint-plugin`
-   *
-   * @default false
-   */
-  unocss?: boolean | OptionsUnoCSS;
-
-  /**
-   * Use external formatters to format files.
-   *
-   * Requires installing:
-   * - `eslint-plugin-format`
-   *
-   * When set to `true`, it will enable all formatters.
-   *
-   * @default false
-   */
-  formatters?: boolean | OptionsFormatters;
-
-  /**
-   * Control to disable some rules in editors.
-   * @default auto-detect based on the process.env
-   */
-  isInEditor?: boolean;
-
-  /**
-   * Provide overrides for rules for each integration.
-   *
-   * @deprecated use `overrides` option in each integration key instead
-   */
-  overrides?: {
-    stylistic?: FlatConfigItem["rules"];
-    javascript?: FlatConfigItem["rules"];
-    typescript?: FlatConfigItem["rules"];
-    test?: FlatConfigItem["rules"];
-    vue?: FlatConfigItem["rules"];
-    jsonc?: FlatConfigItem["rules"];
-    markdown?: FlatConfigItem["rules"];
-    yaml?: FlatConfigItem["rules"];
-    toml?: FlatConfigItem["rules"];
-    react?: FlatConfigItem["rules"];
-    svelte?: FlatConfigItem["rules"];
-  };
-}

package/src/utils.ts

@@ -1,76 +0,0 @@
-import process from "node:process";
-import { isPackageExists } from "local-pkg";
-import type { Awaitable, UserConfigItem } from "./types";
-
-export const parserPlain = {
-  meta: {
-    name: "parser-plain"
-  },
-  parseForESLint: (code: string) => ({
-    ast: {
-      body: [],
-      comments: [],
-      loc: { end: code.length, start: 0 },
-      range: [0, code.length],
-      tokens: [],
-      type: "Program"
-    },
-    scopeManager: null,
-    services: { isPlain: true },
-    visitorKeys: {
-      Program: []
-    }
-  })
-};
-
-/**
- * Combine array and non-array configs into a single array.
- */
-export async function combine(...configs: Awaitable<UserConfigItem | UserConfigItem[]>[]): Promise<UserConfigItem[]> {
-  const resolved = await Promise.all(configs);
-  return resolved.flat();
-}
-
-export function renameRules(rules: Record<string, any>, from: string, to: string) {
-  return Object.fromEntries(
-    Object.entries(rules)
-      .map(([key, value]) => {
-        if (key.startsWith(from)) {
-          return [to + key.slice(from.length), value];
-        }
-        return [key, value];
-      })
-  );
-}
-
-export function toArray<T>(value: T | T[]): T[] {
-  return Array.isArray(value) ? value : [value];
-}
-
-export async function interopDefault<T>(m: Awaitable<T>): Promise<T extends { default: infer U } ? U : T> {
-  const resolved = await m;
-  return (resolved as any).default || resolved;
-}
-
-export async function ensurePackages(packages: string[]) {
-  if (process.env.CI || process.stdout.isTTY === false) {
-    return;
-  }
-
-  const nonExistingPackages = packages.filter(i => !isPackageExists(i));
-  if (nonExistingPackages.length === 0) {
-    return;
-  }
-
-  const { default: prompts } = await import("prompts");
-  const { result } = await prompts([
-    {
-      message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?`,
-      name: "result",
-      type: "confirm"
-    }
-  ]);
-  if (result) {
-    await import("@antfu/install-pkg").then(i => i.installPackage(nonExistingPackages, { dev: true }));
-  }
-}

package/src/vender/prettier-types.ts

@@ -1,136 +0,0 @@
-/**
- * Vendor types from Prettier so we don't rely on the dependency.
- */
-
-export type VendoredPrettierOptions = Partial<VendoredPrettierOptionsRequired>;
-
-export interface VendoredPrettierOptionsRequired {
-  /**
-   * Specify the line length that the printer will wrap on.
-   * @default 120
-   */
-  printWidth: number;
-  /**
-   * Specify the number of spaces per indentation-level.
-   */
-  tabWidth: number;
-  /**
-   * Indent lines with tabs instead of spaces
-   */
-  useTabs?: boolean;
-  /**
-   * Print semicolons at the ends of statements.
-   */
-  semi: boolean;
-  /**
-   * Use single quotes instead of double quotes.
-   */
-  singleQuote: boolean;
-  /**
-   * Use single quotes in JSX.
-   */
-  jsxSingleQuote: boolean;
-  /**
-   * Print trailing commas wherever possible.
-   */
-  trailingComma: "none" | "es5" | "all";
-  /**
-   * Print spaces between brackets in object literals.
-   */
-  bracketSpacing: boolean;
-  /**
-   * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
-   * alone on the next line (does not apply to self closing elements).
-   */
-  bracketSameLine: boolean;
-  /**
-   * Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
-   * @deprecated use bracketSameLine instead
-   */
-  jsxBracketSameLine: boolean;
-  /**
-   * Format only a segment of a file.
-   */
-  rangeStart: number;
-  /**
-   * Format only a segment of a file.
-   * @default Number.POSITIVE_INFINITY
-   */
-  rangeEnd: number;
-  /**
-   * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
-   * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
-   * @default "preserve"
-   */
-  proseWrap: "always" | "never" | "preserve";
-  /**
-   * Include parentheses around a sole arrow function parameter.
-   * @default "always"
-   */
-  arrowParens: "avoid" | "always";
-  /**
-   * Provide ability to support new languages to prettier.
-   */
-  plugins: Array<string | any>;
-  /**
-   * How to handle whitespaces in HTML.
-   * @default "css"
-   */
-  htmlWhitespaceSensitivity: "css" | "strict" | "ignore";
-  /**
-   * Which end of line characters to apply.
-   * @default "lf"
-   */
-  endOfLine: "auto" | "lf" | "crlf" | "cr";
-  /**
-   * Change when properties in objects are quoted.
-   * @default "as-needed"
-   */
-  quoteProps: "as-needed" | "consistent" | "preserve";
-  /**
-   * Whether or not to indent the code inside <script> and <style> tags in Vue files.
-   * @default false
-   */
-  vueIndentScriptAndStyle: boolean;
-  /**
-   * Enforce single attribute per line in HTML, Vue and JSX.
-   * @default false
-   */
-  singleAttributePerLine: boolean;
-}
-
-export type BuiltInParserName =
-  | "acorn"
-  | "angular"
-  | "babel-flow"
-  | "babel-ts"
-  | "babel"
-  | "css"
-  | "espree"
-  | "flow"
-  | "glimmer"
-  | "graphql"
-  | "html"
-  | "json-stringify"
-  | "json"
-  | "json5"
-  | "less"
-  | "lwc"
-  | "markdown"
-  | "mdx"
-  | "meriyah"
-  | "scss"
-  | "typescript"
-  | "vue"
-  | "yaml";
-
-// This utility is here to handle the case where you have an explicit union
-// between string literals and the generic string type. It would normally
-// resolve out to just the string type, but this generic LiteralUnion maintains
-// the intellisense of the original union.
-//
-// It comes from this issue: microsoft/TypeScript#29729:
-//   https://github.com/microsoft/TypeScript/issues/29729#issuecomment-700527227
-export type LiteralUnion<T extends U, U = string> =
-  | T
-  | (Pick<U, never> & { _?: never | undefined });

package/test/cli.spec.ts

@@ -1,90 +0,0 @@
-import { join } from "node:path";
-import process from "node:process";
-import { execa } from "execa";
-import fs from "fs-extra";
-import { afterAll, beforeEach, expect, it } from "vitest";
-
-const CLI_PATH = join(__dirname, "../bin/index.js");
-const genPath = join(__dirname, "..", ".temp");
-
-async function run(env = {
-  SKIP_PROMPT: "1",
-  SKIP_GIT_CHECK: "1"
-}) {
-  return execa("node", [CLI_PATH, "migrate"], {
-    cwd: genPath,
-    env: {
-      ...process.env,
-      NO_COLOR: "1",
-      ...env
-    }
-  });
-};
-
-async function createMockDir() {
-  await fs.rm(genPath, { recursive: true, force: true });
-  await fs.ensureDir(genPath);
-
-  await Promise.all([
-    fs.writeFile(join(genPath, "package.json"), JSON.stringify({}, null, 2)),
-    fs.writeFile(join(genPath, ".eslintrc.yml"), ""),
-    fs.writeFile(join(genPath, ".eslintignore"), "some-path\nsome-file"),
-    fs.writeFile(join(genPath, ".prettierc"), ""),
-    fs.writeFile(join(genPath, ".prettierignore"), "some-path\nsome-file")
-  ]);
-};
-
-beforeEach(async () => await createMockDir());
-afterAll(async () => await fs.rm(genPath, { recursive: true, force: true }));
-
-it("package.json updated", async () => {
-  const { stdout } = await run();
-
-  const pkgContent: Record<string, any> = await fs.readJSON(join(genPath, "package.json"));
-
-  expect(JSON.stringify(pkgContent.devDependencies)).toContain("@antfu/eslint-config");
-  expect(stdout).toContain("changes wrote to package.json");
-});
-
-it("esm eslint.config.js", async () => {
-  const pkgContent = await fs.readFile("package.json", "utf-8");
-  await fs.writeFile(join(genPath, "package.json"), JSON.stringify({ ...JSON.parse(pkgContent), type: "module" }, null, 2));
-
-  const { stdout } = await run();
-
-  const eslintConfigContent = await fs.readFile(join(genPath, "eslint.config.js"), "utf-8");
-  expect(eslintConfigContent.includes("export default")).toBeTruthy();
-  expect(stdout).toContain("created eslint.config.js");
-});
-
-it("cjs eslint.config.js", async () => {
-  const { stdout } = await run();
-
-  const eslintConfigContent = await fs.readFile(join(genPath, "eslint.config.js"), "utf-8");
-  expect(eslintConfigContent.includes("module.exports")).toBeTruthy();
-  expect(stdout).toContain("created eslint.config.js");
-});
-
-it("ignores files added in eslint.config.js", async () => {
-  const { stdout } = await run();
-
-  const eslintConfigContent = (await fs.readFile(join(genPath, "eslint.config.js"), "utf-8")).replace(/\\/g, "/");
-
-  expect(stdout).toContain("created eslint.config.js");
-  expect(eslintConfigContent)
-    .toMatchInlineSnapshot(`
-      "const antfu = require('@antfu/eslint-config').default
-
-      module.exports = antfu({
-      ignores: ["some-path","**/some-path/**","some-file","**/some-file/**"]
-      })
-      "
-    `);
-});
-
-it("suggest remove unnecessary files", async () => {
-  const { stdout } = await run();
-
-  expect(stdout).toContain("you can now remove those files manually");
-  expect(stdout).toContain(".eslintignore, .eslintrc.yml, .prettierc, .prettierignore, eslint.config.js");
-});