Add yml linting

Author: leeyi45

.github/actions/in-progress.yml

@@ -129,7 +129,7 @@ jobs:
   #   strategy:
   #     matrix:
   #       package: ${{ fromJson(needs.find-packages.outputs.tabs) }}
-    
+
   #   steps:
   #     - name: Check out source code
   #       uses: actions/checkout@v4
@@ -161,7 +161,7 @@ jobs:
   test-tabs:
     name: Test and Typecheck tabs
     runs-on: ubuntu-latest
-    needs: 
+    needs:
       - build-libs
       - find-packages
 
@@ -215,7 +215,7 @@ jobs:
           directory: ${{ matrix.package.directory }}
           packageName: ${{ matrix.package.name }}
           testRequired: ${{ steps.filter.outputs.changed == 'true' }}
-      
+
       - name: tsc and test
         if: steps.filter.outputs.changed == 'true'
         run: |

.github/workflows/pages-deploy.yml

@@ -16,24 +16,27 @@ jobs:
 
       - name: Enable Corepack
         run: corepack enable
-      
+
       - name: Use Node.js 💻
         uses: actions/setup-node@v4
         with:
           node-version: 22
           cache: yarn
-      
+
       - name: Install Dependencies 📦
         run: yarn install --immutable
-          
+
       - name: Build Modules 🔧
         run: yarn workspaces foreach -j 5 -ptW --from "./src/{bundles,tsc}/*" run build --tsc --lint
-      
+
+      - name: Build Docs
+        run: yarn build:docs
+
       - name: include java json
         run: cp -r src/java build
 
       - name: Deploy 🚀
         uses: peaceiris/actions-gh-pages@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }} 
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./build # The folder the action should deploy.

.github/workflows/pull-request.yml

@@ -45,78 +45,77 @@ jobs:
       docs: ${{ steps.filter.outputs.docs || steps.filter.outputs.workflows }}
       playwright: ${{ steps.filter.outputs.devserver || steps.filter.outputs.libraries || steps.filter.outputs.tabs }}
 
-
   test:
     name: Verify that all tests, linting, type-checking and building succeeds.
     runs-on: ubuntu-latest
 
     # execute after the paths-filter job is done
     needs: paths-filter
     steps:
-        - name: Check out source code
-          uses: actions/checkout@v4
-          with:
-            submodules: recursive
-
-        - name: Enable Corepack
-          run: corepack enable
-            
-        - name: Use Node.js 💻
-          uses: actions/setup-node@v4
-          with:
-            node-version-file: .node-version
-            cache: yarn
+      - name: Check out source code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Use Node.js 💻
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+          cache: yarn
 
         # For whatever reason, repotools refuses to install correctly, so we have to install it separately and
         # build it in its entirety before proceeding with installing everything else
-        - name: Setup Repotools
-          run: yarn workspaces focus @sourceacademy/modules-repotools && yarn workspaces foreach -A --include "@sourceacademy/modules-repotools" run build
+      - name: Setup Repotools
+        run: yarn workspaces focus @sourceacademy/modules-repotools && yarn workspaces foreach -A --include "@sourceacademy/modules-repotools" run build
+
+      - name: Install dependencies
+        run: yarn install --immutable
 
-        - name: Install dependencies
-          run: yarn install --immutable
+      - name: Install Playwright
+        if: needs.paths-filter.outputs.playwright == 'true'
+        run: yarn playwright install --with-deps
 
-        - name: Install Playwright
-          if: needs.paths-filter.outputs.playwright == 'true'
-          run: yarn playwright install --with-deps
+      - name: Run tsc for libraries
+        if: needs.paths-filter.outputs.libraries == 'true'
+        run: yarn workspaces foreach -ptW --from "./lib/*" run tsc
 
-        - name: Run tsc for libraries
-          if: needs.paths-filter.outputs.libraries == 'true'
-          run: yarn workspaces foreach -ptW --from "./lib/*" run tsc
+      - name: Run build for libraries
+        run: yarn workspaces foreach -ptW --from "./lib/*" run build
 
-        - name: Run build for libraries
-          run: yarn workspaces foreach -ptW --from "./lib/*" run build
+      - name: Run test for libraries
+        if: needs.paths-filter.outputs.libraries == 'true'
+        run: yarn test:libs
 
