@coderwyd/eslint-config 1.1.0 → 2.0.0

package/README.md

@@ -7,14 +7,13 @@
 ## Feature
 
 - ✨ Single quotes, no semi
-- 🛠️ Auto fix for formatting (aimed to be used standalone **without** Prettier)
+- 🛠️ Auto fix for formatting
 - 🎯 Designed to work with TypeScript, Vue out-of-box
-- 🔍 Lints also for json, yaml, markdown
+- 🔍 Lints also for json
 - 🧩 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, consistent
+- 🎨 Use ESlint and Prettier to format HTML, CSS, LESS, SCSS, YAML, TOML, Markdown.
 
 ## Usage
 
@@ -30,18 +29,18 @@ With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package
 
 ```js
 // eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
+import { defineConfig } from '@coderwyd/eslint-config'
 
-export default coderwyd()
+export default defineConfig()
 ```
 
 With CJS:
 
 ```js
 // eslint.config.js
-const coderwyd = require('@coderwyd/eslint-config').default
+const { defineConfig } = require('@coderwyd/eslint-config')
 
-module.exports = coderwyd()
+module.exports = defineConfig()
 ```
 
 > Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.
@@ -80,237 +79,22 @@ Add the following settings to your `.vscode/settings.json`:
     "source.organizeImports": "never"
   },
 
-  // Silent the stylistic rules in you IDE, but still auto fix them
-  "eslint.rules.customizations": [
-    { "rule": "style/*", "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" }
-  ],
-
   // Enable eslint for all supported languages
   "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact",
-    "vue",
     "html",
-    "markdown",
+    "css",
+    "less",
+    "scss",
     "json",
     "jsonc",
-    "yaml"
+    "yaml",
+    "yml",
+    "markdown",
+    "toml"
   ]
 }
 ```
 
-## Customization
-
-Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides a much better organization and composition.
-
-Normally you only need to import the `coderwyd` preset:
-
-```js
-// eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd()
-```
-
-And that's it! Or you can configure each integration individually, for example:
-
-```js
-// eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd({
-  stylistic: true, // enable stylistic formatting rules
-  typescript: true,
-  vue: true,
-  jsonc: false, // disable jsonc support
-  yaml: false,
-
-  // `.eslintignore` is no longer supported in Flat config, use `ignores` instead
-  ignores: [
-    './fixtures',
-    // ...globs
-  ]
-})
-```
-
-The `coderwyd` factory function also accepts any number of arbitrary custom config overrides:
-
-```js
-// eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd(
-  {
-    // Configures for coderwyd's config
-  },
-
-  // From the second arguments they are ESLint Flat Configs
-  // you can have multiple configs
-  {
-    files: ['**/*.ts'],
-    rules: {},
-  },
-  {
-    rules: {},
-  },
-)
-```
-
-Going more advanced, you can also import fine-grained configs and compose them as you wish:
-
-```js
-// eslint.config.js
-import {
-  astro,
-  comments,
-  ignores,
-  imports,
-  javascript,
-  jsdoc,
-  jsonc,
-  markdown,
-  node,
-  react,
-  sortPackageJson,
-  sortTsconfig,
-  stylistic,
-  typescript,
-  unicorn,
-  vue,
-  yaml,
-} from '@coderwyd/eslint-config'
-
-export default [
-  ...astro(),
-  ...react(),
-  ...ignores(),
-  ...javascript(),
-  ...comments(),
-  ...node(),
-  ...jsdoc(),
-  ...imports(),
-  ...unicorn(),
-  ...typescript(),
-  ...stylistic(),
-  ...vue(),
-  ...jsonc(),
-  ...yaml(),
-  ...markdown(),
-]
-```
-
-Check out the [configs](https://github.com/coderwyd/eslint-config/blob/main/src/configs) and [factory](https://github.com/coderwyd/eslint-config/blob/main/src/factory.ts) for more details.
-
-## Plugins Renaming
-
-Since flat config requires us to explicitly provide the plugin names (instead of mandatory convention from npm package name), we renamed some plugins to make overall scope more consistent and easier to write.
-
-| New Prefix | Original Prefix | Source Plugin |
-| --- | --- | --- |
-| `import/*` | `i/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
-| `node/*` | `n/*` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) |
-| `yaml/*` | `yml/*` | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) |
-| `ts/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
-| `style/*` | `@stylistic/*` | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic) |
-| `test/*` | `vitest/*` | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest) |
-| `test/*` | `no-only-tests/*` | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests) |
-
-When you want to override 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 }
-```
-
-### Rules Overrides
-
-Certain rules would only be enabled in specific files, for example, `ts/*` rules would only be enabled in `.ts` files and `vue/*` rules would only be enabled in `.vue` files. If you want to override the rules, you need to specify the file extension:
-
-```js
-// eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd(
-  {
-    // Enable stylistic formatting rules
-    // stylistic: true,
-
-    // Or customize the stylistic rules
-    stylistic: {
-      indent: 2, // 4, or 'tab'
-      quotes: 'single', // or 'double'
-    },
-
-    // TypeScript and Vue are auto-detected, you can also explicitly enable them:
-    typescript: true,
-    vue: true,
-
-    // Disable jsonc and yaml support
-    jsonc: false,
-    yaml: false,
-  },
-  {
-    // Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
-    files: ['**/*.vue'],
-    rules: {
-      'vue/operator-linebreak': ['error', 'before'],
-    },
-  },
-  {
-    // Without `files`, they are general rules for all files
-    rules: {
-      'style/semi': ['error', 'never'],
-    },
-  }
-)
-```
-
-We also provided an `overrides` options to make it easier:
-
-```js
-// eslint.config.js
-import coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd({
-  overrides: {
-    vue: {
-      'vue/operator-linebreak': ['error', 'before'],
-    },
-    typescript: {
-      'ts/consistent-type-definitions': ['error', 'interface'],
-    },
-    yaml: {},
-    // ...
-  }
-})
-```
-
-### 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 coderwyd from '@coderwyd/eslint-config'
-
-export default coderwyd({
-  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`:

