@darksheep/eslint 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [5.3.0](https://github.com/DarkSheepSoftware/eslint/compare/v5.2.1...v5.3.0) (2024-08-08)
+
+
+### 🌟 Features
+
+* Add basic yml support ([ad7dd61](https://github.com/DarkSheepSoftware/eslint/commit/ad7dd610d52b1c1c9c0f9daea39ad5ad185c64d1))
+* Allow editor config to configure yml/indent ([b8655bc](https://github.com/DarkSheepSoftware/eslint/commit/b8655bc56871bebf4fc1157085d9498ebe45b324))
+* Better json formatting ([68da6b2](https://github.com/DarkSheepSoftware/eslint/commit/68da6b266a904e4c780c13b1cc6f08511826111b))
+
+
+### 🩹 Fixes
+
+* Disable sonar/no-duplicate-string ([8ac453d](https://github.com/DarkSheepSoftware/eslint/commit/8ac453d0e435997283c716596bfed1135467854a))
+* Ignore line count in json files ([cc955da](https://github.com/DarkSheepSoftware/eslint/commit/cc955da408803c5ed1cfde7fd1fceb7735ba9b43))
+* resolve issues in yml files ([315e888](https://github.com/DarkSheepSoftware/eslint/commit/315e8885ccf6f7e010c721166ec57f6449d5a8f9))
+
+
+### 📦 Dependencies
+
+* **pkg:** pin dependencies ([#561](https://github.com/DarkSheepSoftware/eslint/issues/561)) ([e14c5e6](https://github.com/DarkSheepSoftware/eslint/commit/e14c5e609fbe8a5363f620e98a890bc53d7a5c19))
+* **pkg:** update dependency eslint-plugin-perfectionist to v3.1.3 ([#558](https://github.com/DarkSheepSoftware/eslint/issues/558)) ([e911049](https://github.com/DarkSheepSoftware/eslint/commit/e9110492400b1a3880764ce3cccb0be5ade2e918))
+
+## [5.2.1](https://github.com/DarkSheepSoftware/eslint/compare/v5.2.0...v5.2.1) (2024-08-07)
+
+
+### 📦 Dependencies
+
+* **pkg:** update dependency eslint-plugin-jsdoc to v49 ([#556](https://github.com/DarkSheepSoftware/eslint/issues/556)) ([237bb6c](https://github.com/DarkSheepSoftware/eslint/commit/237bb6c7d7175a7416ad44848887431a92a13591))
+* **pkg:** update dependency eslint-plugin-jsdoc to v50 ([#557](https://github.com/DarkSheepSoftware/eslint/issues/557)) ([4074731](https://github.com/DarkSheepSoftware/eslint/commit/407473198d3aad3e3e9b50a4a3be01f4bf70a539))
+* **pkg:** update dependency eslint-plugin-promise to v7.1.0 ([#553](https://github.com/DarkSheepSoftware/eslint/issues/553)) ([c944b6b](https://github.com/DarkSheepSoftware/eslint/commit/c944b6b74da46756f64693d4fce7260e62dda569))
+
 ## [5.2.0](https://github.com/DarkSheepSoftware/eslint/compare/v5.1.5...v5.2.0) (2024-08-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/eslint",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/DarkSheepSoftware/eslint"
@@ -28,19 +28,21 @@
     "@typescript-eslint/eslint-plugin": "8.0.1",
     "@typescript-eslint/parser": "8.0.1",
     "editorconfig": "2.0.0",
-    "eslint-plugin-jsdoc": "48.11.0",
+    "eslint-plugin-jsdoc": "50.0.0",
     "eslint-plugin-jsonc": "2.16.0",
     "eslint-plugin-n": "17.10.2",
     "eslint-plugin-package-json": "0.15.2",
-    "eslint-plugin-perfectionist": "3.1.2",
-    "eslint-plugin-promise": "7.0.0",
+    "eslint-plugin-perfectionist": "3.1.3",
+    "eslint-plugin-promise": "7.1.0",
     "eslint-plugin-react": "7.35.0",
     "eslint-plugin-regexp": "2.6.0",
     "eslint-plugin-security": "3.0.1",
     "eslint-plugin-sonarjs": "1.0.4",
     "eslint-plugin-unicorn": "55.0.0",
     "eslint-plugin-unused-imports": "4.0.1",
-    "jsonc-eslint-parser": "2.4.0"
+    "eslint-plugin-yml": "1.14.0",
+    "jsonc-eslint-parser": "2.4.0",
+    "yaml-eslint-parser": "1.2.3"
   },
   "devDependencies": {
     "@darksheep/eslint-formatter-github": "2.0.1",
@@ -50,7 +52,7 @@
     "@types/estree": "~1.0.2",
     "@types/node": "~20.14.0",
     "eslint": "~9.8.0",
-    "type-fest": "~4.23.0",
+    "type-fest": "~4.24.0",
     "typescript": "~5.5.0"
   },
   "peerDependencies": {
@@ -66,7 +68,7 @@
     "node": "^20 || ^21 || ^22"
   },
   "volta": {
-    "node": "22.5.1",
+    "node": "22.6.0",
     "yarn": "4.4.0"
   }
 }

package/src/index.js

@@ -21,6 +21,7 @@ import { createEslintStyleConfig } from './plugins/style.js';
 import { createEslintTypescriptConfig } from './plugins/typescript.js';
 import { createEslintUnicornConfig } from './plugins/unicorn.js';
 import { createEslintUnusedImportsConfig } from './plugins/unused-imports.js';
+import { createEslintYmlConfig } from './plugins/yml.js';
 
 const configBuilders = [
     createEslintIgnoresConfig,
@@ -33,6 +34,7 @@ const configBuilders = [
     createEslintPerfectionistConfig,
     createEslintPackageJsonConfig,
     createEslintJsonConfig,
+    createEslintYmlConfig,
     createEslintPromiseConfig,
     createEslintTypescriptConfig,
     createEslintReactConfig,

package/src/plugins/json.js

@@ -13,6 +13,16 @@ export async function createEslintJsonConfig() {
             languageOptions: { parser },
             // @ts-expect-error jsonc does not match the plugin interface
             plugins: { jsonc },
+            rules: {
+                'jsonc/array-bracket-newline': [ 'error', 'consistent' ],
+                'jsonc/array-bracket-spacing': [ 'error', 'always' ],
+                'jsonc/array-element-newline': [ 'error', 'consistent' ],
+                'jsonc/key-spacing': [ 'error' ],
+                'jsonc/object-curly-newline': [ 'error', { consistent: true } ],
+                'jsonc/object-curly-spacing': [ 'error', 'always' ],
+                'jsonc/object-property-newline': [ 'error', { allowAllPropertiesOnSameLine: true } ],
+                'max-lines': 'off',
+            },
         },
         {
             name: 'json/.json',
@@ -32,5 +42,11 @@ export async function createEslintJsonConfig() {
             // @ts-expect-error Record<string, string> vs Record<string, 'error'>
             rules: jsonc.configs['recommended-with-json5'].rules,
         },
+        {
+            name: 'json/tsconfig.json',
+            files: [ '**/tsconfig.json' ],
+            rules: { 'jsonc/no-comments': 'off' },
+        },
+        { ignores: [ '.github/release-please/manifest.json' ] },
     ];
 }

package/src/plugins/sonarjs.js

@@ -12,15 +12,6 @@ export function createEslintSonarJSConfig() {
             rules: {
                 ...sonarjs.configs.recommended.rules,
                 'sonarjs/cognitive-complexity': 'error',
-            },
-        },
-        {
-            name: 'sonarjs/tests',
-            files: [
-                '**/*.test.*',
-                '*.test.*',
-            ],
-            rules: {
                 'sonarjs/no-duplicate-string': 'off',
             },
         },

package/src/plugins/yml.js

@@ -0,0 +1,41 @@
+import yml from 'eslint-plugin-yml';
+import parser from 'yaml-eslint-parser';
+
+/**
+ * Get ESLint config for yml check
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export async function createEslintYmlConfig() {
+    return [
+        {
+            name: 'yml/core',
+            files: [ '**/*.yaml', '**/*.yml' ],
+            languageOptions: { parser },
+            // @ts-expect-error jsonc does not match the plugin interface
+            plugins: { yml },
+            rules: {
+                'yml/block-mapping-colon-indicator-newline': 'error',
+                'yml/block-mapping-question-indicator-newline': 'error',
+                'yml/block-mapping': 'error',
+                'yml/block-sequence-hyphen-indicator-newline': [ 'error', 'never' ],
+                'yml/block-sequence': 'error',
+                'yml/flow-mapping-curly-newline': 'error',
+                'yml/flow-mapping-curly-spacing': [ 'error', 'always' ],
+                'yml/flow-sequence-bracket-newline': 'error',
+                'yml/flow-sequence-bracket-spacing': [ 'error', 'always' ],
+                'yml/key-spacing': 'error',
+                'yml/no-empty-document': 'error',
+                'yml/no-empty-key': 'error',
+                'yml/no-empty-sequence-entry': 'error',
+                'yml/no-irregular-whitespace': 'error',
+                'yml/no-multiple-empty-lines': [ 'error', { max: 1 } ],
+                'yml/no-tab-indent': 'error',
+                'yml/no-trailing-zeros': 'error',
+                'yml/plain-scalar': 'error',
+                'yml/quotes': [ 'error' ],
+                'yml/require-string-key': 'error',
+                'yml/spaced-comment': 'error',
+            },
+        },
+    ];
+}

package/src/utilities/editorconfig.js

@@ -14,6 +14,7 @@ import { findUp } from './filesystem.js';
  * @property {string} TRAIL trailing spaces
  * @property {string} INDENT indent size
  * @property {string} [INDENT_BINARY] indent binary ops size
+ * @property {unknown} [INDENT_OPTIONS] options to pass to the indent rule
  */
 
 /**
@@ -51,14 +52,14 @@ function convert(input, RULES) {
 
     if (input?.indent_style === 'space') {
         const size = Number.parseInt(input?.indent_size ?? 4, 10);
-        output[RULES.INDENT] = [ 'error', size, { SwitchCase: 1 } ];
+        output[RULES.INDENT] = [ 'error', size, RULES.INDENT_OPTIONS ?? {} ];
         if (RULES.INDENT_BINARY != null) {
             output[RULES.INDENT_BINARY] = [ 'error', size ];
         }
     }
 
     if (input?.indent_style === 'tab') {
-        output[RULES.INDENT] = [ 'error', 'tab', { SwitchCase: 1 } ];
+        output[RULES.INDENT] = [ 'error', 'tab', RULES.INDENT_OPTIONS ?? {} ];
         if (RULES.INDENT_BINARY != null) {
             output[RULES.INDENT_BINARY] = [ 'error', 'tab' ];
         }
@@ -77,6 +78,7 @@ const extToRules = [
             TRAIL: 'style/no-trailing-spaces',
             INDENT: 'style/indent',
             INDENT_BINARY: 'style/indent-binary-ops',
+            INDENT_OPTIONS: { SwitchCase: 1 },
         },
     ],
     [
@@ -87,6 +89,14 @@ const extToRules = [
             INDENT: 'jsonc/indent',
         },
     ],
+    [
+        [ '.yml', '.yaml' ], {
+            EOL: 'style/eol-last',
+            LF: 'style/linebreak-style',
+            TRAIL: 'style/no-trailing-spaces',
+            INDENT: 'yml/indent',
+        },
+    ],
 ];
 
 /**

package/src/utilities/expand-glob.js

@@ -1,5 +1,5 @@
 const globNumRegex = /\{\d+\.\.\d+\}/;
-const globEachRegex = /\{[\w.-]+(?:,[\w.-]+)+\}/;
+const globEachRegex = /\{[\w.-]+(?:,[\w.-]+)*\}/;
 
 /**
  * @param {string} input The glob to process

package/types/src/plugins/yml.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get ESLint config for yml check
+ * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ */
+export function createEslintYmlConfig(): Promise<import("eslint").Linter.FlatConfig[]>;

package/types/src/utilities/editorconfig.d.ts

@@ -39,4 +39,11 @@ export type RuleSet = {
      * indent binary ops size
      */
     INDENT_BINARY?: string | undefined;
+    /**
+     * options to pass to the indent rule
+     */
+    /**
+     * options to pass to the indent rule
+     */
+    INDENT_OPTIONS?: unknown;
 };