feat: add eslint-plugin-yml plugin

Author: coderwyd

package.json

@@ -101,6 +101,7 @@
     "eslint-plugin-unicorn": "^57.0.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "eslint-plugin-vue": "^10.0.0",
+    "eslint-plugin-yml": "^1.17.0",
     "eslint-typegen": "^2.0.0",
     "globals": "^16.0.0",
     "jsonc-eslint-parser": "^2.4.0",
@@ -110,6 +111,7 @@
     "prettier": "^3.5.3",
     "prompts": "^2.4.2",
     "vue-eslint-parser": "^9.4.3",
+    "yaml-eslint-parser": "^1.3.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -20,3 +20,4 @@ export * from './typescript'
 export * from './unicorn'
 export * from './unocss'
 export * from './vue'
+export * from './yaml'

src/configs/index.ts

@@ -64,6 +64,7 @@ export function sortPackageJson(): TypedFlatConfigItem[] {
               'husky',
               'simple-git-hooks',
               'lint-staged',
+              'nano-staged',
               'eslintConfig',
             ],
             pathPattern: '^$',

src/configs/sort.ts

@@ -0,0 +1,83 @@
+import { GLOB_YAML } from '../constants/glob'
+import { interopDefault } from '../shared'
+
+import type {
+  OptionsFiles,
+  OptionsOverrides,
+  TypedFlatConfigItem,
+} from '../types'
+
+export async function yaml(
+  options: OptionsOverrides & OptionsFiles = {},
+): Promise<TypedFlatConfigItem[]> {
+  const { files = [GLOB_YAML], overrides = {} } = options
+
+  const [pluginYaml, parserYaml] = await Promise.all([
+    interopDefault(import('eslint-plugin-yml')),
+    interopDefault(import('yaml-eslint-parser')),
+  ] as const)
+
+  return [
+    {
+      name: 'coderwyd/yaml/setup',
+      plugins: {
+        yaml: pluginYaml,
+      },
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserYaml,
+      },
+      name: 'coderwyd/yaml/rules',
+      rules: {
+        'yaml/block-mapping': 'error',
+        'yaml/block-sequence': 'error',
+        'yaml/no-empty-key': 'error',
+        'yaml/no-empty-sequence-entry': 'error',
+        'yaml/no-irregular-whitespace': 'error',
+        'yaml/plain-scalar': 'error',
+
+        'yaml/vue-custom-block/no-parsing-error': 'error',
+
+        ...overrides,
+      },
+    },
+    {
+      files: ['pnpm-workspace.yaml'],
+      name: 'coderwyd/yaml/pnpm-workspace',
+      rules: {
+        'yaml/sort-keys': [
+          'error',
+          {
+            order: [
+              'packages',
+              'overrides',
+              'patchedDependencies',
+              'hoistPattern',
+              'catalog',
+              'catalogs',
+
+              'allowedDeprecatedVersions',
+              'allowNonAppliedPatches',
+              'configDependencies',
+              'ignoredBuiltDependencies',
+              'ignoredOptionalDependencies',
+              'neverBuiltDependencies',
+              'onlyBuiltDependencies',
+              'onlyBuiltDependenciesFile',
+              'packageExtensions',
+              'peerDependencyRules',
+              'supportedArchitectures',
+            ],
+            pathPattern: '^$',
+          },
+          {
+            order: { type: 'asc' },
+            pathPattern: '.*',
+          },
+        ],
+      },
+    },
+  ]
+}

src/configs/yaml.ts

@@ -23,6 +23,7 @@ import {
   unicorn,
   unocss,
   vue,
+  yaml,
 } from './configs'
 import { isUsingTypeScript, isUsingVue } from './env'
 import {
@@ -222,6 +223,16 @@ export async function defineConfig(
     )
   }
 
+
+
+  if (options.yaml ?? true) {
+    configs.push(
+      yaml({
+        overrides: getOverrides(options, 'yaml'),
+      }),
+    )
+  }
+
   configs.push(specials(), prettier())
 
   if ('files' in options) {

src/index.ts

@@ -146,6 +146,13 @@ export interface OptionsConfig extends OptionsComponentExts {
    */
   jsonc?: boolean | OptionsOverrides
 
+  /**
+   * Enable YAML support.
+   *
+   * @default true
+   */
+  yaml?: boolean | OptionsOverrides
+
   /**
    * Enable react rules.
    *
@@ -185,6 +192,8 @@ export interface OptionsConfig extends OptionsComponentExts {
    */
   unocss?: boolean | OptionsUnoCSS
 
+
+
   /**
    * Enable regexp rules.
    *