Transition to Yarn Workspaces

.github/workflows/pages-deploy.yml

@@ -20,14 +20,14 @@ jobs:
       - name: Use Node.js 💻
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           cache: yarn
 
       - name: Install Dependencies 📦
         run: yarn install --immutable
 
       - name: Build Modules 🔧
-        run: yarn build --tsc --lint
+        run: yarn workspaces foreach -j 5 -ptW --from "./src/{bundles,tsc}/*" run build --tsc --lint
 
       - name: include java json
         run: cp -r src/java build

.github/workflows/pull-request.yml

@@ -5,36 +5,108 @@
       - master
 
 jobs:
+  paths-filter:
+    name: Determine which files have changed
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Filter paths
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            workflows:
+            - .github/workflows/**
+            devserver:
+            - 'devserver/**'
+            libraries:
+            - 'lib/**'
+            tabs:
+            - src/tabs/**
+            bundles:
+            - src/bundles/**
+            docs:
+            - docs/**
+    outputs:
+      # if the workflow file was modified, then we rerun the entire job
+      devserver: ${{ steps.filter.outputs.devserver || steps.filter.outputs.workflows }}
+      # if the devserver needs to be tested bundles and tabs need to be rebuilt
+      tabs: ${{ steps.filter.outputs.tabs || steps.filter.outputs.workflows || steps.filter.outputs.devserver }}
+      bundles: ${{ steps.filter.outputs.bundles || steps.filter.outputs.workflows || steps.filter.outputs.devserver }}
+      libraries: ${{ steps.filter.outputs.libraries || steps.filter.outputs.workflows }}
+      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 all tests pass and build success
+    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: 20
+            node-version: 22
             cache: yarn
 
+        # - 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: Build bundles and tabs
-          run: yarn build --tsc --lint
+        - 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 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: 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: Build manifest
+          if: needs.paths-filter.outputs.devserver == 'true'
+          run: yarn buildtools manifest
 
-        - name: Test bundles and tabs
-          run: yarn test --color
+        - 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: Test and lint scripts
-          run: yarn scripts:tsc && yarn scripts:lint && yarn scripts:test --color
+        - name: Test Dev Server
+          if: needs.paths-filter.outputs.devserver == 'true'
+          run: yarn test:devserver
 
-        - name: Check and Lint Devserver
-          run: yarn devserver:tsc && yarn devserver:lint
-
+        - name: Lint Everything
+          run: yarn buildtools lintglobal

.gitignore

@@ -4,9 +4,12 @@
 node_modules/
 devserver/node_modules
 build/*
+**/dist/**
 coverage/
 
-scripts/dist
+.yarn/*
+!.yarn/
+!.yarn/patches
 
 # Compiled source #
 ###################
@@ -45,3 +48,5 @@ scripts/dist
 .Trashes
 ehthumbs.db
 Thumbs.db
+
+**/__tests__/**/__screenshots__

.husky/pre-push

@@ -1 +1,6 @@
-yarn build --lint --tsc
+yarn constraints
+yarn workspaces foreach -ptR -j 5 --since --include "./src/{bundles,tabs}/*" run buildtools prebuild
+yarn workspaces foreach -ptR -j 5 --since --include "./src/{bundles,tabs}/*" run test
+yarn workspaces foreach -ptW --since --include "./{lib,devserver}/*" run lint
+yarn workspaces foreach -ptW --since --include "./{lib,devserver}/*" run tsc
+yarn workspaces foreach -ptW --since --include "./{lib,devserver}/*" run test

.node-version

@@ -1 +1 @@
-20.11.1
+22.16.0

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "files.insertFinalNewline": true,
+  "json.schemas": [
+    {
+      "fileMatch": ["src/bundles/**/manifest.json"],
+      "url": "./lib/repotools/src/manifest.schema.json"
+    },
+    {
+      "fileMatch": ["tsconfig.json", "tsconfig.*.json"],
+      "schema": {
+        "allOf": [{ "$ref": "http://json.schemastore.org/tsconfig" }],
+        "properties": {
+          "typedocOptions": {
+            "allOf": [{ "$ref": "https://typedoc.org/schema.json" }]
+          }
+        }
+      }
+    }
+  ]
+}