package/dist/cli.cjs

@@ -46,32 +46,30 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "1.1.0";
+var version = "2.0.0";
 var devDependencies = {
-  "@antfu/ni": "^0.21.10",
-  "@stylistic/eslint-plugin-migrate": "^1.4.0",
-  "@types/eslint": "^8.44.7",
+  "@antfu/ni": "^0.21.12",
+  "@types/eslint": "^8.56.0",
   "@types/fs-extra": "^11.0.4",
-  "@types/node": "^20.9.4",
+  "@types/node": "^20.10.5",
   "@types/prompts": "^2.4.9",
   "@types/yargs": "^17.0.32",
-  "@unocss/eslint-plugin": "^0.57.7",
-  bumpp: "^9.2.0",
-  eslint: "^8.54.0",
-  "eslint-flat-config-viewer": "^0.1.3",
+  "@unocss/eslint-plugin": "^0.58.2",
+  bumpp: "^9.2.1",
+  eslint: "^8.56.0",
+  "eslint-flat-config-viewer": "^0.1.4",
   "eslint-plugin-react": "^7.33.2",
   "eslint-plugin-react-hooks": "^4.6.0",
-  "eslint-plugin-react-refresh": "^0.4.4",
+  "eslint-plugin-react-refresh": "^0.4.5",
   esno: "^4.0.0",
   execa: "^8.0.1",
   "fast-glob": "^3.3.2",
-  "fs-extra": "^11.1.1",
-  "lint-staged": "^15.1.0",
+  "fs-extra": "^11.2.0",
+  "lint-staged": "^15.2.0",
   rimraf: "^5.0.5",
   "simple-git-hooks": "^2.9.0",
   tsup: "^8.0.1",
-  typescript: "^5.3.2",
-  vitest: "^0.34.6"
+  typescript: "^5.3.3"
 };
 
 // src/cli/constants.ts
@@ -94,31 +92,20 @@ var vscodeSettingsString = `
     "source.organizeImports": "never"
   },
 
-  // Silent the stylistic rules in you IDE, but still auto fix them
-  "eslint.rules.customizations": [
-    { "rule": "style/*", "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" }
-  ],
-
   // Enable eslint for all supported languages
   "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact",
-    "vue",
+    "svelte",
+    "astro",
     "html",
-    "markdown",
+    "css",
+    "less",
+    "scss",
     "json",
     "jsonc",
-    "yaml"
+    "yaml",
+    "yml",
+    "markdown",
+    "toml"
   ]
 `;
 
