Add new tsc command that automatically filters tests

Author: leeyi45

.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

@@ -6,7 +6,7 @@ on:
 
 jobs:
   paths-filter:
-    name: Determine which files are changed
+    name: Determine which files have changed
     runs-on: ubuntu-latest
     steps:
       - name: Check out source code
@@ -19,25 +19,19 @@ jobs:
         id: filter
         with:
           filters: |
+            workflows:
+            - .github/workflows/**
             devserver:
             - 'devserver/**'
             libraries:
             - 'lib/**'
             modules:
             - src/{bundles,tabs}/**
-
-      - if: steps.filter.outputs.devserver == 'true'
-        run: echo "Changes detected in devserver"
-
-      - if: steps.filter.outputs.libraries == 'true'
-        run: echo "Changes detected in libraries"      
-      
-      - if: steps.filter.outputs.modules == 'true'
-        run: echo "Changes detected in modules"
     outputs:
-      devserver: ${{ steps.filter.outputs.devserver }}
-      modules: ${{ steps.filter.outputs.modules }}
-      libraries: ${{ steps.filter.outputs.libraries }}
+      # if the workflow file was modified, then we rerun the entire job
+      devserver: ${{ steps.filter.outputs.devserver || steps.filter.outputs.workflows }}
+      modules: ${{ steps.filter.outputs.modules || steps.filter.outputs.workflows }}
+      libraries: ${{ steps.filter.outputs.libraries || steps.filter.outputs.workflows }}
 
   test:
     name: Verify all tests pass and build success
@@ -77,11 +71,7 @@ jobs:
 
         - name: Build, lint and run tsc for bundles and tabs
           if: needs.paths-filter.outputs.modules == 'true'
-          run: yarn workspaces foreach -ptW --from "./src/{bundles,tsc}/*" run build --tsc --lint
-
-        - name: Lint bundles and tabs
-          if: needs.paths-filter.outputs.modules == 'true'
-          run: yarn lint:modules
+          run: yarn workspaces foreach -j 5 -ptW --from "./src/{bundles,tsc}/*" run build --tsc --lint
 
         - name: Test bundles and tabs
           if: needs.paths-filter.outputs.modules == 'true'

lib/buildtools/src/__test_mocks__/bundles/test0/src/__tests__/test0.test.ts

@@ -1,4 +1,4 @@
 {
-  "include": ["src/index.ts"],
+  "include": ["src"],
   "extends": ["../tsconfig.json"]
 }

lib/buildtools/src/__test_mocks__/bundles/test0/tsconfig.json

@@ -14,8 +14,6 @@
     "module": "esnext",
     /* Specify the module resolution strategy: 'node' (Node.js) or 'classic' (used in TypeScript before the release of 1.6). */
     "moduleResolution": "node",
-    /* Do not emit compiler output files like JavaScript source code, source-maps or declarations. */
-    "noEmit": true,
     /* Allows importing modules with a ‘.json’ extension, which is a common practice in node projects. */
     "resolveJsonModule": true,
     /* The longest common path of all non-declaration input files. */

lib/buildtools/src/__test_mocks__/bundles/tsconfig.json

@@ -2,7 +2,7 @@ import { ESLint } from 'eslint';
 import { beforeEach, vi, expect, describe, test } from 'vitest';
 import * as manifest from '../../build/manifest.js';
 import * as utils from '../../getGitRoot.js';
-import { getLintCommand } from '../lint.js';
+import { getLintCommand } from '../prebuild.js';
 import { getCommandRunner } from './testingUtils.js';
 
 const lintFilesMock = vi.hoisted(() => vi.fn());

lib/buildtools/src/commands/__tests__/lint.test.ts

@@ -1,7 +1,7 @@
 import { Command } from '@commander-js/extra-typings';
 import { getBuildCommand } from './build.js';
-import { getLintCommand } from './lint.js';
 import { getListCommand } from './list.js';
+import { getLintCommand, getTscCommand } from './prebuild.js';
 import getTemplateCommand from './template.js';
 import { getTestCommand } from './testing.js';
 
@@ -10,4 +10,5 @@ export const getMainCommand = () => new Command()
   .addCommand(getLintCommand())
   .addCommand(getListCommand())
   .addCommand(getTemplateCommand())
-  .addCommand(getTestCommand());
+  .addCommand(getTestCommand())
+  .addCommand(getTscCommand());

lib/buildtools/src/commands/main.ts

@@ -7,6 +7,7 @@ import pathlib from 'path';
 import { Command } from '@commander-js/extra-typings';
 import { resolveEitherBundleOrTab } from '../build/manifest.js';
 import { formatLintResult, runEslint } from '../prebuild/lint.js';
+import { formatTscResult, runTsc } from '../prebuild/tsc.js';
 import { logCommandErrorAndExit } from './commandUtils.js';
 
 export const getLintCommand = () => new Command('lint')
@@ -34,3 +35,31 @@ export const getLintCommand = () => new Command('lint')
       }
     }
   });
