@dotcom-tool-kit/typescript 1.0.0

package/.toolkitrc.yml

@@ -0,0 +1,4 @@
+hooks:
+  'build:local': TypescriptBuild
+  'run:local': TypeScriptWatch
+  'test:local': TypescriptTest

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { TypeScriptWatch } from './tasks/typescript';
+export declare const tasks: (typeof TypeScriptWatch)[];
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,eAAe,EAAkB,MAAM,oBAAoB,CAAA;AAErF,eAAO,MAAM,KAAK,4BAAqD,CAAA"}

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tasks = void 0;
+const typescript_1 = require("./tasks/typescript");
+exports.tasks = [typescript_1.TypeScriptBuild, typescript_1.TypeScriptWatch, typescript_1.TypeScriptTest];

package/lib/tasks/typescript.d.ts

@@ -0,0 +1,20 @@
+import { Task } from '@dotcom-tool-kit/types';
+import type { TypeScriptSchema } from '@dotcom-tool-kit/types/lib/schema/typescript';
+declare abstract class TypeScriptTask extends Task<typeof TypeScriptSchema> {
+    abstract taskArgs: string[];
+    run(): Promise<void>;
+}
+export declare class TypeScriptBuild extends TypeScriptTask {
+    static description: string;
+    taskArgs: never[];
+}
+export declare class TypeScriptWatch extends TypeScriptTask {
+    static description: string;
+    taskArgs: string[];
+}
+export declare class TypeScriptTest extends TypeScriptTask {
+    static description: string;
+    taskArgs: string[];
+}
+export {};
+//# sourceMappingURL=typescript.d.ts.map

package/lib/tasks/typescript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/tasks/typescript.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAKpF,uBAAe,cAAe,SAAQ,IAAI,CAAC,OAAO,gBAAgB,CAAC;IACjE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;IAErB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAqB3B;AAED,qBAAa,eAAgB,SAAQ,cAAc;IACjD,MAAM,CAAC,WAAW,SAAqC;IAEvD,QAAQ,UAAK;CACd;AAED,qBAAa,eAAgB,SAAQ,cAAc;IACjD,MAAM,CAAC,WAAW,SAAiD;IAEnE,QAAQ,WAAc;CACvB;AAED,qBAAa,cAAe,SAAQ,cAAc;IAChD,MAAM,CAAC,WAAW,SAA+B;IAEjD,QAAQ,WAAe;CACxB"}

package/lib/tasks/typescript.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeScriptTest = exports.TypeScriptWatch = exports.TypeScriptBuild = void 0;
+const logger_1 = require("@dotcom-tool-kit/logger");
+const types_1 = require("@dotcom-tool-kit/types");
+const child_process_1 = require("child_process");
+const tscPath = require.resolve('typescript/bin/tsc');
+class TypeScriptTask extends types_1.Task {
+    async run() {
+        // TODO: add monorepo support with --build option
+        const args = [...this.taskArgs];
+        if (this.options.configPath) {
+            args.unshift('--project', this.options.configPath);
+        }
+        if (this.options.extraArgs) {
+            args.push(...this.options.extraArgs);
+        }
+        const child = (0, child_process_1.fork)(tscPath, args, { silent: true });
+        (0, logger_1.hookFork)(this.logger, 'typescript', child);
+        const exitPromise = (0, logger_1.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');
+    }
+}
+class TypeScriptBuild extends TypeScriptTask {
+    constructor() {
+        super(...arguments);
+        this.taskArgs = [];
+    }
+}
+exports.TypeScriptBuild = TypeScriptBuild;
+TypeScriptBuild.description = 'compile TypeScript to JavaScript';
+class TypeScriptWatch extends TypeScriptTask {
+    constructor() {
+        super(...arguments);
+        this.taskArgs = ['--watch'];
+    }
+}
+exports.TypeScriptWatch = TypeScriptWatch;
+TypeScriptWatch.description = 'rebuild TypeScript project every file change';
+class TypeScriptTest extends TypeScriptTask {
+    constructor() {
+        super(...arguments);
+        this.taskArgs = ['--noEmit'];
+    }
+}
+exports.TypeScriptTest = TypeScriptTest;
+TypeScriptTest.description = 'type check TypeScript code';

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@dotcom-tool-kit/typescript",
+  "version": "1.0.0",
+  "description": "",
+  "main": "lib",
+  "scripts": {
+    "test": "cd ../../ ; npx jest --silent --projects plugins/typescript"
+  },
+  "keywords": [],
+  "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/financial-times/dotcom-tool-kit.git",
+    "directory": "plugins/typescript"
+  },
+  "bugs": "https://github.com/financial-times/dotcom-tool-kit/issues",
+  "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/typescript",
+  "files": [
+    "/lib",
+    ".toolkitrc.yml"
+  ],
+  "peerDependencies": {
+    "dotcom-tool-kit": "2.x",
+    "typescript": "3.x || 4.x"
+  },
+  "dependencies": {
+    "@dotcom-tool-kit/logger": "^2.1.2",
+    "@dotcom-tool-kit/types": "^2.8.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.3.1",
+    "typescript": "^4.9.4",
+    "winston": "^3.8.2"
+  }
+}

package/readme.md

@@ -0,0 +1,33 @@
+# @dotcom-tool-kit/typescript
+
+Tool Kit plugin to build [TypeScript](https://www.typescriptlang.org) code
+
+## Installation & Usage
+
+With Tool Kit [already set up](https://github.com/financial-times/dotcom-tool-kit#installing-and-using-tool-kit), install this plugin as a dev dependency:
+
+```sh
+npm install --save-dev @dotcom-tool-kit/typescript
+```
+
+And add it to your repo's `.toolkitrc.yml`:
+
+```yml
+plugins:
+  - '@dotcom-tool-kit/typescript'
+```
+
+## Options
+
+| Key | Description | Default value |
+|-|-|-|
+| `configPath` | Path to the [TypeScript config file](https://www.typescriptlang.org/tsconfig) | use TypeScript's own [tsconfig.json resolution](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#using-tsconfigjson-or-jsconfigjson) |
+| `extraArgs` | Extra [arguments](https://www.typescriptlang.org/docs/handbook/compiler-options.html) to pass to the tsc CLI that can't be set in `tsconfig.json` | `[]`
+
+## Tasks
+
+| Task | Description | Preconfigured hook |
+|-|-|-|
+| `TypeScriptBuild` | runs `tsc` to compile TypeScript to JavaScript | `build:local` |
+| `TypeScriptWatch` | rebuild project on every project file change | `run:local` |
+| `TypeScriptTest` | type check TypeScript code without emitting code | `test:local` |