Adds a YAML eslint linter.

[dblock]

Description

Lints YAML using a formatting linter. Fixes things like spaces, preferring single/double quotes, etc.

We have a spec linter that is about the spec itself in which we could implement some of these rules too, but feels easier. That one probably could have been (still can be) a generic eslint linter, too.

Issues Resolved

Closes #266.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Changes Analysis

Commit SHA: ae4c918
Comparing To SHA: 6c30b32

API Changes

Summary

NO CHANGES

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/9416605489/artifacts/1578965962

API Coverage

	Before	After	Δ
Covered (%)	476 (46.62 %)	476 (46.62 %)	0 (0 %)
Uncovered (%)	545 (53.38 %)	545 (53.38 %)	0 (0 %)
Unknown	24	24	0

[nhtruong]

We're turning off a lot of TS lints in this change.

[dblock]

Actually we're not, these are added via recommended-type-checked and I believe we didn't have them enabled before.

$ git diff
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 53e6a18..acb7a4b 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -52,6 +52,13 @@ export default [
           allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false
         }
       ],
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-unsafe-assignment': 'error',
+      '@typescript-eslint/no-unsafe-return': 'error',
+      '@typescript-eslint/no-unsafe-call': 'error',
+      '@typescript-eslint/no-unsafe-member-access': 'error',
+      '@typescript-eslint/no-unused-vars': ['error', { "argsIgnorePattern": "^_" }],
+      '@typescript-eslint/require-await': 'error',
       'array-callback-return': 'off',
       'new-cap': 'off',
       'no-return-assign': 'error',

$ npm run lint

✖ 193 problems (193 errors, 0 warnings)
  3 errors and 0 warnings potentially fixable with the `--fix` option.

[dblock]

Two of these are easy to enable. The others give hundreds of errors.

• opensearch-api-specification#318: Turn on @typescript-eslint/no-unused-var.
• opensearch-api-specification#319: Turn on @typescript-eslint/require-await.

[dblock]

This is ready. I only auto-fixed yml/indent and turned off single/double quote rules that remove quotes from keys.

[nhtruong]

Looks good to me. Need a rebase.

[dblock]

Looks good to me. Need a rebase.

Rebased.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@6c30b32). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #312   +/-   ##
=======================================
  Coverage        ?   88.74%           
=======================================
  Files           ?       40           
  Lines           ?     1164           
  Branches        ?      283           
=======================================
  Hits            ?     1033           
  Misses          ?      123           
  Partials        ?        8           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.