-        - name: Run test for libraries
-          if: needs.paths-filter.outputs.libraries == 'true'
-          run: yarn test:libs
+      - name: Build and run tsc for bundles and tabs
+        if: needs.paths-filter.outputs.bundles == 'true' || needs.paths-filter.outputs.tabs == 'true'
+        run: yarn workspaces foreach -j 5 -ptW --from "./src/{bundles,tabs}/*" run build --tsc
 
-        - name: Build and run tsc for bundles and tabs
-          if: needs.paths-filter.outputs.bundles == 'true' || needs.paths-filter.outputs.tabs == 'true'
-          run: yarn workspaces foreach -j 5 -ptW --from "./src/{bundles,tabs}/*" run build --tsc
+      - name: Test bundles
+        if: needs.paths-filter.outputs.bundles == 'true'
+        run: yarn workspaces foreach -j 5 -ptW --from "./src/bundles/*" run test
 
-        - name: Test bundles
-          if: needs.paths-filter.outputs.bundles == 'true'
-          run: yarn workspaces foreach -j 5 -ptW --from "./src/bundles/*" run test
+      - name: Test tabs
+        if: needs.paths-filter.outputs.tabs == 'true'
+        run: yarn workspaces foreach -j 5 -ptW --from "./src/tabs/*" run test
 
-        - name: Test tabs
-          if: needs.paths-filter.outputs.tabs == 'true'
-          run: yarn workspaces foreach -j 5 -ptW --from "./src/tabs/*" run test
+      - name: Build manifest
+        if: needs.paths-filter.outputs.devserver == 'true'
+        run: yarn buildtools manifest
 
-        - name: Build manifest
-          if: needs.paths-filter.outputs.devserver == 'true'
-          run: yarn buildtools manifest
+      - name: Build Docs Server
+        if: needs.paths-filter.outputs.docs == 'true'
+        run: yarn workspaces foreach -A --include "@sourceacademy/modules-docserver" run build
 
-        - name: Build Docs Server
-          if: needs.paths-filter.outputs.docs == 'true'
-          run: yarn workspaces foreach -A --include "@sourceacademy/modules-docserver" run build
-        
-        - name: Run tsc for Dev Server
-          if: needs.paths-filter.outputs.devserver == 'true'
-          run: yarn tsc:devserver
+      - name: Run tsc for Dev Server
+        if: needs.paths-filter.outputs.devserver == 'true'
+        run: yarn tsc:devserver
 
-        - name: Test Dev Server
-          if: needs.paths-filter.outputs.devserver == 'true'
-          run: yarn test:devserver
+      - name: Test Dev Server
+        if: needs.paths-filter.outputs.devserver == 'true'
+        run: yarn test:devserver
 
-        - name: Lint Everything
-          run: yarn buildtools lintglobal
+      - name: Lint Everything
+        run: yarn buildtools lintglobal

.vscode/settings.json

@@ -16,5 +16,15 @@
         }
       }
     }
+  ],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "json",
+    "mdx",
+    "typescript",
+    "typescriptreact",
+    "yml",
+    "yaml"
   ]
 }

eslint.config.js

@@ -10,6 +10,7 @@ import * as importPlugin from 'eslint-plugin-import';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 import reactPlugin from 'eslint-plugin-react';
 import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import ymlPlugin from 'eslint-plugin-yml';
 import globals from 'globals';
 import jsonParser from 'jsonc-eslint-parser';
 import tseslint from 'typescript-eslint';
@@ -30,6 +31,7 @@ export default tseslint.config(
       'build/**',
       'docs/.vitepress/cache',
       'devserver/vite.config.ts', // Don't lint this because there's no tsconfig properly configured for it
+      'node_modules',
       'lib/buildtools/bin',
       'lib/buildtools/src/build/__test_mocks__',
       'src/**/samples/**',
@@ -60,6 +62,7 @@ export default tseslint.config(
     }
   },
   // #endregion markdown
+
   {
     name: 'Global Configuration (Excluding Markdown)',
     // We exclude markdown because the markdown code processor doesn't support
@@ -82,6 +85,22 @@ export default tseslint.config(
       ],
     }
   },
