💡: Add support for YML to the CSpell ESLint Plugin

[dblock]

Problem

Coming from opensearch-project/opensearch-api-specification#337 we are using eslint to check markdown files. Those have a lot of English text that we'd like to spell-check.

Solution

import parserYml from "yaml-eslint-parser"
import pluginYml from 'eslint-plugin-yml'
import pluginCspell from '@cspell/eslint-plugin'

export default [
  ...pluginYml.configs['flat/standard'],
  {
    files: ["**/*.yaml", "**/*.yml"],
    languageOptions: {
      parser: parserYml
    },
    plugins: {
      'yml': pluginYml,
      '@cspell': pluginCspell
    },
    rules: {
      '@cspell/spellchecker': 'warn'
    }
  }
]

Alternatives

No response

Additional Context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[dblock]

Thank you so much for adding support for this @Jason3S! Tried it out, it works!

git clone https://github.com/streetsidesoftware/cspell
cd cspell
pnpm install
pnpm bt

Added to my package.json.

    "@cspell/eslint-plugin": "file:///Users/dblock/source/cspell/upstream-cspell/packages/cspell-eslint-plugin",

$ npm run lint

/Users/dblock/source/opensearch-project/opensearch-api-specification/dblock-opensearch-api-specification/tools/tests/tester/fixtures/specs/indices_excerpt.yaml
  174:35  warning  Unknown word: "nanos"  @cspell/spellchecker
  176:46  warning  Unknown word: "nanos"  @cspell/spellchecker

opensearch-project/opensearch-api-specification#341

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.