@kouts/eslint-config 0.0.14 → 1.0.0

package/README.md

@@ -1,38 +1,67 @@
 # @kouts/eslint-config
 
-> Custom ESLint and Prettier config with sensible defaults
+> Custom ESLint and Prettier config with Vue.js support and sensible defaults
+
+> [!NOTE]  
+> Starting from v1, this ESLint config uses the [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) and is only compatible with ESLint v9 or v8.50.0+.  
+> If you're looking for the previous version, checkout the [README]('./README_V0.md') here.
 
 ## Installation
 
 ```bash
-npm i -D @kouts/eslint-config eslint prettier
+pnpm i -D @kouts/eslint-config eslint prettier
 ```
 
 ## Usage
 
-There are 4 ESLint config presets that you can use:
+### ESLint config
+
+Add an `eslint.config.js` (or `eslint.config.cjs` if your project is CommonJS) that imports the `config` function:
+
+```javascript
+import { config } from '@kouts/eslint-config'
+
+export default [
+  ...config(),
+  {
+    // Add custom rules here
+  }
+]
+```
 
-- `@kouts/eslint-config/javascript` for JavaScript / TypeScript projects
-- `@kouts/eslint-config/vue2` for Vue.js 2 projects
-- `@kouts/eslint-config/vue3` for Vue.js 3 projects
-- `@kouts/eslint-config/vue3-typescript` for Vue.js 3 / TypeScript projects
-- `@kouts/eslint-config/nuxt3` for Nuxt 3 projects
+#### Customizing the config
 
-Add the desired config preset into your `.eslintrc.js` file:
+You can customize the config by passing an object to the `config` function:
 
 ```javascript
-module.exports = {
-  extends: ['@kouts/eslint-config/vue2']
-}
+config({
+  ts: true,
+  vue: true
+  vueVersion: 3
+})
 ```
 
-Add a `prettier.config.js` file with contents:
+**Available options:**
+
+| Option     | Type       | Description                   | Default |
+| ---------- | ---------- | ----------------------------- | ------- |
+| ts         | `boolean`  | Enable TypeScript support     | `true`  |
+| vue        | `boolean`  | Enable Vue.js support         | `true`  |
+| vueVersion | `2` or `3` | Specify the version of Vue.js | `3`     |
+
+### Prettier config
+
+Create a `prettier.config.js` file with the following content:
 
 ```javascript
-module.exports = require('@kouts/eslint-config/prettier.config.js')
+import prettierConfig from '@kouts/eslint-config/prettier'
+
+export default prettierConfig
 ```
 
-You can add ESLint commands to `.package-json`
+### package.json scripts
+
+Add the following ESLint commands to your `.package-json` for linting and autofixing:
 
 ```json
 {
@@ -41,7 +70,9 @@ You can add ESLint commands to `.package-json`
 }
 ```
 
-and VS Code settings for autofix on save
+### VS Code settings
+
+Ad the following settings to your VS Code project settings for autofix on save:
 
 `.vscode/settings.json`
 
