@ntnyq/eslint-config 3.10.2 → 3.10.4

package/README.md

@@ -9,11 +9,12 @@
 
 ## Features
 
-- Opinionable: single quotes, no semi, trailing comma, etc.
+- Opinionable: single quotes, no semi, trailing comma, etc
 - Designed to work alongside with [Prettier](https://prettier.io)
 - Respect `.gitignore` via [eslint-config-flat-gitignore](https://github.com/antfu/eslint-config-flat-gitignore)
-- Out-of-box support for TypeScript, Vue, JSON, Markdown, YAML, TOML etc.
+- Out-of-box support for TypeScript, Vue, JSON, Markdown, YAML, TOML, SVG and etc
 - Strict but provides useful rules to guard your codebase
+- Custom ESLint commands for [eslint-plugin-command](https://github.com/antfu/eslint-plugin-command)
 - [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for ESLint v9.5.0+
 
 ## Install
@@ -27,23 +28,57 @@ pnpm add eslint prettier typescript @ntnyq/eslint-config @ntnyq/prettier-config
 Highly recommended using **`eslint.config.mjs`** as the config file :
 
 ```js
+// @ts-check
+
 import { defineESLintConfig } from '@ntnyq/eslint-config'
 
 export default defineESLintConfig()
 ```
 
-Add scripts `lint` in `package.json` and config prettier:
+Add scripts `lint` in `package.json`:
 
 ```json
 {
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
-  },
-  "prettier": "@ntnyq/prettier-config"
+  }
 }
 ```
 
+<details>
+<summary>💼 Intergrated with Prettier, VSCode, husky and nano-staged</summary>
+
+<br>
+
+## Prettier config
+
+```js
+// @ts-check
+
+import { config, defineConfig } from '@ntnyq/prettier-config'
+
+export default defineConfig({
+  ...config,
+
+  // overrides if needed
+  overrides: [
+    {
+      files: ['**/*.html'],
+      options: {
+        singleAttributePerLine: false,
+      },
+    },
+    {
+      files: ['**/*.{css,scss,less}'],
+      options: {
+        singleQuote: false,
+      },
+    },
+  ],
+})
+```
+
 ## VSCode Config
 
 ```json
@@ -99,6 +134,8 @@ pnpm add husky nano-staged -D
 echo "nano-staged" > .husky/pre-commit
 ```
 
+</details>
+
 ## Advanced config
 
 Check for detail in:

package/dist/index.cjs

@@ -1133,20 +1133,24 @@ var test = (options = {}) => [
     }
   }
 ];
-var vitest = (options = {}) => [
-  {
-    name: "ntnyq/vitest",
-    plugins: {
-      vitest: import_eslint_plugin2.default
-    },
-    files: [...GLOB_TEST],
-    rules: {
-      ...import_eslint_plugin2.default.configs.recommended.rules,
-      // Overrides rules
-      ...options.overridesVitestRules
+var vitest = (options = {}) => {
+  if (!import_eslint_plugin2.default.configs?.recommended) return [];
+  const vitestConfigs = import_eslint_plugin2.default.configs;
+  return [
+    {
+      name: "ntnyq/vitest",
+      plugins: {
+        vitest: import_eslint_plugin2.default
+      },
+      files: [...GLOB_TEST],
+      rules: {
+        ...vitestConfigs.recommended.rules,
+        // Overrides rules
+        ...options.overridesVitestRules
+      }
     }
-  }
-];
+  ];
+};
 
 // src/configs/svgo.ts
 var import_eslint_plugin_svgo2 = require("eslint-plugin-svgo");
@@ -1791,7 +1795,7 @@ var import_config = __toESM(require("eslint-plugin-command/config"), 1);
 var import_commands = require("eslint-plugin-command/commands");
 var regexper = (0, import_commands.defineCommand)({
   name: "regexper",
-  // @regexper https://regexper.com/#(%5Cb%7C%5Cs%7C%5E)(%40regexper)(%5Cs%5CS%2B)%3F(%5Cb%7C%5Cs%7C%24)
+  // @regexper https://regexper.com/#%2F(%5Cb%7C%5Cs%7C%5E)(%40regexper)(%5Cs%5CS%2B)%3F(%5Cb%7C%5Cs%7C%24)%2F
   match: /(\b|\s|^)(@regexper)(\s\S+)?(\b|\s|$)/,
   action(ctx) {
     const literal = ctx.findNodeBelow((node2) => {
@@ -1800,8 +1804,16 @@ var regexper = (0, import_commands.defineCommand)({
     if (!literal) {
       return ctx.reportError("Unable to find a regexp literal to generate");
     }
-    const [_fullStr = "", spaceBefore = "", commandStr = "", existingUrl = "", _spaceAfter = ""] = ctx.matches;
-    const url = `https://regexper.com/#${encodeURIComponent(literal.regex.pattern)}`;
+    const [
+      // non-use
+      _fullStr = "",
+      spaceBefore = "",
+      commandStr = "",
+      existingUrl = "",
+      // non-use
+      _spaceAfter = ""
+    ] = ctx.matches;
+    const url = `https://regexper.com/#${encodeURIComponent(literal.raw)}`;
     if (existingUrl.trim() === url.trim()) {
       return;
     }
@@ -2076,12 +2088,27 @@ var comments = (options = {}) => [
 // src/configs/markdown.ts
 var markdown = (options = {}) => {
   if (!Array.isArray(import_markdown.default.configs?.processor)) return [];
-  const { files = [`${GLOB_MARKDOWN}/${GLOB_SRC}`], extensions = [] } = options;
+  const {
+    /**
+     * code block files
+     */
+    files = [`${GLOB_MARKDOWN}/${GLOB_SRC}`],
+    /**
+     * other extensions
+     */
+    extensions = []
+  } = options;
   return [
+    /**
+     * extracting code blocks to be linted individually
+     */
     ...import_markdown.default.configs.processor.map((config) => ({
       ...config,
       name: `ntnyq/${config.name}`
     })),
+    /**
+     * enhance `markdown/recommended/processor`
+     */
     {
       name: "ntnyq/markdown/processor",
       files,
@@ -2567,8 +2594,10 @@ var typescript = (options = {}) => {
         ...recommendedRules,
         // Disabled in favor of ts rules
         "no-redeclare": "off",
-        "no-use-before-define": "off",
         "no-unused-vars": "off",
+        "no-use-before-define": "off",
+        "no-useless-constructor": "off",
+        "@typescript-eslint/no-useless-constructor": "error",
         "@typescript-eslint/no-redeclare": [
           "error",
           {

package/dist/index.d.cts

@@ -5099,6 +5099,11 @@ interface RuleOptions {
      * @deprecated
      */
     'nonblock-statement-body-position'?: Linter.RuleEntry<NonblockStatementBodyPosition>;
+    /**
+     * disallow duplicate exports statement
+     * @see https://eslint-plugin.ntnyq.com/rules/no-duplicate-exports.html
+     */
+    'ntnyq/no-duplicate-exports'?: Linter.RuleEntry<NtnyqNoDuplicateExports>;
     /**
      * disallow usage of typescript member accessibility
      * @see https://eslint-plugin.ntnyq.com/rules/no-member-accessibility.html
@@ -9800,7 +9805,7 @@ type TypescriptEslintConsistentTypeAssertions = [] | [
     ({
         assertionStyle: "never";
     } | {
-        assertionStyle: ("as" | "angle-bracket");
+        assertionStyle?: ("as" | "angle-bracket");
         objectLiteralTypeAssertions?: ("allow" | "allow-as-parameter" | "never");
     })
 ];
@@ -14157,6 +14162,11 @@ type NonblockStatementBodyPosition = [] | [("beside" | "below" | "any")] | [
         };
     }
 ];
+type NtnyqNoDuplicateExports = [] | [
+    {
+        style?: ("inline" | "separate");
+    }
+];
 type ObjectCurlyNewline = [] | [
     ((("always" | "never") | {
         multiline?: boolean;

package/dist/index.d.ts

@@ -5099,6 +5099,11 @@ interface RuleOptions {
      * @deprecated
      */
     'nonblock-statement-body-position'?: Linter.RuleEntry<NonblockStatementBodyPosition>;
+    /**
+     * disallow duplicate exports statement
+     * @see https://eslint-plugin.ntnyq.com/rules/no-duplicate-exports.html
+     */
+    'ntnyq/no-duplicate-exports'?: Linter.RuleEntry<NtnyqNoDuplicateExports>;
     /**
      * disallow usage of typescript member accessibility
      * @see https://eslint-plugin.ntnyq.com/rules/no-member-accessibility.html
@@ -9800,7 +9805,7 @@ type TypescriptEslintConsistentTypeAssertions = [] | [
     ({
         assertionStyle: "never";
     } | {
-        assertionStyle: ("as" | "angle-bracket");
+        assertionStyle?: ("as" | "angle-bracket");
         objectLiteralTypeAssertions?: ("allow" | "allow-as-parameter" | "never");
     })
 ];
@@ -14157,6 +14162,11 @@ type NonblockStatementBodyPosition = [] | [("beside" | "below" | "any")] | [
         };
     }
 ];
+type NtnyqNoDuplicateExports = [] | [
+    {
+        style?: ("inline" | "separate");
+    }
+];
 type ObjectCurlyNewline = [] | [
     ((("always" | "never") | {
         multiline?: boolean;

package/dist/index.js

@@ -977,20 +977,24 @@ var test = (options = {}) => [
     }
   }
 ];
-var vitest = (options = {}) => [
-  {
-    name: "ntnyq/vitest",
-    plugins: {
-      vitest: default16
-    },
-    files: [...GLOB_TEST],
-    rules: {
-      ...default16.configs.recommended.rules,
-      // Overrides rules
-      ...options.overridesVitestRules
+var vitest = (options = {}) => {
+  if (!default16.configs?.recommended) return [];
+  const vitestConfigs = default16.configs;
+  return [
+    {
+      name: "ntnyq/vitest",
+      plugins: {
+        vitest: default16
+      },
+      files: [...GLOB_TEST],
+      rules: {
+        ...vitestConfigs.recommended.rules,
+        // Overrides rules
+        ...options.overridesVitestRules
+      }
     }
-  }
-];
+  ];
+};
 
 // src/configs/svgo.ts
 import { config as createSVGOConfig } from "eslint-plugin-svgo";
@@ -1635,7 +1639,7 @@ import createCommandConfig from "eslint-plugin-command/config";
 import { defineCommand } from "eslint-plugin-command/commands";
 var regexper = defineCommand({
   name: "regexper",
-  // @regexper https://regexper.com/#(%5Cb%7C%5Cs%7C%5E)(%40regexper)(%5Cs%5CS%2B)%3F(%5Cb%7C%5Cs%7C%24)
+  // @regexper https://regexper.com/#%2F(%5Cb%7C%5Cs%7C%5E)(%40regexper)(%5Cs%5CS%2B)%3F(%5Cb%7C%5Cs%7C%24)%2F
   match: /(\b|\s|^)(@regexper)(\s\S+)?(\b|\s|$)/,
   action(ctx) {
     const literal = ctx.findNodeBelow((node2) => {
@@ -1644,8 +1648,16 @@ var regexper = defineCommand({
     if (!literal) {
       return ctx.reportError("Unable to find a regexp literal to generate");
     }
-    const [_fullStr = "", spaceBefore = "", commandStr = "", existingUrl = "", _spaceAfter = ""] = ctx.matches;
-    const url = `https://regexper.com/#${encodeURIComponent(literal.regex.pattern)}`;
+    const [
+      // non-use
+      _fullStr = "",
+      spaceBefore = "",
+      commandStr = "",
+      existingUrl = "",
+      // non-use
+      _spaceAfter = ""
+    ] = ctx.matches;
+    const url = `https://regexper.com/#${encodeURIComponent(literal.raw)}`;
     if (existingUrl.trim() === url.trim()) {
       return;
     }
@@ -1920,12 +1932,27 @@ var comments = (options = {}) => [
 // src/configs/markdown.ts
 var markdown = (options = {}) => {
   if (!Array.isArray(default10.configs?.processor)) return [];
-  const { files = [`${GLOB_MARKDOWN}/${GLOB_SRC}`], extensions = [] } = options;
+  const {
+    /**
+     * code block files
+     */
+    files = [`${GLOB_MARKDOWN}/${GLOB_SRC}`],
+    /**
+     * other extensions
+     */
+    extensions = []
+  } = options;
   return [
+    /**
+     * extracting code blocks to be linted individually
+     */
     ...default10.configs.processor.map((config) => ({
       ...config,
       name: `ntnyq/${config.name}`
     })),
+    /**
+     * enhance `markdown/recommended/processor`
+     */
     {
       name: "ntnyq/markdown/processor",
       files,
@@ -2411,8 +2438,10 @@ var typescript = (options = {}) => {
         ...recommendedRules,
         // Disabled in favor of ts rules
         "no-redeclare": "off",
-        "no-use-before-define": "off",
         "no-unused-vars": "off",
+        "no-use-before-define": "off",
+        "no-useless-constructor": "off",
+        "@typescript-eslint/no-useless-constructor": "error",
         "@typescript-eslint/no-redeclare": [
           "error",
           {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@ntnyq/eslint-config",
   "type": "module",
-  "version": "3.10.2",
-  "packageManager": "pnpm@9.15.1",
+  "version": "3.10.4",
+  "packageManager": "pnpm@9.15.2",
   "description": "An opinionated ESLint config preset of ntnyq",
   "keywords": [
     "eslint",
@@ -59,8 +59,8 @@
     "@eslint/js": "^9.17.0",
     "@eslint/markdown": "^6.2.1",
     "@stylistic/eslint-plugin": "^2.12.1",
-    "@unocss/eslint-plugin": "^0.65.2",
-    "@vitest/eslint-plugin": "^1.1.20",
+    "@unocss/eslint-plugin": "^0.65.3",
+    "@vitest/eslint-plugin": "^1.1.21",
     "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-flat-config-utils": "^0.4.0",
     "eslint-import-resolver-typescript": "^3.7.0",
@@ -75,12 +75,12 @@
     "eslint-plugin-jsdoc": "^50.6.1",
     "eslint-plugin-jsonc": "^2.18.2",
     "eslint-plugin-n": "^17.15.1",
-    "eslint-plugin-ntnyq": "^0.7.1",
+    "eslint-plugin-ntnyq": "^0.8.2",
     "eslint-plugin-perfectionist": "^4.4.0",
     "eslint-plugin-pinia": "^0.4.1",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-regexp": "^2.7.0",
-    "eslint-plugin-svgo": "^0.2.0",
+    "eslint-plugin-svgo": "^0.3.1",
     "eslint-plugin-toml": "^0.12.0",
     "eslint-plugin-unicorn": "^56.0.1",
     "eslint-plugin-unused-imports": "^4.1.4",
@@ -92,7 +92,7 @@
     "local-pkg": "^0.5.1",
     "prettier": "^3.4.2",
     "toml-eslint-parser": "^0.10.0",
-    "typescript-eslint": "^8.18.1",
+    "typescript-eslint": "^8.18.2",
     "vue-eslint-parser": "^9.4.3",
     "yaml-eslint-parser": "^1.2.3"
   },
@@ -110,7 +110,7 @@
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
     "vitest": "^3.0.0-beta.3",
-    "zx": "^8.2.4"
+    "zx": "^8.3.0"
   },
   "engines": {
     "node": ">=18.18.0"