@dotcom-tool-kit/typescript 4.0.1 → 4.1.0

package/lib/tasks/typescript.js

@@ -53,3 +53,4 @@ class TypeScript extends base_1.Task {
     }
 }
 exports.default = TypeScript;
+//# sourceMappingURL=typescript.js.map

package/lib/tasks/typescript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript.js","sourceRoot":"","sources":["../../src/tasks/typescript.ts"],"names":[],"mappings":";;;;AAAA,oDAA8D;AAC9D,gDAA4D;AAC5D,iDAAoC;AACpC,+CAAwB;AAExB,MAAM,gBAAgB,GAAG,CAAC;KACvB,MAAM,CAAC;IACN,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,2OAA2O,CAC5O;IACH,KAAK,EAAE,CAAC;SACL,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,EAAE;SACV,QAAQ,CACP,iIAAiI,CAClI;IACH,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC3E,MAAM,EAAE,CAAC;SACN,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,EAAE;SACV,QAAQ,CACP,iGAAiG,CAClG;CACJ,CAAC;KACD,QAAQ,CAAC,0BAA0B,CAAC,CAAA;AACV,kCAAM;AAEnC,MAAqB,UAAW,SAAQ,WAAuC;IAC7E,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAkB;QAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACvE,MAAM,IAAI,GAAG,EAAE,CAAA;QAEf,iCAAiC;QACjC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACvB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjD,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,oBAAI,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;QACxD,IAAA,iBAAQ,EAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;QAC1C,MAAM,WAAW,GAAG,IAAA,mBAAU,EAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnD,mEAAmE;QACnE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,WAAW,CAAA;QACnB,CAAC;QAED,qEAAqE;QACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;IAChD,CAAC;CACF;AAjCD,6BAiCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/typescript",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -18,11 +18,12 @@
   "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/typescript",
   "files": [
     "/lib",
+    "/src",
     ".toolkitrc.yml"
   ],
   "peerDependencies": {
     "dotcom-tool-kit": "5.x",
-    "typescript": "3.x || 4.x || 5.x"
+    "typescript": "3.x || 4.x || 5.x || 6.x"
   },
   "dependencies": {
     "@dotcom-tool-kit/base": "^2.1.0",

package/src/tasks/typescript.ts

@@ -0,0 +1,64 @@
+import { hookFork, waitOnExit } from '@dotcom-tool-kit/logger'
+import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import { fork } from 'child_process'
+import * as z from 'zod'
+
+const TypeScriptSchema = z
+  .object({
+    configPath: z
+      .string()
+      .optional()
+      .describe(
+        "to the [TypeScript config file](https://www.typescriptlang.org/tsconfig). Uses TypeScript's own [tsconfig.json resolution](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#using-tsconfigjson-or-jsconfigjson) by default"
+      ),
+    build: z
+      .literal(true)
+      .optional()
+      .describe(
+        'Run Typescript in [build mode](https://www.typescriptlang.org/docs/handbook/project-references.html#build-mode-for-typescript).'
+      ),
+    watch: z.literal(true).optional().describe('Run Typescript in watch mode.'),
+    noEmit: z
+      .literal(true)
+      .optional()
+      .describe(
+        'Run Typescript with `--noEmit`, for checking your types without outputting compiled Javascript.'
+      )
+  })
+  .describe('Compile code with `tsc`.')
+export { TypeScriptSchema as schema }
+
+export default class TypeScript extends Task<{ task: typeof TypeScriptSchema }> {
+  async run({ cwd }: TaskRunContext): Promise<void> {
+    const tscPath = require.resolve('typescript/bin/tsc', { paths: [cwd] })
+    const args = []
+
+    // TODO:KB:20240408 refactor this
+    if (this.options.build) {
+      args.push('--build')
+    }
+
+    if (this.options.watch) {
+      args.push('--watch')
+    }
+
+    if (this.options.noEmit) {
+      args.push('--noEmit')
+    }
+
+    if (this.options.configPath) {
+      args.push('--project', this.options.configPath)
+    }
+
+    const child = fork(tscPath, args, { silent: true, cwd })
+    hookFork(this.logger, 'typescript', child)
+    const exitPromise = waitOnExit('typescript', child)
+    // don't wait for tsc to exit if it's set to watch for file changes
+    if (!args.includes('--watch')) {
+      await exitPromise
+    }
+
+    // tsc is quite quiet by default so let the user know it actually ran
+    this.logger.info('code compiled successfully')
+  }
+}