@open-xchange/linter-presets 0.11.5 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## `0.12.0` – 2024-Dec-06
+
+- chore: bump dependencies
+- add: (ESLint) more rules for Vue files
+
+## `0.11.6` – 2024-Dec-01
+
+- add: (ESLint) enable standard rules in Vue files
+
 ## `0.11.5` – 2024-Nov-29
 
 - add: (StyleLint) enable directive `reportUnscopedDisables`

package/dist/eslint/config/base.js

@@ -1,6 +1,6 @@
 import eslintJs from "@eslint/js";
 import babelParser from "@babel/eslint-parser";
-import { JS_GLOB, SRC_GLOB, extGlob } from "../shared/env-utils.js";
+import { JS_GLOB, SRC_GLOB, VUE_GLOB, extGlob } from "../shared/env-utils.js";
 import { builtinRestrictedRules } from "../shared/restricted.js";
 // functions ==================================================================
 /**
@@ -58,7 +58,7 @@ export default function base(languageConfig) {
             }] : []),
         // configure linter rules
         {
-            files: SRC_GLOB,
+            files: [...SRC_GLOB, ...VUE_GLOB],
             rules: {
                 // enable all rules recommended by ESLint itself
                 ...eslintJs.configs.recommended.rules,

package/dist/eslint/config/directives.js

@@ -1,5 +1,5 @@
 import commentsPluginConfigs from "@eslint-community/eslint-plugin-eslint-comments/configs";
-import { SRC_GLOB } from "../shared/env-utils.js";
+import { SRC_GLOB, VUE_GLOB } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Checks inline linter directives.
@@ -13,7 +13,7 @@ import { SRC_GLOB } from "../shared/env-utils.js";
 export default function directives() {
     // register rule implementations and recommended rules
     return [{
-            files: SRC_GLOB,
+            files: [...SRC_GLOB, ...VUE_GLOB],
             ...commentsPluginConfigs.recommended,
         }];
 }

package/dist/eslint/config/stylistic.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import type { StylisticConfig } from "../shared/env-utils.js";
+import { type StylisticConfig } from "../shared/env-utils.js";
 /**
  * Defines standard (opinionated) linter rules for source code style.
  *

package/dist/eslint/config/stylistic.js

@@ -1,5 +1,6 @@
 import stylisticPlugin from "@stylistic/eslint-plugin";
 import migratePlugin from "@stylistic/eslint-plugin-migrate";
+import { getCommaDangleConfig } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Defines standard (opinionated) linter rules for source code style.
@@ -16,7 +17,7 @@ import migratePlugin from "@stylistic/eslint-plugin-migrate";
  */
 export default function stylistic(stylisticConfig) {
     // configuration properties
-    const { indent, semi, quotes, dangle } = stylisticConfig;
+    const { indent, semi, quotes } = stylisticConfig;
     return [
         // globally disable all deprecated stylistic core rules
         stylisticPlugin.configs["disable-legacy"],
@@ -34,7 +35,7 @@ export default function stylistic(stylisticConfig) {
                 "@stylistic/arrow-spacing": "error",
                 "@stylistic/block-spacing": "error",
                 "@stylistic/brace-style": ["error", "1tbs", { allowSingleLine: true }],
-                "@stylistic/comma-dangle": (dangle === "always") ? ["error", "always-multiline"] : (dangle === "never") ? ["error", "never"] : "off",
+                "@stylistic/comma-dangle": getCommaDangleConfig(stylisticConfig),
                 "@stylistic/comma-spacing": "error",
                 "@stylistic/comma-style": "error",
                 "@stylistic/computed-property-spacing": "error",
@@ -99,13 +100,6 @@ export default function stylistic(stylisticConfig) {
                 "@stylistic/yield-star-spacing": "error",
             },
         },
-        // special settings for Vue files
-        {
-            files: ["**/*.vue"],
-            rules: {
-                "@stylistic/indent": ["error", stylisticConfig.indent.vue],
-            },
-        },
         // "@stylistic/migrate" plugin
         {
             // register rule implementations of the plugins

package/dist/eslint/config/vue.js

@@ -1,7 +1,7 @@
 import vuePlugin from "eslint-plugin-vue";
 import vueParser from "vue-eslint-parser";
 import tseslint from "typescript-eslint";
-import { fixMissingFilesOption } from "../shared/env-utils.js";
+import { fixMissingFilesOption, getCommaDangleConfig } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with linter rules for Vue.js.
@@ -37,9 +37,53 @@ export default function vue(languageConfig, stylisticConfig) {
         // reconfigure plugin rules
         {
             rules: {
-                "vue/html-indent": ["error", stylisticConfig.indent.vue],
+                "no-undef": "off",
+                "no-unused-vars": "off",
+                "no-useless-assignment": "off",
+                "vue/block-order": ["error", { order: ["script", "template", "style"] }],
+                "vue/component-api-style": "error",
+                "vue/define-emits-declaration": "error",
+                "vue/define-macros-order": "error",
+                "vue/define-props-declaration": "error",
+                "vue/eqeqeq": "error",
+                "vue/html-button-has-type": "error",
                 "vue/max-attributes-per-line": "off",
+                "vue/no-console": "error",
+                "vue/no-empty-pattern": "error",
+                "vue/no-irregular-whitespace": "error",
+                "vue/no-sparse-arrays": "error",
+                "vue/no-template-target-blank": "error",
+                "vue/no-use-v-else-with-v-for": "error",
+                "vue/no-useless-concat": "error",
+                "vue/no-useless-v-bind": "error",
+                "vue/object-shorthand": "error",
+                "vue/padding-line-between-blocks": "error",
+                "vue/prefer-define-options": "error",
+                "vue/prefer-true-attribute-shorthand": "error",
+                "vue/prefer-use-template-ref": "error",
+                "vue/require-explicit-slots": "error",
+                "vue/require-typed-ref": "error",
                 "vue/singleline-html-element-content-newline": "off",
+                // @stylistic extensions
+                "vue/array-bracket-spacing": "error",
+                "vue/arrow-spacing": "error",
+                "vue/block-spacing": "error",
+                "vue/brace-style": ["error", "1tbs", { allowSingleLine: true }],
+                "vue/comma-dangle": getCommaDangleConfig(stylisticConfig),
+                "vue/comma-spacing": "error",
+                "vue/comma-style": "error",
+                "vue/dot-notation": "error",
+                "vue/func-call-spacing": "error",
+                "vue/html-indent": ["error", stylisticConfig.indent.vue],
+                "vue/key-spacing": ["error", { mode: "minimum" }],
+                "vue/keyword-spacing": "error",
+                "vue/object-curly-spacing": ["error", "always"],
+                "vue/quote-props": ["error", "as-needed"],
+                "vue/script-indent": ["error", stylisticConfig.indent.vue, { switchCase: 1 }],
+                "vue/space-in-parens": "error",
+                "vue/space-infix-ops": "error",
+                "vue/space-unary-ops": "error",
+                "vue/template-curly-spacing": "error",
             },
         },
     ]);

package/dist/eslint/env/node.d.ts

@@ -23,7 +23,9 @@ export interface EnvNodeSharedSettings {
  */
 export interface EnvNodeOptions extends EnvRestrictedOptions {
     /**
-     * The module mode used by the linted files. Default value is "module".
+     * The module mode used by the linted files.
+     *
+     * @default "module"
      */
     sourceType?: LanguageOptions["sourceType"];
     /**

package/dist/eslint/env/react.js

@@ -76,15 +76,7 @@ export default function react(envOptions) {
         },
     }), 
     // "react-refresh" plugin
-    createConfig(envOptions, {
-        // register rule implementations of the plugins
-        plugins: {
-            "react-refresh": reactRefreshPlugin,
-        },
-        rules: {
-            "react-refresh/only-export-components": ["error", { allowConstantExport: true }],
-        },
-    }), 
+    createConfig(envOptions, reactRefreshPlugin.configs.vite), 
     // "jsx-a11y" plugin
     createConfig(envOptions, jsxA11yPlugin.flatConfigs.recommended), 
     // custom rules

package/dist/eslint/rules/no-invalid-hierarchy.d.ts

@@ -14,7 +14,9 @@ export interface RuleNoInvalidHierarchyPackage {
      * installation. Such a package cannot be imported statically (with
      * `import` statement) from a non-optional package, but can only be loaded
      * dynamically at runtime (by calling `import()`). The rule will mark all
-     * static imports of optional code as an error. Default value is `false`.
+     * static imports of optional code as an error.
+     *
+     * @default false
      */
     optional?: boolean;
 }

package/dist/eslint/shared/env-utils.d.ts

@@ -8,7 +8,8 @@ export type DeepRequired<T> = {
 export interface LanguageOptions {
     /**
      * The ECMAScript version to be used in the project (version or year).
-     * Default value is `latest`.
+     *
+     * @default "latest"
      */
     ecmaVersion?: Linter.EcmaVersion;
     /**
@@ -17,13 +18,15 @@ export interface LanguageOptions {
      * - "module": The files will be considered being ES modules.
      * - "commonjs": The files will be considered being CommonJS modules.
      *
-     * Default value is "module".
+     * @default "module"
      */
     sourceType?: "module" | "commonjs";
     /**
      * Whether to support native ES decorators in JavaScript code (via Babel
      * plugin). Does not affect TypeScript code which uses an own parser aware
-     * of the decorator syntax. Default value is `false`.
+     * of the decorator syntax.
+     *
+     * @default false
      */
     nativeDecorators?: boolean;
 }
@@ -34,19 +37,26 @@ export type LanguageConfig = DeepRequired<LanguageOptions>;
 export interface IndentOptions {
     /**
      * Indentation size for JavaScript and TypeScript files, including JSX.
-     * Default value is `4`.
+     *
+     * @default 4
      */
     js?: number;
     /**
-     * Indentation size for JSON files. Default value is `4`.
+     * Indentation size for JSON files.
+     *
+     * @default 4
      */
     json?: number;
     /**
-     * Indentation size for YAML files. Default value is `2`.
+     * Indentation size for YAML files.
+     *
+     * @default 2
      */
     yaml?: number;
     /**
-     * Indentation size for Vue.js files. Default value is `4`.
+     * Indentation size for Vue.js files (script and template blocks).
+     *
+     * @default 4
      */
     vue?: number;
 }
@@ -66,11 +76,13 @@ export interface StylisticOptions {
      * - "never": Require to omit semicolons according to ASI rules.
      * - "off": Semicolons will not be checked.
      *
-     * Default value is "always".
+     * @default "always"
      */
     semi?: "always" | "never" | "off";
     /**
-     * The type of the string delimiter character. Default value is "double".
+     * The type of the string delimiter character.
+     *
+     * @default "double"
      */
     quotes?: "single" | "double" | "off";
     /**
@@ -82,7 +94,7 @@ export interface StylisticOptions {
      * - "never": Dangling commas will be forbidden.
      * - "off": Dangling commas will not be checked.
      *
-     * Default value is "always".
+     * @default "always"
      */
     dangle?: "always" | "never" | "off";
 }
@@ -138,6 +150,10 @@ export declare const DTS_GLOB: string[];
  * Glob array for all source files (JavaScript and TypeScript).
  */
 export declare const SRC_GLOB: string[];
+/**
+ * Glob array for all VueJS SFC files.
+ */
+export declare const VUE_GLOB: string[];
 /**
  * Shared options for the core rule `no-unused-vars`, and the plugin rule
  * `@typescript-eslint/no-unused-vars`.
@@ -243,3 +259,14 @@ export declare function fixMissingFilesOption(configs: Linter.Config[]): Linter.
  *  The converted rules record.
  */
 export declare function convertRuleWarningsToErrors(rules: Linter.RulesRecord): Linter.RulesRecord;
+/**
+ * Translates the stylistic option `dangle` to the configuration options for
+ * "comma-dangle" rules.
+ *
+ * @param stylisticConfig
+ *  Resolved stylistic configuration options.
+ *
+ * @returns
+ *  The configuration options for "comma-dangle" rules.
+ */
+export declare function getCommaDangleConfig(stylisticConfig: StylisticConfig): Linter.RuleEntry;

package/dist/eslint/shared/env-utils.js

@@ -27,6 +27,10 @@ export const DTS_GLOB = extGlob(TS_EXTENSIONS.map(ext => "d." + ext));
  * Glob array for all source files (JavaScript and TypeScript).
  */
 export const SRC_GLOB = extGlob(SRC_EXTENSIONS);
+/**
+ * Glob array for all VueJS SFC files.
+ */
+export const VUE_GLOB = extGlob(["vue"]);
 /**
  * Shared options for the core rule `no-unused-vars`, and the plugin rule
  * `@typescript-eslint/no-unused-vars`.
@@ -161,3 +165,17 @@ export function convertRuleWarningsToErrors(rules) {
         return [key, value];
     }));
 }
+/**
+ * Translates the stylistic option `dangle` to the configuration options for
+ * "comma-dangle" rules.
+ *
+ * @param stylisticConfig
+ *  Resolved stylistic configuration options.
+ *
+ * @returns
+ *  The configuration options for "comma-dangle" rules.
+ */
+export function getCommaDangleConfig(stylisticConfig) {
+    const { dangle } = stylisticConfig;
+    return (dangle === "always") ? ["error", "always-multiline"] : (dangle === "never") ? ["error", "never"] : "off";
+}

package/dist/eslint/shared/restricted.d.ts

@@ -49,10 +49,10 @@ export interface EnvRestrictedOption extends EnvRestrictedItems {
     /**
      * Whether the environment supports native decorators. In this case, it
      * will be required to replace TypeScript decorated `private` methods with
-     * native `#private` methods.
+     * native `#private` methods. TypeScript's experimental decorators cannot
+     * be used with native `#private` fields.
      *
-     * Default value is `false` (TypeScript's experimental decorators cannot be
-     * used with native `#private` fields).
+     * @default false
      */
     nativeDecorators?: boolean;
     /**

package/dist/eslint/shared/unittest.d.ts

@@ -7,7 +7,9 @@ export interface EnvUnitTestOptions extends EnvBaseOptions {
     /**
      * Specifies whether to include `eslint-plugin-jest-dom`. Should only be
      * used, if the package `@testing-library/jest-dom` has been installed in
-     * the project. Default value is `false`.
+     * the project.
+     *
+     * @default false
      */
     jestDom?: boolean;
     /**

package/dist/stylelint/index.d.ts

@@ -4,12 +4,15 @@ import type { Config } from "stylelint";
  */
 export interface StylisticOptions {
     /**
-     * Default indentation size (number of space characters). Default value is
-     * `4`.
+     * Default indentation size (number of space characters).
+     *
+     * @default 4
      */
     indent?: number;
     /**
-     * The type of the string delimiter character. Default value is "double".
+     * The type of the string delimiter character.
+     *
+     * @default "double"
      */
     quotes?: "single" | "double" | "off";
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "0.11.5",
+  "version": "0.12.0",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",
@@ -25,17 +25,17 @@
     "@babel/eslint-parser": "^7.25.9",
     "@babel/plugin-proposal-decorators": "^7.25.9",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
-    "@eslint-react/eslint-plugin": "^1.17.1",
-    "@eslint/compat": "^1.2.3",
-    "@eslint/js": "^9.15.0",
+    "@eslint-react/eslint-plugin": "^1.17.3",
+    "@eslint/compat": "^1.2.4",
+    "@eslint/js": "^9.16.0",
     "@eslint/markdown": "^6.2.1",
     "@stylistic/eslint-plugin": "^2.11.0",
     "@stylistic/eslint-plugin-migrate": "^2.11.0",
     "@stylistic/stylelint-config": "^2.0.0",
     "@stylistic/stylelint-plugin": "^3.1.1",
-    "@vitest/eslint-plugin": "^1.1.12",
+    "@vitest/eslint-plugin": "^1.1.14",
     "confusing-browser-globals": "^1.0.11",
-    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-plugin-chai-expect": "^3.1.0",
     "eslint-plugin-codeceptjs": "^1.3.0",
     "eslint-plugin-eslint-plugin": "^6.3.2",
@@ -48,29 +48,29 @@
     "eslint-plugin-license-header": "^0.6.1",
     "eslint-plugin-n": "^17.14.0",
     "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
     "eslint-plugin-react-hooks-static-deps": "^1.0.7",
-    "eslint-plugin-react-refresh": "^0.4.14",
-    "eslint-plugin-testing-library": "^7.0.0",
-    "eslint-plugin-vue": "^9.31.0",
-    "eslint-plugin-yml": "^1.15.0",
+    "eslint-plugin-react-refresh": "^0.4.16",
+    "eslint-plugin-testing-library": "^7.1.0",
+    "eslint-plugin-vue": "^9.32.0",
+    "eslint-plugin-yml": "^1.16.0",
     "find-up": "^7.0.0",
-    "globals": "^15.12.0",
+    "globals": "^15.13.0",
     "picomatch": "^4.0.2",
     "postcss-html": "^1.7.0",
     "stylelint-config-standard": "^36.0.1",
     "stylelint-config-standard-less": "^3.0.1",
-    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint-config-standard-scss": "^14.0.0",
     "stylelint-config-standard-vue": "^1.0.0",
     "stylelint-plugin-license-header": "^1.0.3",
-    "typescript-eslint": "^8.16.0",
+    "typescript-eslint": "^8.17.0",
     "vue-eslint-parser": "^9.4.3"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/picomatch": "^3.0.1",
-    "@typescript-eslint/utils": "^8.16.0",
-    "eslint": "^9.15.0",
+    "@typescript-eslint/utils": "^8.17.0",
+    "eslint": "^9.16.0",
     "jest": "^29.7.0",
     "rimraf": "^6.0.1",
     "stylelint": "^16.11.0",
@@ -80,7 +80,7 @@
     "eslint": "^9.10.0",
     "jest": "^29.7.0",
     "postcss": "^8.4.0",
-    "stylelint": "^16.8.0",
+    "stylelint": "^16.11.0",
     "typescript": "^5.5.0",
     "vitest": "^2.0.0"
   },