@luxass/eslint-config 3.3.2 → 4.0.0-beta.0

package/README.md

@@ -1,16 +1,179 @@
 # @luxass/eslint-config
 
-## Installation
+> [!IMPORTANT]
+> The configuration is not currently finished, and the old config should be used. You can find it [here](https://github.com/luxass/eslint-config-legacy)
+
+
+## ✨ Features
+
+- Designed to work with JavaScript, Typescript, React, Svelte, Astro, Vue out of the box.
+- Support for JSON, YAML, Markdown
+- Sorted imports for `package.json` and `tsconfig.json`
+- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
+- Using [ESLint Stylistic](https://eslint.style/guide/why)
+
+## 📦 Install
 
 ```bash
 pnpm add -D eslint @luxass/eslint-config
 ```
 
-## Usage
+## 🚀 Usage
+```js
+// eslint.config.js
+import { luxass } from "@luxass/eslint-config";
 
-`.eslintrc`
-```json
+export default luxass();
+```
+
+## Setup for Visual Studio Code
+
+Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and add the following to your `.vscode/settings.json`:
+
+```jsonc
+// .vscode/settings.json
 {
-  "extends": "@luxass"
+  // will ensure that eslint can use the experimental flat config
+  "eslint.experimental.useFlatConfig": true,
+
+  // disable the default formatter
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // auto fix on save
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "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" }
+  ],
+
+  // 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
+
+Normally you would only need to import the `luxass` preset:
+
+```js
+// eslint.config.js
+import { luxass } from "@luxass/eslint-config";
+
+export default luxass();
+```
+
+you can also configure each `config` individually:
+
+```js
+// eslint.config.js
+import { luxass } from "@luxass/eslint-config";
+
+export default luxass({
+  typescript: true,
+  vue: true,
+  react: false,
+  astro: true,
+  svelte: false,
+  unocss: true,
+  stylistic: true
+});
+```
+
+The `luxass` function accepts an arbitrary number of `flat configs` overrides:
+
+```js
+// eslint.config.js
+import { luxass } from "@luxass/eslint-config";
+
+export default luxass({}, {
+  rules: {}
+}, {
+  rules: {}
+});
+```
+
+### Fine Grained Configurations
+
+If you want it more advanced, you can also just import the `config` you need.
+
+```js
+// eslint.config.js
+import {
+  astro,
+  comments,
+  ignores,
+  imports,
+  javascript,
+  javascriptStylistic,
+  jsdoc,
+  jsonc,
+  markdown,
+  node,
+  react,
+  sort,
+  svelte,
+  tailwindcss,
+  typescript,
+  typescriptStylistic,
+  unicorn,
+  unocss,
+  vue,
+  yml
+} from "@luxass/eslint-config/configs";
+
+export default [
+  ...astro,
+  ...comments,
+  ...ignores,
+  ...imports,
+  ...javascript,
+  ...javascriptStylistic,
+  ...jsdoc,
+  ...jsonc,
+  ...markdown,
+  ...node,
+  ...react,
+  ...sort,
+  ...svelte,
+  ...tailwindcss,
+  ...typescript,
+  ...typescriptStylistic,
+  ...unicorn,
+  ...unocss,
+  ...vue,
+  ...yml
+];
+```
+
+> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) and [antfu/eslint-config](https://github.com/antfu/eslint-config) for the inspiration and references.
+
+## 📄 License
+
+Published under [MIT License](./LICENSE).

package/dist/chunk-2SW2E3TH.mjs

@@ -0,0 +1,38 @@
+import {
+  default as default2,
+  pluginImport
+} from "./chunk-C5VMTRKT.mjs";
+
+// src/configs/imports.ts
+async function imports(options = {}) {
+  const {
+    stylistic = true
+  } = options;
+  return [
+    {
+      name: "luxass:imports",
+      plugins: {
+        antfu: default2,
+        import: pluginImport
+      },
+      rules: {
+        "antfu/import-dedupe": "error",
+        "antfu/no-import-node-modules-by-path": "error",
+        "import/first": "error",
+        "import/no-duplicates": "error",
+        "import/no-mutable-exports": "error",
+        "import/no-named-default": "error",
+        "import/no-self-import": "error",
+        "import/no-webpack-loader-syntax": "error",
+        "import/order": "error",
+        ...stylistic ? {
+          "import/newline-after-import": ["error", { considerComments: true, count: 1 }]
+        } : {}
+      }
+    }
+  ];
+}
+
+export {
+  imports
+};

package/dist/chunk-3JCJ7J5K.mjs

@@ -0,0 +1,64 @@
+import {
+  GLOB_YAML
+} from "./chunk-C6E356K2.mjs";
+import {
+  interop
+} from "./chunk-4VUK6ART.mjs";
+
+// src/configs/yaml.ts
+async function yaml(options = {}) {
+  const { overrides = {}, stylistic = true } = options;
+  const [
+    pluginYaml,
+    parserYaml
+  ] = await Promise.all([
+    interop(import("eslint-plugin-yml")),
+    interop(import("yaml-eslint-parser"))
+  ]);
+  return [
+    {
+      name: "luxass:yaml:setup",
+      plugins: {
+        yaml: pluginYaml
+      }
+    },
+    {
+      files: [GLOB_YAML],
+      languageOptions: {
+        parser: parserYaml
+      },
+      name: "luxass:yaml:rules",
+      rules: {
+        "style/spaced-comment": "off",
+        "yaml/block-mapping": "error",
+        "yaml/block-sequence": "error",
+        "yaml/no-empty-key": "error",
+        "yaml/no-empty-sequence-entry": "error",
+        "yaml/no-irregular-whitespace": "error",
+        "yaml/plain-scalar": "error",
+        "yaml/vue-custom-block/no-parsing-error": "error",
+        ...stylistic ? {
+          "yaml/block-mapping-question-indicator-newline": "error",
+          "yaml/block-sequence-hyphen-indicator-newline": "error",
+          "yaml/flow-mapping-curly-newline": "error",
+          "yaml/flow-mapping-curly-spacing": "error",
+          "yaml/flow-sequence-bracket-newline": "error",
+          "yaml/flow-sequence-bracket-spacing": "error",
+          "yaml/indent": ["error", 2],
+          "yaml/key-spacing": "error",
+          "yaml/no-tab-indent": "error",
+          "yaml/quotes": [
+            "error",
+            { avoidEscape: false, prefer: "double" }
+          ],
+          "yaml/spaced-comment": "error"
+        } : {},
+        ...overrides
+      }
+    }
+  ];
+}
+
+export {
+  yaml
+};

package/dist/chunk-4HH6LYJ6.mjs

@@ -0,0 +1,25 @@
+import {
+  default2
+} from "./chunk-C5VMTRKT.mjs";
+
+// src/configs/comments.ts
+async function comments() {
+  return [
+    {
+      name: "luxass:eslint-comments",
+      plugins: {
+        "eslint-comments": default2
+      },
+      rules: {
+        "eslint-comments/no-aggregating-enable": "error",
+        "eslint-comments/no-duplicate-disable": "error",
+        "eslint-comments/no-unlimited-disable": "error",
+        "eslint-comments/no-unused-enable": "error"
+      }
+    }
+  ];
+}
+
+export {
+  comments
+};

package/dist/chunk-4VUK6ART.mjs

@@ -0,0 +1,29 @@
+// src/utils.ts
+async function combine(...configs) {
+  const resolved = await Promise.all(configs);
+  return resolved.flat();
+}
+function renameRules(rules, from, to) {
+  return Object.fromEntries(
+    Object.entries(rules).map(([key, value]) => {
+      if (key.startsWith(from)) {
+        return [to + key.slice(from.length), value];
+      }
+      return [key, value];
+    })
+  );
+}
+function toArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
+async function interop(m) {
+  const resolved = await m;
+  return resolved.default || resolved;
+}
+
+export {
+  combine,
+  renameRules,
+  toArray,
+  interop
+};