@open-xchange/linter-presets 0.3.3 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.4.0] - 2024-08-06
+
+- added: [ESLint] rules `jsdoc/require-template`, `jsdoc/require-throws`
+- changed: [StyleLint] default values of `stylistic` option (indent 4 spaces, double quotes)
+
 ## [0.3.3] - 2024-08-01
 
 - fixed: [ESLint] `env.tsconfig` must disable "projectService" explicitly

package/dist/eslint/config/jsdoc.js

@@ -40,6 +40,8 @@ export default function jsdoc() {
         // configure plugin rules
         {
             rules: {
+                "jsdoc/require-template": ["error", { requireSeparateTemplates: true }],
+                "jsdoc/require-throws": "error",
                 "jsdoc/tag-lines": "off",
             },
         },

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

@@ -31,7 +31,7 @@ export interface StylisticOptions {
     /**
      * Default indentation size (number of space characters). Will be applied
      * to JavaScript, TypeScript, JSON, and YAML files, as well as JSX markup.
-     * Default value is `2`.
+     * Default value is `4`.
      */
     indent?: number;
     /**
@@ -41,11 +41,11 @@ export interface StylisticOptions {
      * - "never": Require to omit semicolons according to ASI rules.
      * - "off": Semicolons will not be checked.
      *
-     * Default value is "never".
+     * Default value is "always".
      */
     semi?: "always" | "never" | "off";
     /**
-     * The type of the string delimiter character. Default value is "single".
+     * The type of the string delimiter character. Default value is "double".
      */
     quotes?: "single" | "double" | "off";
     /**

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

@@ -15,6 +15,9 @@ export const NO_UNUSED_VARS_OPTIONS = {
  * Concatenates and flattens multiple elements or arrays into a single array
  * while skipping all falsy parameters.
  *
+ * @template T
+ *  The type of the array elements.
+ *
  * @param entries
  *  The elements or arrays to be concatenated.
  *

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

@@ -26,6 +26,9 @@ export declare const Schema: {
  * Returns a passed array unmodified, converts the value `undefined` to an
  * empty array, and converts all other values to an array with one element.
  *
+ * @template T
+ *  The type of the array elements.
+ *
  * @param value
  *  Any value to be converted to an array.
  *

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

@@ -38,6 +38,9 @@ export const Schema = {
  * Returns a passed array unmodified, converts the value `undefined` to an
  * empty array, and converts all other values to an array with one element.
  *
+ * @template T
+ *  The type of the array elements.
+ *
  * @param value
  *  Any value to be converted to an array.
  *

package/dist/stylelint/index.d.ts

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

package/dist/stylelint/index.js

@@ -12,8 +12,8 @@
 export function configure(options) {
     // resolve stylistic configuration options
     const stylistic = {
-        indent: 2,
-        quotes: "single",
+        indent: 4,
+        quotes: "double",
         ...options?.stylistic,
     };
     const rules = { base: {}, scss: {}, less: {} };

package/doc/stylelint/README.md

@@ -26,8 +26,8 @@ Generates standard configuration targeting the source files in the entire projec
 | `ignores` | `string[]` | `[]` | Glob patterns with all files and folders to be ignored by StyleLint. |
 | `license` | `string` | `""` | Full path to the template file containing the license header to be used in all source files. |
 | `stylistic` | `StylisticOptions` | | Configuration options for code style. |
-| `stylistic.indent` | `number` | `2` | Default indentation size (number of space characters). |
-| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"single"` | The type of the string delimiter character. |
+| `stylistic.indent` | `number` | `4` | Default indentation size (number of space characters). |
+| `stylistic.quotes` | `"single"\|"double"\|"off"` | `"double"` | The type of the string delimiter character. |
 | `rules` | `StyleLint.Config["rules"]` | `{}` | Additional linter rules to be added to the global configuration. |
 
 #### `configure` Example
@@ -41,6 +41,6 @@ const resolve = utils.resolver(import.meta.url)
 export default stylelint.configure({
   ignores: ["dist/*", "external/**/*.scss"],
   license: resolve("./license.txt"),
-  stylistic: { indent: 4, quotes: "double" },
+  stylistic: { indent: 2, quotes: "single" },
 })
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-xchange/linter-presets",
-    "version": "0.3.3",
+    "version": "0.4.0",
     "description": "Configuration presets for ESLint and StyleLint",
     "repository": {
         "url": "https://gitlab.open-xchange.com/fspd/npm-packages/linter-presets"
@@ -9,7 +9,7 @@
     "engines": {
         "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
     },
-    "packageManager": "yarn@4.3.1",
+    "packageManager": "yarn@4.4.0",
     "type": "module",
     "exports": "./dist/index.js",
     "scripts": {
@@ -38,14 +38,14 @@
         "eslint-plugin-codeceptjs": "1.3.0",
         "eslint-plugin-eslint-plugin": "6.2.0",
         "eslint-plugin-import": "2.29.1",
-        "eslint-plugin-jest": "28.6.0",
+        "eslint-plugin-jest": "28.7.0",
         "eslint-plugin-jest-dom": "5.4.0",
-        "eslint-plugin-jsdoc": "48.10.2",
+        "eslint-plugin-jsdoc": "48.11.0",
         "eslint-plugin-jsonc": "2.16.0",
         "eslint-plugin-jsx-a11y": "6.9.0",
         "eslint-plugin-jsx-expressions": "1.3.2",
         "eslint-plugin-license-header": "0.6.1",
-        "eslint-plugin-n": "17.10.1",
+        "eslint-plugin-n": "17.10.2",
         "eslint-plugin-promise": "7.0.0",
         "eslint-plugin-react": "7.35.0",
         "eslint-plugin-react-hooks": "4.6.2",
@@ -61,13 +61,13 @@
         "stylelint-config-standard-less": "3.0.1",
         "stylelint-config-standard-scss": "13.1.0",
         "stylelint-plugin-license-header": "1.0.3",
-        "typescript-eslint": "8.0.0"
+        "typescript-eslint": "8.0.1"
     },
     "devDependencies": {
         "@types/confusing-browser-globals": "1.0.3",
         "@types/eslint__js": "8.42.3",
         "@types/picomatch": "3.0.0",
-        "@typescript-eslint/utils": "8.0.0",
+        "@typescript-eslint/utils": "8.0.1",
         "eslint": "9.8.0",
         "husky": "9.1.4",
         "jest": "29.7.0",