+
+// This command is provided as an augmented way to run tsc, automatically
+// filtering out test files
+export const getTscCommand = () => new Command('tsc')
+  .description('Run tsc for the given directory, or the current directory if no directory is specified')
+  .argument('[directory]', 'Directory to run tsc in', process.cwd())
+  .option('--no-emit', 'Prevent the typescript compiler from outputting files regardless of the tsconfig setting')
+  .option('--ci')
+  .action(async (directory, { emit, ci }) => {
+    const fullyResolved = pathlib.resolve(directory);
+    const asset = await resolveEitherBundleOrTab(fullyResolved);
+
+    if (!asset) {
+      logCommandErrorAndExit(`No tab or bundle found at ${fullyResolved}`);
+    }
+
+    const result = await runTsc(asset, !emit);
+    console.log(formatTscResult(result));
+
+    switch (result.severity) {
+      case 'warn': {
+        if (!ci) return;
+      }
+      case 'error': {
+        process.exit(1);
+      }
+    }
+  });

lib/buildtools/src/commands/lint.ts renamed to lib/buildtools/src/commands/prebuild.ts

@@ -0,0 +1,91 @@
+import ts from 'typescript';
+import { describe, expect, test, vi } from 'vitest';
+import { testMocksDir } from '../../__tests__/fixtures.js';
+import { runTsc } from '../tsc.js';
+
+const mockedWriteFile = vi.hoisted(() => vi.fn<(arg0: string, arg1: string) => void>(() => undefined));
+
+vi.mock(import('typescript'), async importOriginal => {
+  const { default: original } = await importOriginal();
+
+  // @ts-expect-error createProgram has two overloads but we can only really define 1
+  const createProgram: typeof original.createProgram = vi.fn((opts: ts.CreateProgramOptions) => {
+    const program = original.createProgram(opts);
+    const emit: typeof program.emit = (sourceFile, _, cancelToken, emitDts, transformers) => {
+      return program.emit(sourceFile, mockedWriteFile, cancelToken, emitDts, transformers);
+    };
+
+    return {
+      ...program,
+      emit
+    };
+  });
+
+  return {
+    default: {
+      ...original,
+      createProgram,
+    }
+  };
+});
+
+describe('Test the augmented tsc functionality', () => {
+  test('tsc on a bundle', async () => {
+    await runTsc({
+      type: 'bundle',
+      directory: `${testMocksDir}/bundles/test0`,
+      name: 'test0',
+      manifest: {}
+    }, false);
+
+    expect(ts.createProgram).toHaveBeenCalledTimes(2);
+    expect(mockedWriteFile).toHaveBeenCalledTimes(1);
+    const [[writePath]] = mockedWriteFile.mock.calls;
+
+    expect(writePath).not.toEqual(`${testMocksDir}/bundles/test0/__tests__/test0.test.js`,);
+  });
+
+  test('tsc on a bundle with --noEmit', async () => {
+    await runTsc({
+      type: 'bundle',
+      directory: `${testMocksDir}/bundles/test0`,
+      name: 'test0',
+      manifest: {}
+    }, true);
+
+    expect(ts.createProgram).toHaveBeenCalledTimes(1);
+    expect(mockedWriteFile).not.toBeCalled();
+  });
+
+  test('tsc on a bundle with noEmit in its tsconfig', async () => {
+    const originalTs: typeof ts = await vi.importActual('typescript');
+
+    vi.spyOn(ts, 'parseJsonConfigFileContent').mockImplementationOnce((...args) => {
+      const rawResult = originalTs.parseJsonConfigFileContent(...args);
+      rawResult.options.noEmit = true;
+      return rawResult;
+    });
+
+    await runTsc({
+      type: 'bundle',
+      directory: `${testMocksDir}/bundles/test0`,
+      name: 'test0',
+      manifest: {}
+    }, false);
+
+    expect(ts.createProgram).toHaveBeenCalledTimes(1);
+    expect(mockedWriteFile).not.toBeCalled();
+  });
+
+  test('tsc on a tab', async () => {
+    await runTsc({
+      type: 'tab',
+      directory: `${testMocksDir}/tabs/tab0`,
+      entryPoint: `${testMocksDir}/tabs/tab0/src/index.tsx`,
+      name: 'tab0'
+    }, false);
+
+    expect(ts.createProgram).toHaveBeenCalledTimes(1);
+    expect(mockedWriteFile).not.toBeCalled();
+  });
+});

lib/buildtools/src/prebuild/__tests__/tsc.test.ts

@@ -68,7 +68,7 @@ async function getTsconfig(srcDir: string): Promise<TsconfigResult> {
 export const {
   builder: runTsc,
   formatter: formatTscResult
-} = createPrebuilder<TscResult>(async input => {
+} = createPrebuilder<TscResult, [noEmit: boolean]>(async (input, noEmit) => {
   const tsconfigRes = await getTsconfig(input.directory);
   if (tsconfigRes.severity === 'error') {
     return {
@@ -101,7 +101,8 @@ export const {
       }
     });
 
-    if (severity !== 'error' && !tsconfig.noEmit) {
+    noEmit = tsconfig.noEmit ?? noEmit;
+    if (severity !== 'error' && !noEmit ) {
       // If noEmit isn't specified, then run tsc again without including test
       // files and actually output the files
       const filesWithoutTests = fileNames.filter(p => {