@@ -50,20 +81,27 @@ and VS Code settings for autofix on save
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   }
 }
 ```
 
 ## Features
 
-- Based on [eslint-config-standard](https://github.com/standard/eslint-config-standard)
+- Based on [neostandard](https://github.com/neostandard/neostandard)
 - [Prettier](https://prettier.io) for code formatting
 - Plugins
   - [eslint-plugin-html](https://github.com/BenoitZugmeyer/eslint-plugin-html) for linting inline scripts contained in HTML files
   - [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue/) for linting Vue.js files
   - [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) for disabling all rules that conflict with Prettier
-  - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) for using prettier as a code formatter for `eslint --fix`
-  - [sort-imports-es6-autofix](https://github.com/marudor/eslint-plugin-sort-imports-es6-autofix) for auto-fixing imports order
+  - [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) for using Prettier as a code formatter with `eslint --fix`
+  - [eslint-plugin-simple-import-sort](https://github.com/lydell/eslint-plugin-simple-import-sort) for auto-fixing imports order
+  - [eslint-plugin-import-x](https://github.com/lydell/eslint-plugin-simple-import-sort) for auto-fixing import/export syntax, and prevent issues with misspelling of file paths and import names
 
 ## License
 

package/dist/index.cjs

@@ -0,0 +1,528 @@
+'use strict';
+
+var pluginHtml = require('eslint-plugin-html');
+var pluginImport = require('eslint-plugin-import-x');
+var pluginPrettier = require('eslint-plugin-prettier/recommended');
+var pluginSimpleImportSort = require('eslint-plugin-simple-import-sort');
+var neostandard = require('neostandard');
+var pluginVue = require('eslint-plugin-vue');
+
+function getDefaultExportFromCjs (x) {
+	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
+}
+
+/*
+ * WARNING: This file is autogenerated using the tools/update-eslint-all.js
+ * script. Do not edit manually.
+ */
+
+/* eslint quote-props: off -- autogenerated so don't lint */
+
+/*
+ * IMPORTANT!
+ *
+ * We cannot add a "name" property to this object because it's still used in eslintrc
+ * which doesn't support the "name" property. If we add a "name" property, it will
+ * cause an error.
+ */
+
+var eslintAll = Object.freeze({
+    "rules": {
+        "accessor-pairs": "error",
+        "array-callback-return": "error",
+        "arrow-body-style": "error",
+        "block-scoped-var": "error",
+        "camelcase": "error",
+        "capitalized-comments": "error",
+        "class-methods-use-this": "error",
+        "complexity": "error",
+        "consistent-return": "error",
+        "consistent-this": "error",
+        "constructor-super": "error",
+        "curly": "error",
+        "default-case": "error",
+        "default-case-last": "error",
+        "default-param-last": "error",
+        "dot-notation": "error",
+        "eqeqeq": "error",
+        "for-direction": "error",
+        "func-name-matching": "error",
+        "func-names": "error",
+        "func-style": "error",
+        "getter-return": "error",
+        "grouped-accessor-pairs": "error",
+        "guard-for-in": "error",
+        "id-denylist": "error",
+        "id-length": "error",
+        "id-match": "error",
+        "init-declarations": "error",
+        "logical-assignment-operators": "error",
+        "max-classes-per-file": "error",
+        "max-depth": "error",
+        "max-lines": "error",
+        "max-lines-per-function": "error",
+        "max-nested-callbacks": "error",
+        "max-params": "error",
+        "max-statements": "error",
+        "new-cap": "error",
+        "no-alert": "error",
+        "no-array-constructor": "error",
+        "no-async-promise-executor": "error",
+        "no-await-in-loop": "error",
+        "no-bitwise": "error",
+        "no-caller": "error",
+        "no-case-declarations": "error",
+        "no-class-assign": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": "error",
+        "no-console": "error",
+        "no-const-assign": "error",
+        "no-constant-binary-expression": "error",
+        "no-constant-condition": "error",
+        "no-constructor-return": "error",
+        "no-continue": "error",
+        "no-control-regex": "error",
+        "no-debugger": "error",
+        "no-delete-var": "error",
+        "no-div-regex": "error",
+        "no-dupe-args": "error",
+        "no-dupe-class-members": "error",
+        "no-dupe-else-if": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-duplicate-imports": "error",
+        "no-else-return": "error",
+        "no-empty": "error",
+        "no-empty-character-class": "error",
+        "no-empty-function": "error",
+        "no-empty-pattern": "error",
+        "no-empty-static-block": "error",
+        "no-eq-null": "error",
+        "no-eval": "error",
+        "no-ex-assign": "error",
+        "no-extend-native": "error",
+        "no-extra-bind": "error",
+        "no-extra-boolean-cast": "error",
+        "no-extra-label": "error",
+        "no-fallthrough": "error",
+        "no-func-assign": "error",
+        "no-global-assign": "error",
+        "no-implicit-coercion": "error",
+        "no-implicit-globals": "error",
+        "no-implied-eval": "error",
+        "no-import-assign": "error",
+        "no-inline-comments": "error",
+        "no-inner-declarations": "error",
+        "no-invalid-regexp": "error",
+        "no-invalid-this": "error",
+        "no-irregular-whitespace": "error",
+        "no-iterator": "error",
+        "no-label-var": "error",
+        "no-labels": "error",
+        "no-lone-blocks": "error",
+        "no-lonely-if": "error",
+        "no-loop-func": "error",
+        "no-loss-of-precision": "error",
+        "no-magic-numbers": "error",
+        "no-misleading-character-class": "error",
+        "no-multi-assign": "error",
+        "no-multi-str": "error",
+        "no-negated-condition": "error",
+        "no-nested-ternary": "error",
+        "no-new": "error",
+        "no-new-func": "error",
+        "no-new-native-nonconstructor": "error",
+        "no-new-wrappers": "error",
+        "no-nonoctal-decimal-escape": "error",
+        "no-obj-calls": "error",
+        "no-object-constructor": "error",
+        "no-octal": "error",
+        "no-octal-escape": "error",
+        "no-param-reassign": "error",
+        "no-plusplus": "error",
+        "no-promise-executor-return": "error",
+        "no-proto": "error",
+        "no-prototype-builtins": "error",
+        "no-redeclare": "error",
+        "no-regex-spaces": "error",
+        "no-restricted-exports": "error",
+        "no-restricted-globals": "error",
+        "no-restricted-imports": "error",
+        "no-restricted-properties": "error",
+        "no-restricted-syntax": "error",
+        "no-return-assign": "error",
+        "no-script-url": "error",
+        "no-self-assign": "error",
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-setter-return": "error",
+        "no-shadow": "error",
+        "no-shadow-restricted-names": "error",
+        "no-sparse-arrays": "error",
+        "no-template-curly-in-string": "error",
+        "no-ternary": "error",
+        "no-this-before-super": "error",
+        "no-throw-literal": "error",
+        "no-undef": "error",
+        "no-undef-init": "error",
+        "no-undefined": "error",
+        "no-underscore-dangle": "error",
+        "no-unexpected-multiline": "error",
+        "no-unmodified-loop-condition": "error",
+        "no-unneeded-ternary": "error",
+        "no-unreachable": "error",
+        "no-unreachable-loop": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "no-unsafe-optional-chaining": "error",
+        "no-unused-expressions": "error",
+        "no-unused-labels": "error",
+        "no-unused-private-class-members": "error",
+        "no-unused-vars": "error",
+        "no-use-before-define": "error",
+        "no-useless-assignment": "error",
+        "no-useless-backreference": "error",
+        "no-useless-call": "error",
+        "no-useless-catch": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-concat": "error",
+        "no-useless-constructor": "error",
+        "no-useless-escape": "error",
+        "no-useless-rename": "error",
+        "no-useless-return": "error",
+        "no-var": "error",
+        "no-void": "error",
+        "no-warning-comments": "error",
+        "no-with": "error",
+        "object-shorthand": "error",
+        "one-var": "error",
+        "operator-assignment": "error",
+        "prefer-arrow-callback": "error",
+        "prefer-const": "error",
+        "prefer-destructuring": "error",
+        "prefer-exponentiation-operator": "error",
+        "prefer-named-capture-group": "error",
+        "prefer-numeric-literals": "error",
+        "prefer-object-has-own": "error",
+        "prefer-object-spread": "error",
+        "prefer-promise-reject-errors": "error",
+        "prefer-regex-literals": "error",
+        "prefer-rest-params": "error",
+        "prefer-spread": "error",
+        "prefer-template": "error",
+        "radix": "error",
+        "require-atomic-updates": "error",
+        "require-await": "error",
+        "require-unicode-regexp": "error",
+        "require-yield": "error",
+        "sort-imports": "error",
+        "sort-keys": "error",
+        "sort-vars": "error",
+        "strict": "error",
+        "symbol-description": "error",
+        "unicode-bom": "error",
+        "use-isnan": "error",
+        "valid-typeof": "error",
+        "vars-on-top": "error",
+        "yoda": "error"
+    }
+});
+
+/**
+ * @fileoverview Configuration applied when a user configuration extends from
+ * eslint:recommended.
+ * @author Nicholas C. Zakas
+ */
+
+/* eslint sort-keys: ["error", "asc"] -- Long, so make more readable */
+
+/*
+ * IMPORTANT!
+ *
+ * We cannot add a "name" property to this object because it's still used in eslintrc
+ * which doesn't support the "name" property. If we add a "name" property, it will
+ * cause an error.
+ */
+
+var eslintRecommended = Object.freeze({
+    rules: Object.freeze({
+        "constructor-super": "error",
+        "for-direction": "error",
+        "getter-return": "error",
+        "no-async-promise-executor": "error",
+        "no-case-declarations": "error",
+        "no-class-assign": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": "error",
+        "no-const-assign": "error",
+        "no-constant-binary-expression": "error",
+        "no-constant-condition": "error",
+        "no-control-regex": "error",
+        "no-debugger": "error",
+        "no-delete-var": "error",
+        "no-dupe-args": "error",
+        "no-dupe-class-members": "error",
+        "no-dupe-else-if": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-empty": "error",
+        "no-empty-character-class": "error",
+        "no-empty-pattern": "error",
+        "no-empty-static-block": "error",
+        "no-ex-assign": "error",
+        "no-extra-boolean-cast": "error",
+        "no-fallthrough": "error",
+        "no-func-assign": "error",
+        "no-global-assign": "error",
+        "no-import-assign": "error",
+        "no-invalid-regexp": "error",
+        "no-irregular-whitespace": "error",
+        "no-loss-of-precision": "error",
+        "no-misleading-character-class": "error",
+        "no-new-native-nonconstructor": "error",
+        "no-nonoctal-decimal-escape": "error",
+        "no-obj-calls": "error",
+        "no-octal": "error",
+        "no-prototype-builtins": "error",
+        "no-redeclare": "error",
+        "no-regex-spaces": "error",
+        "no-self-assign": "error",
+        "no-setter-return": "error",
+        "no-shadow-restricted-names": "error",
+        "no-sparse-arrays": "error",
+        "no-this-before-super": "error",
+        "no-undef": "error",
+        "no-unexpected-multiline": "error",
+        "no-unreachable": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "no-unsafe-optional-chaining": "error",
+        "no-unused-labels": "error",
+        "no-unused-private-class-members": "error",
+        "no-unused-vars": "error",
+        "no-useless-backreference": "error",
+        "no-useless-catch": "error",
+        "no-useless-escape": "error",
+        "no-with": "error",
+        "require-yield": "error",
+        "use-isnan": "error",
+        "valid-typeof": "error"
+    })
+});
+
+/**
+ * @fileoverview Main package entrypoint.
+ * @author Nicholas C. Zakas
+ */
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+var src = {
+    configs: {
+        all: eslintAll,
+        recommended: eslintRecommended
+    }
+};
+
+var js = /*@__PURE__*/getDefaultExportFromCjs(src);
+
+const typescript = [
+  ...neostandard.plugins["typescript-eslint"].configs.recommended,
+  {
+    name: "kouts/typescript",
+    rules: {
+      // Prefer T[] instead of Array<T>
+      "@typescript-eslint/array-type": ["error", { default: "array" }],
+      // Prefer type over interface for objects
+      "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+      // Fix type imports
+      "@typescript-eslint/consistent-type-imports": [
+        "error",
+        {
+          prefer: "type-imports",
+          fixStyle: "inline-type-imports"
+        }
+      ],
+      // Allow _ for unused variables
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          args: "none",
+          caughtErrors: "none",
+          ignoreRestSiblings: true,
+          vars: "all",
+          argsIgnorePattern: "^_"
+        }
+      ]
+    }
+  }
+];
+
+const vue = (options) => {
+  const opts = {
+    version: 3,
+    ts: true,
+    ...options
+  };
+  const vueConfig = opts.version === 3 ? pluginVue.configs["flat/recommended"] : pluginVue.configs["flat/vue2-recommended"];
+  const languageOptions = opts.ts ? {
+    languageOptions: {
+      parserOptions: {
+        parser: neostandard.plugins["typescript-eslint"].parser
+      }
+    }
+  } : {};
+  const config = [
+    ...vueConfig,
+    {
+      name: "kouts/vue",
+      files: ["*.vue", "**/*.vue"],
+      ...languageOptions,
+      rules: {
+        // Overrides for vue/(vue3-)recommended preset
+        "vue/max-attributes-per-line": "off",
+        "vue/singleline-html-element-content-newline": "off",
+        // Strengthen vue/(vue3-)recommended preset for autofix
+        // https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/configs/recommended.js
+        "vue/attributes-order": "error",
+        "vue/component-tags-order": "error",
+        "vue/no-lone-template": "error",
+        "vue/no-multiple-slot-args": "error",
+        "vue/no-v-html": "error",
+        "vue/order-in-components": "error",
+        "vue/this-in-template": "error",
+        "vue/require-prop-types": "error",
+        // Enforce PascalCase for Vue components
+        "vue/component-name-in-template-casing": ["error", "PascalCase", { registeredComponentsOnly: false, ignores: [] }],
+        // Do not allow inline styles
+        "vue/no-static-inline-styles": ["error", { allowBinding: false }],
+        // Require explicit emits
+        "vue/require-explicit-emits": "error",
+        // Require component to have a name property
+        "vue/require-name-property": "error",
+        // Require components that don't have any content to self-close
+        "vue/html-self-closing": [
+          "error",
+          {
+            html: {
+              void: "always",
+              normal: "never",
+              component: "always"
+            },
+            svg: "always",
+            math: "always"
+          }
+        ]
+      }
+    }
+  ];
+  return config;
+};
+
+const config = (options) => {
+  const opts = {
+    ts: true,
+    vue: true,
+    vueVersion: 3,
+    ...options
+  };
+  const linterConfig = [
+    {
+      name: "kouts/ignores",
+      ignores: [
+        "**/node_modules/**",
+        "{tmp,temp}/**",
+        "**/*.min.js",
+        "vendor/**",
+        "dist/**",
+        "public/**",
+        ...neostandard.resolveIgnoresFromGitignore()
+      ]
+    },
+    // JavaScript
+    {
+      name: "kouts/javascript",
+      ...js.configs.recommended
+    },
+    // TypeScript
+    ...opts.ts ? typescript : [],
+    // Neostandard
+    ...neostandard({ noJsx: true, noStyle: true, semi: false, ts: opts.ts }),
+    {
+      name: "kouts/neostandard-overrides",
+      rules: {
+        // Enforce blank lines between the given 2 kinds of statements
+        "padding-line-between-statements": [
+          "error",
+          { blankLine: "always", prev: "*", next: "return" },
+          { blankLine: "always", prev: ["const", "let", "var"], next: "*" },
+          { blankLine: "any", prev: ["const", "let", "var"], next: ["const", "let", "var"] },
+          { blankLine: "always", prev: "directive", next: "*" },
+          { blankLine: "any", prev: "directive", next: "directive" }
+        ],
+        // Console and debugger settings depending whether we're on production or not
+        "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
+        "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
+      }
+    },
+    // Import
+    {
+      name: "kouts/import",
+      plugins: {
+        import: pluginImport
+      },
+      rules: {
+        "import/export": "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/no-absolute-path": ["error", { esmodule: true, commonjs: true, amd: false }],
+        "import/newline-after-import": ["error", { count: 1 }]
+      }
+    },
+    // Sort imports
+    {
+      name: "kouts/sort-imports",
+      plugins: {
+        "simple-import-sort": pluginSimpleImportSort
+      },
+      rules: {
+        "simple-import-sort/imports": [
+          "error",
+          // Remove all blank lines between imports
+          {
+            groups: [["^\\u0000", "^node:", "^@?\\w", "^", "^\\."]]
+          }
+        ],
+        "simple-import-sort/exports": "error"
+      }
+    },
+    // HTML
+    {
+      name: "kouts/html",
+      files: ["**/*.html"],
+      plugins: {
+        html: pluginHtml
+      }
+    },
+    // Vue
+    ...opts.vue ? vue({ version: opts.vueVersion, ts: opts.ts }) : [],
+    // Prettier
+    {
+      name: "kouts/prettier",
+      ...pluginPrettier
+    }
+  ];
+  return linterConfig;
+};
+
+Object.defineProperty(exports, "plugins", {
+	enumerable: true,
+	get: function () { return neostandard.plugins; }
+});
+exports.config = config;

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+import { Linter } from 'eslint';
+export { plugins } from 'neostandard';
+
+type Options = {
+    ts?: boolean;
+    vue?: boolean;
+    vueVersion?: 2 | 3;
+};
+declare const config: (options?: Options) => Linter.Config<Linter.RulesRecord>[];
+
+export { config };

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Linter } from 'eslint';
+export { plugins } from 'neostandard';
+
+type Options = {
+    ts?: boolean;
+    vue?: boolean;
+    vueVersion?: 2 | 3;
+};
+declare const config: (options?: Options) => Linter.Config<Linter.RulesRecord>[];
+
+export { config };