@@ -142,11 +129,23 @@ async function run(options = {}) {
   const pathPackageJSON = import_node_path.default.join(cwd, "package.json");
   const pathESLintIngore = import_node_path.default.join(cwd, ".eslintignore");
   if (import_node_fs.default.existsSync(pathFlatConfig)) {
-    console.log(import_picocolors2.default.yellow(`${WARN} eslint.config.js already exists, migration wizard exited.`));
-    return;
+    console.log(
+      import_picocolors2.default.yellow(
+        `${WARN} eslint.config.js already exists, migration wizard exited.`
+      )
+    );
+    return import_node_process.default.exit(1);
+  }
+  if (!SKIP_GIT_CHECK && !isGitClean()) {
+    const { confirmed } = await (0, import_prompts.default)({
+      initial: false,
+      message: "There are uncommitted changes in the current repository, are you sure to continue?",
+      name: "confirmed",
+      type: "confirm"
+    });
+    if (!confirmed)
+      return import_node_process.default.exit(1);
   }
-  if (!SKIP_GIT_CHECK && !isGitClean())
-    throw new Error("There are uncommitted changes in the current repository, please commit them and try again");
   console.log(import_picocolors2.default.cyan(`${ARROW} bumping @coderwyd/eslint-config to v${version}`));
   const pkgContent = await import_promises.default.readFile(pathPackageJSON, "utf-8");
   const pkg = JSON.parse(pkgContent);
@@ -166,24 +165,26 @@ async function run(options = {}) {
       if (glob.type === "ignore")
         eslintIgnores.push(...glob.patterns);
       else if (glob.type === "unignore")
-        eslintIgnores.push(...glob.patterns.map((pattern) => `!${pattern}`));
+        eslintIgnores.push(
+          ...glob.patterns.map((pattern) => `!${pattern}`)
+        );
     }
   }
   let eslintConfigContent = "";
   const coderwydConfig = `${eslintIgnores.length ? `ignores: ${JSON.stringify(eslintIgnores)}` : ""}`;
   if (pkg.type === "module") {
     eslintConfigContent = `
-import coderwyd from '@coderwyd/eslint-config'
+import { defineConfig } from '@coderwyd/eslint-config'
 
-export default coderwyd({
+export default defineConfig({
 ${coderwydConfig}
 })
 `.trimStart();
   } else {
     eslintConfigContent = `
-const coderwyd = require('@coderwyd/eslint-config').default
+const { defineConfig } = require('@coderwyd/eslint-config')
 
-module.exports = coderwyd({
+module.exports = defineConfig({
 ${coderwydConfig}
 })
 `.trimStart();
@@ -205,22 +206,25 @@ ${coderwydConfig}
   };
   if (!SKIP_PROMPT) {
     try {
-      promptResult = await (0, import_prompts.default)({
-        initial: true,
-        message: "Update .vscode/settings.json for better VS Code experience?",
-        name: "updateVscodeSettings",
-        type: "confirm"
-      }, {
-        onCancel: () => {
-          throw new Error(`Cancelled`);
+      promptResult = await (0, import_prompts.default)(
+        {
+          initial: true,
+          message: "Update .vscode/settings.json for better VS Code experience?",
+          name: "updateVscodeSettings",
+          type: "confirm"
+        },
+        {
+          onCancel: () => {
+            throw new Error(`Cancelled`);
+          }
         }
-      });
+      );
     } catch (cancelled) {
       console.log(cancelled.message);
       return;
     }
   }
-  if (promptResult?.updateVscodeSettings ?? true) {
+  if ((promptResult == null ? void 0 : promptResult.updateVscodeSettings) ?? true) {
     const dotVscodePath = import_node_path.default.join(cwd, ".vscode");
     const settingsPath = import_node_path.default.join(dotVscodePath, "settings.json");
     if (!import_node_fs.default.existsSync(dotVscodePath))
@@ -240,8 +244,10 @@ ${coderwydConfig}
     }
   }
   console.log(import_picocolors2.default.green(`${CHECK} migration completed`));
-  console.log(`Now you can update the dependencies and run ${import_picocolors2.default.blue("eslint . --fix")}
-`);
+  console.log(
+    `Now you can update the dependencies and run ${import_picocolors2.default.blue("eslint . --fix")}
+`
+  );
 }
 
 // src/cli/index.ts
@@ -252,7 +258,11 @@ ${import_picocolors3.default.green(`@coderwyd/eslint-config `)}${import_picocolo
 var instance = (0, import_yargs.default)((0, import_helpers.hideBin)(import_node_process2.default.argv)).scriptName("@coderwyd/eslint-config").usage("").command(
   "*",
   "Run the initialization or migration",
-  (args) => args.option("yes", { alias: "y", description: "Skip prompts and use default values", type: "boolean" }).help(),
+  (args) => args.option("yes", {
+    alias: "y",
+    description: "Skip prompts and use default values",
+    type: "boolean"
+  }).help(),
   async (args) => {
     header();
     console.log();