@antfu/eslint-config 1.0.0-beta.0 → 1.0.0-beta.2

package/README.md

@@ -0,0 +1,289 @@
+# @antfu/eslint-config
+
+[![npm](https://img.shields.io/npm/v/@antfu/eslint-config?color=444&label=)](https://npmjs.com/package/@antfu/eslint-config) [![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+
+- Single quotes, no semi
+- Auto fix for formatting (aimed to be used standalone **without** Prettier)
+- Designed to work with TypeScript, Vue out-of-box
+- Lint also for json, yaml, markdown
+- Sorted imports, dangling commas
+- Reasonable defaults, best practices, only one-line of config
+- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
+- Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
+- **Style principle**: Minimal for reading, stable for diff
+
+> [!IMPORTANT]
+> The main branch is for v1.0-beta, which rewrites to ESLint Flat config, check [#250](https://github.com/antfu/eslint-config/pull/250) for more details.
+
+## Usage
+
+### Install
+
+```bash
+pnpm add -D eslint @antfu/eslint-config
+```
+
+### Create config file
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu()
+```
+
+> You don't need `.eslintignore` normally as it has been provided by the preset.
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+## VS Code support (auto fix)
+
+Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+Add the following settings to your `settings.json`:
+
+```jsonc
+{
+  // Enable the flat config support
+  "eslint.experimental.useFlatConfig": true,
+
+  // Disable the default formatter
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.organizeImports": false
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    { "rule": "@stylistic/*", "severity": "off" },
+    { "rule": "*-indent", "severity": "off" },
+    { "rule": "*-spacing", "severity": "off" },
+    { "rule": "*-spaces", "severity": "off" },
+    { "rule": "*-order", "severity": "off" },
+    { "rule": "*-dangle", "severity": "off" },
+    { "rule": "*-newline", "severity": "off" },
+    { "rule": "*quotes", "severity": "off" },
+    { "rule": "*semi", "severity": "off" }
+  ],
+
+  // The following is optional.
+  // It's better to put under project setting `.vscode/settings.json`
+  // to avoid conflicts with working with different eslint configs
+  // that does not support all formats.
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+}
+```
+
+## Customization
+
+Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), provides a much better organization and composition.
+
+Normally you only need to import the `antfu` preset:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu()
+```
+
+You can configure each feature individually, for example:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  stylistic: true, // enable stylistic formatting rules
+  typescript: true,
+  vue: true,
+  jsonc: false,
+  yml: false,
+})
+```
+
+The `antfu` factory functions also accepts arbitrary numbers of constom configs overrides:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu(
+  {
+    // Configures for antfu's config
+  },
+
+  // From the second arguments they are ESLint Flat Configs
+  // you can have multiple configs
+  {
+    rules: {},
+  },
+  {
+    rules: {},
+  },
+)
+```
+
+Going more advanced, you can also import the very fine-grained configs and compose them as you wish:
+
+```js
+// eslint.config.js
+import {
+  comments,
+  ignores,
+  imports,
+  javascript,
+  javascriptStylistic,
+  jsdoc,
+  jsonc,
+  markdown,
+  node,
+  sortPackageJson,
+  sortTsconfig,
+  typescript,
+  typescriptStylistic,
+  unicorn,
+  vue,
+  yml,
+} from '@antfu/eslint-config'
+
+export default [
+  ...ignores,
+  ...javascript(),
+  ...comments,
+  ...node,
+  ...jsdoc,
+  ...imports,
+  ...unicorn,
+  ...javascriptStylistic,
+
+  ...typescript(),
+  ...typescriptStylistic,
+
+  ...vue(),
+  ...jsonc,
+  ...yml,
+  ...markdown(),
+]
+```
+
+Check out the [configs](https://github.com/antfu/eslint-config/blob/main/src/configs) and [factory](https://github.com/antfu/eslint-config/blob/main/src/factory.ts) for more details.
+
+> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.
+
+## Plugins Renaming
+
+Since flat config support explicit provides the plugin names, we renamed some plugins to make them more consistent and hide the implementation details.
+
+| Original Prefix | New Prefix | Source Plugin |
+| --------------- | ---------- | ------------- |
+| `i/*` | `import/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
+| `n/*` | `node` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)
+| `@typescript-eslint/*` | `ts/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `@stylistic/js` | `style/*` | [@stylistic/eslint-plugin-js](https://github.com/eslint-stylistic/eslint-stylistic) |
+| `@stylistic/ts` | `style-ts/` | [@stylistic/eslint-plugin-ts](https://github.com/eslint-stylistic/eslint-stylistic) |
+
+When you want to overrides rules, or disable them inline, you need to update to the new prefix:
+
+```diff
+-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
++// eslint-disable-next-line ts/consistent-type-definitions
+type foo = { bar: 2 }
+```
+
+### Type Aware Rules
+
+You can optionally enable the [type aware rules](https://typescript-eslint.io/linting/typed-linting/) by passing the options object to the `typescript` config:
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+  typescript: {
+    tsconfigPath: 'tsconfig.json',
+  },
+})
+```
+
+### Lint Staged
+
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## Badge
+
+If you enjoy this code style, and would like to mention it in your project, here is the badge you can use:
+
+```md
+[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+```
+
+[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)
+
+## FAQ
+
+### Prettier?
+
+[Why I don't use Prettier](https://antfu.me/posts/why-not-prettier)
+
+### How to lint CSS?
+
+This config does NOT lint CSS. I personally use [UnoCSS](https://github.com/unocss/unocss) so I don't write CSS. If you still prefer CSS, you can use [stylelint](https://stylelint.io/) for CSS linting.
+
+### I prefer XXX...
+
+Sure, you can config and override rules locally in your project to fit your needs. If that still does not work for you, you can always fork this repo and maintain your own.
+
+## Check Also
+
+- [antfu/dotfiles](https://github.com/antfu/dotfiles) - My dotfiles
+- [antfu/vscode-settings](https://github.com/antfu/vscode-settings) - My VS Code settings
+- [antfu/ts-starter](https://github.com/antfu/ts-starter) - My starter template for TypeScript library
+- [antfu/vitesse](https://github.com/antfu/vitesse) - My starter template for Vue & Vite app
+
+## License
+
+[MIT](./LICENSE) License © 2019-PRESENT [Anthony Fu](https://github.com/antfu)

package/dist/index.d.ts

@@ -0,0 +1,149 @@
+import { FlatESLintConfigItem } from 'eslint-define-config';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
+export { default as pluginComments } from 'eslint-plugin-eslint-comments';
+export { default as pluginImport } from 'eslint-plugin-i';
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+export { default as pluginMarkdown } from 'eslint-plugin-markdown';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginStylisticJs } from '@stylistic/eslint-plugin-js';
+export { default as pluginStylisticTs } from '@stylistic/eslint-plugin-ts';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginVue } from 'eslint-plugin-vue';
+export { default as pluginYml } from 'eslint-plugin-yml';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as parserTs } from '@typescript-eslint/parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYml } from 'yaml-eslint-parser';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptWithLanguageServer {
+    tsconfigPath: string;
+    tsconfigRootDir?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsConfig {
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithLanguageServer;
+    /**
+     * 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;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+}
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function antfu(options?: OptionsConfig, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+
+declare const comments: FlatESLintConfigItem[];
+
+declare const ignores: FlatESLintConfigItem[];
+
+declare const imports: FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare const jsdoc: FlatESLintConfigItem[];
+
+declare const jsonc: FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const node: FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortPackageJson: FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortTsconfig: FlatESLintConfigItem[];
+
+declare const javascriptStylistic: FlatESLintConfigItem[];
+declare const typescriptStylistic: FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts): FlatESLintConfigItem[];
+declare function typescriptWithLanguageServer(options: OptionsTypeScriptWithLanguageServer & OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const unicorn: FlatESLintConfigItem[];
+
+declare function vue(options?: OptionsHasTypeScript): FlatESLintConfigItem[];
+
+declare const yml: FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+export { OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsTypeScriptWithLanguageServer, antfu, combine, comments, antfu as default, ignores, imports, javascript, javascriptStylistic, jsdoc, jsonc, markdown, node, renameRules, sortPackageJson, sortTsconfig, test, typescript, typescriptStylistic, typescriptWithLanguageServer, unicorn, vue, yml };