+  {
+    name: 'YML Files',
+    extends: [ymlPlugin.configs['flat/recommended']],
+    files: ['**/*.yml', '**/*.yaml'],
+    plugins: {
+      yml: ymlPlugin
+    },
+    rules: {
+      'yml/indent': 'warn',
+      'yml/no-tab-indent': 'error',
+
+      // based on https://ota-meshi.github.io/eslint-plugin-yml/rules/spaced-comment.html
+      '@stylistic/spaced-comment': 'off',
+      'yml/spaced-comment': 'warn'
+    }
+  },
   {
     name: 'JSON Files',
     files: ['**/*.json'],

package.json

@@ -68,6 +68,7 @@
     "eslint-plugin-jsdoc": "^51.3.1",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-yml": "^1.18.0",
     "http-server": "^0.13.0",
     "husky": "^9.1.7",
     "jsdom": "^26.1.0",

yarn.lock

@@ -3561,6 +3561,7 @@ __metadata:
     eslint-plugin-jsdoc: "npm:^51.3.1"
     eslint-plugin-react: "npm:^7.37.4"
     eslint-plugin-react-hooks: "npm:^5.1.0"
+    eslint-plugin-yml: "npm:^1.18.0"
     http-server: "npm:^0.13.0"
     husky: "npm:^9.1.7"
     js-slang: "npm:^1.0.81"
@@ -8020,7 +8021,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"escape-string-regexp@npm:^4.0.0":
+"escape-string-regexp@npm:4.0.0, escape-string-regexp@npm:^4.0.0":
   version: 4.0.0
   resolution: "escape-string-regexp@npm:4.0.0"
   checksum: 10c0/9497d4dd307d845bd7f75180d8188bb17ea8c151c1edbf6b6717c100e104d629dc2dfb687686181b0f4b7d732c7dfdc4d5e7a8ff72de1b0ca283a75bbb3a9cd9
@@ -8034,6 +8035,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-compat-utils@npm:^0.6.0":
+  version: 0.6.5
+  resolution: "eslint-compat-utils@npm:0.6.5"
+  dependencies:
+    semver: "npm:^7.5.4"
+  peerDependencies:
+    eslint: ">=6.0.0"
+  checksum: 10c0/f3519e1460ec82c6967c4b0132801924bf5c17328999014f444ec12f075b151e992d1ebf378cb8eb0b2e00b3d04e0eaac80897209121fd115f857598b4588393
+  languageName: node
+  linkType: hard
+
 "eslint-import-resolver-node@npm:^0.3.9":
   version: 0.3.9
   resolution: "eslint-import-resolver-node@npm:0.3.9"
@@ -8143,6 +8155,21 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-plugin-yml@npm:^1.18.0":
+  version: 1.18.0
+  resolution: "eslint-plugin-yml@npm:1.18.0"
+  dependencies:
+    debug: "npm:^4.3.2"
+    escape-string-regexp: "npm:4.0.0"
+    eslint-compat-utils: "npm:^0.6.0"
+    natural-compare: "npm:^1.4.0"
+    yaml-eslint-parser: "npm:^1.2.1"
+  peerDependencies:
+    eslint: ">=6.0.0"
+  checksum: 10c0/ff6619bb488c98f3b6639c58f135f375bba6a4e4763cfeded461c6bbe654164678055981d1a27949568efc5ca9f3904e3abdda593b837cabb96f58948cc2d6be
+  languageName: node
+  linkType: hard
+
 "eslint-scope@npm:^8.4.0":
   version: 8.4.0
   resolution: "eslint-scope@npm:8.4.0"
@@ -13496,7 +13523,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"semver@npm:^7.3.5, semver@npm:^7.5.3, semver@npm:^7.6.0, semver@npm:^7.7.2":
+"semver@npm:^7.3.5, semver@npm:^7.5.3, semver@npm:^7.5.4, semver@npm:^7.6.0, semver@npm:^7.7.2":
   version: 7.7.2
   resolution: "semver@npm:7.7.2"
   bin:
@@ -15816,7 +15843,17 @@ __metadata:
   languageName: node
   linkType: hard
 
-"yaml@npm:^2.7.0, yaml@npm:^2.8.0":
+"yaml-eslint-parser@npm:^1.2.1":
+  version: 1.3.0
+  resolution: "yaml-eslint-parser@npm:1.3.0"
+  dependencies:
+    eslint-visitor-keys: "npm:^3.0.0"
+    yaml: "npm:^2.0.0"
+  checksum: 10c0/160a8dcb97e65e08de85069898379fbecad85838384797df9695f4cb51e48a195e57b3f3fc5abb35eec7c8d1329c3b7b92b12999f5f20c314d9a7d8d549de105
+  languageName: node
+  linkType: hard
+
+"yaml@npm:^2.0.0, yaml@npm:^2.7.0, yaml@npm:^2.8.0":
   version: 2.8.0
   resolution: "yaml@npm:2.8.0"
   bin: