Adds a YAML eslint linter. (#312)

* Added YAML linter.

Signed-off-by: dblock <dblock@amazon.com>

.github/opensearch-cluster/docker-compose.yml

@@ -7,5 +7,5 @@ services:
       - "9200:9200"
       - "9600:9600"
     environment:
-      - "discovery.type=single-node"
+      - discovery.type=single-node
       - "OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_PASSWORD:-myStrongPassword123!}"

.github/workflows/check-links.yml

@@ -1,8 +1,6 @@
 name: Check Links
 
-on:
-  push:
-  pull_request:
+on: [push, pull_request]
 
 jobs:
   check:

.github/workflows/deploy-gh-pages.yml

@@ -7,7 +7,7 @@ on:
       - main
 
 concurrency:
-  group: "pages"
+  group: pages
   cancel-in-progress: false
 
 permissions:

.github/workflows/pr-comment.yml

@@ -35,7 +35,7 @@ jobs:
           COMMENT_IDENTIFIER=$(jq -r '.comment_identifier' ./pr-comment.json)
           TEMPLATE_NAME=$(jq -r '.template_name' ./pr-comment.json)
           TEMPLATE_DATA=$(jq -c '.template_data' ./pr-comment.json)
-        
+          
           vars=(
             PR_NUMBER
             COMMENT_IDENTIFIER

.github/workflows/test-spec.yml

@@ -2,19 +2,19 @@ name: Test Spec
 
 on:
   push:
-   branches: [ '**' ]
-   paths:
-     - 'package*.json'
-     - 'tsconfig.json'
-     - 'tools/src/tester/**'
-     - 'spec/**'
+    branches: ['**']
+    paths:
+      - 'package*.json'
+      - tsconfig.json
+      - 'tools/src/tester/**'
+      - 'spec/**'
   pull_request:
-   branches: [ '**' ]
-   paths:
-     - 'package*.json'
-     - 'tsconfig.json'
-     - 'tools/src/tester/**'
-     - 'spec/**'
+    branches: ['**']
+    paths:
+      - 'package*.json'
+      - tsconfig.json
+      - 'tools/src/tester/**'
+      - 'spec/**'
 
 jobs:
   test-opensearch-spec:

.github/workflows/test-tools-integ.yml

@@ -5,18 +5,18 @@ on:
     branches: ['**']
     paths:
       - 'package*.json'
-      - 'eslint.config.mjs'
-      - 'jest.config.js'
-      - 'tsconfig.json'
+      - eslint.config.mjs
+      - jest.config.js
+      - tsconfig.json
       - 'tools/**'
       - '.github/workflows/test-tools*.yml'
   pull_request:
     branches: ['**']
     paths:
       - 'package*.json'
-      - 'eslint.config.mjs'
-      - 'jest.config.js'
-      - 'tsconfig.json'
+      - eslint.config.mjs
+      - jest.config.js
+      - tsconfig.json
       - 'tools/**'
       - '.github/workflows/test-tools*.yml'
 
@@ -52,4 +52,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4.0.1
         with:
-            token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -16,7 +16,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `npm run test:spec -- --dry-run --verbose` ([#303](https://github.com/opensearch-project/opensearch-api-specification/pull/303))
 - Added `npm run test:unit` and `test:integ` ([#320](https://github.com/opensearch-project/opensearch-api-specification/pull/320))
 - Added code coverage to tools' tests ([#323](https://github.com/opensearch-project/opensearch-api-specification/pull/323))
-
+- Added a YAML linter ([#312](https://github.com/opensearch-project/opensearch-api-specification/pull/312))
+
 ### Changed
 
 - Replaced Smithy with a native OpenAPI spec ([#189](https://github.com/opensearch-project/opensearch-api-specification/issues/189))

DEVELOPER_GUIDE.md

@@ -388,7 +388,7 @@ The test suite contains unit tests and integration tests. Integration tests, suc
 
 #### Lints
 
-All code is linted using [ESLint](https://eslint.org/) in combination with [typescript-eslint](https://typescript-eslint.io/). Linting can be run via:
+All TypeScript code and YAML files are linted using [ESLint](https://eslint.org/), [typescript-eslint](https://typescript-eslint.io/), and [eslint-plugin-yml](https://ota-meshi.github.io/eslint-plugin-yml/). Linting can be run via:
 ```bash
 npm run lint
 ```

README.md

@@ -53,7 +53,7 @@ See [CLIENT_GENERATOR_GUIDE](CLIENT_GENERATOR_GUIDE.md).
 
 OpenSearch API Specs are hosted at https://opensearch-project.github.io/opensearch-api-specification/. See [PUBLISHING_SPECS](PUBLISHING_SPECS.md) for more information.
 
-Click [here](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main/opensearch-openapi.yaml) to download the latest OpenSearch OpenAPI yaml file.
+Click [here](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml) to download the latest OpenSearch OpenAPI yaml file.
 
 
 ## Security

eslint.config.mjs

@@ -1,23 +1,37 @@
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { FlatCompat } from '@eslint/eslintrc'
 import pluginJs from '@eslint/js'
+import pluginTs from '@typescript-eslint/eslint-plugin'
+import parserTs from '@typescript-eslint/parser'
+import eslintPluginYml from 'eslint-plugin-yml'
+import parserYml from "yaml-eslint-parser"
+import globals from 'globals'
 import licenseHeader from 'eslint-plugin-license-header'
 
-// mimic CommonJS variables -- not needed if using CommonJS
-const _filename = fileURLToPath(import.meta.url)
-const _dirname = path.dirname(_filename)
-const compat = new FlatCompat({ baseDirectory: _dirname, recommendedConfig: pluginJs.configs.recommended })
-
 export default [
   pluginJs.configs.recommended,
-  ...compat.extends('standard-with-typescript'),
   {
     files: ['**/*.{js,ts}'],
+    languageOptions: {
+      parser: parserTs,
+      parserOptions: {
+        project: './tsconfig.json'
+      },
+      globals: {
+        ...globals.jest,
+        ...globals.node,
+      },
+    },
     plugins: {
+      '@typescript-eslint': pluginTs,
       'license-header': licenseHeader
     },
     rules: {
+      ...pluginJs.configs.recommended.rules,
+      ...pluginTs.configs["recommended-type-checked"].rules,
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
       '@typescript-eslint/consistent-indexed-object-style': 'error',
       '@typescript-eslint/consistent-type-assertions': 'error',
       '@typescript-eslint/dot-notation': 'error',
@@ -58,6 +72,7 @@ export default [
       'new-cap': 'off',
       'no-return-assign': 'error',
       'object-shorthand': 'error',
+      'no-constant-condition': 'off',
       'license-header/header': [
         'error',
         [
@@ -72,5 +87,20 @@ export default [
         ]
       ]
     }
+  },
+  ...eslintPluginYml.configs['flat/standard'],
+  {
+    files: ["**/*.yaml", "**/*.yml"],
+    languageOptions: {
+      parser: parserYml
+    },
+    plugins: {
+      yml: eslintPluginYml
+    },
+    rules: {
+      'yml/no-empty-document': 'off',
+      'yml/quotes': 'off',
+      'yml/plain-scalar': 'off'
+    }
   }
 ]

json_schemas/test_story.schema.yaml

@@ -23,7 +23,7 @@ properties:
     items:
       $ref: '#/definitions/Chapter'
     minItems: 1
-required: [ description, chapters]
+required: [description, chapters]
 additionalProperties: false
 
 definitions:
@@ -37,7 +37,7 @@ definitions:
             description: A brief description of the chapter.
           response:
             $ref: '#/definitions/ExpectedResponse'
-        required: [ synopsis ]
+        required: [synopsis]
         additionalProperties: false
 
   ReadChapter:
@@ -47,7 +47,7 @@ definitions:
         properties:
           response:
             $ref: '#/definitions/ActualResponse'
-        required: [ response ]
+        required: [response]
         additionalProperties: false
 
   SupplementalChapter:
@@ -70,14 +70,14 @@ definitions:
         type: string
       method:
         type: string
-        enum: [ GET, PUT, POST, DELETE, PATCH, HEAD, OPTIONS ]
+        enum: [GET, PUT, POST, DELETE, PATCH, HEAD, OPTIONS]
       parameters:
         type: object
         additionalProperties:
           $ref: '#/definitions/Parameter'
       request_body:
         $ref: '#/definitions/RequestBody'
-    required: [ path, method ]
+    required: [path, method]
     additionalProperties: false
 
 
@@ -89,7 +89,7 @@ definitions:
         default: application/json
       payload:
         $ref: '#/definitions/Payload'
-    required: [ payload ]
+    required: [payload]
     additionalProperties: false
 
   ExpectedResponse:
@@ -104,7 +104,7 @@ definitions:
         default: application/json
       payload:
         $ref: '#/definitions/Payload'
-    required: [ status ]
+    required: [status]
     additionalProperties: false
 
   ActualResponse:
@@ -122,7 +122,7 @@ definitions:
       error:
         type: object
         description: Error object.
-    required: [ status, content_type, payload ]
+    required: [status, content_type, payload]
     additionalProperties: false
 
   Payload:

package.json

@@ -42,6 +42,7 @@
     "eslint-plugin-license-header": "^0.6.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-yml": "^1.14.0",
     "globals": "^15.0.0",
     "jest": "^29.7.0",
     "json-schema-to-typescript": "^14.0.4",