@plugjs/tsd 0.2.0

package/README.md

@@ -0,0 +1,7 @@
+Zip File Plugin for the PlugJS Build System
+===========================================
+
+Prototype build system from [Juit GmbH](https://www.juit.com/)
+
+* [Copyright Notice](https://github.com/plugjs/plug/blob/main/NOTICE.md)
+* [License](https://github.com/plugjs/plug/blob/main/LICENSE.md)

package/dist/index.cjs

@@ -0,0 +1,22 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+var import_fork = require("@plugjs/plug/fork");
+var import_paths = require("@plugjs/plug/paths");
+(0, import_fork.installForking)("tsd", (0, import_paths.requireResolve)(__filename, "./tsd"), "Tsd");
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,kBAA+B;AAC/B,mBAA+B;AAAA,IAkB/B,4BAAe,WAAO,6BAAe,YAAW,OAAO,GAAG,KAAK;",
+  "names": []
+}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export interface TsdOptions {
+    cwd?: string;
+    typingsFile?: string;
+}
+declare module '@plugjs/plug' {
+    interface Pipe {
+        /**
+         * Run all tests from incoming {@link Files} with `Tsd`.
+         *
+         * @param options Options to comfigure Tsd.
+         */
+        tsd(options?: TsdOptions): Pipe;
+    }
+}

package/dist/index.mjs

@@ -0,0 +1,5 @@
+// index.ts
+import { installForking } from "@plugjs/plug/fork";
+import { requireResolve } from "@plugjs/plug/paths";
+installForking("tsd", requireResolve(import.meta.url, "./tsd"), "Tsd");
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "mappings": ";AAAA,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAkB/B,eAAe,OAAO,eAAe,iBAAW,OAAO,GAAG,KAAK;",
+  "names": []
+}

package/dist/tsd.cjs

@@ -0,0 +1,78 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// tsd.ts
+var tsd_exports = {};
+__export(tsd_exports, {
+  Tsd: () => Tsd
+});
+module.exports = __toCommonJS(tsd_exports);
+var import_plug = require("@plugjs/plug");
+var import_logging = require("@plugjs/plug/logging");
+var import_paths = require("@plugjs/plug/paths");
+var tsdLib = __toESM(require("tsd"));
+var tsd = tsdLib.default.default ? tsdLib.default.default : tsdLib.default;
+var Tsd = class {
+  constructor(_options = {}) {
+    this._options = _options;
+  }
+  async pipe(files, context) {
+    const { cwd: _cwd, typingsFile: _typingsFile } = this._options;
+    const cwd = _cwd ? (0, import_plug.resolve)(_cwd) : (
+      /* coverage ignore next */
+      (0, import_paths.getCurrentWorkingDirectory)()
+    );
+    const typingsFile = _typingsFile && (0, import_paths.assertRelativeChildPath)(cwd, (0, import_plug.resolve)(_typingsFile));
+    const testFiles = [...import_plug.Files.builder(cwd).add(...files.absolutePaths()).build()];
+    void 0, context, this._options;
+    const diagnostics = await tsd({
+      cwd,
+      typingsFile,
+      testFiles
+    });
+    const report = context.log.report("Typescript Definitions Test");
+    for (const diag of diagnostics) {
+      const { fileName, column, line, message, severity } = diag;
+      const file = (0, import_paths.resolveAbsolutePath)(cwd, fileName);
+      const level = severity === "warning" ? import_logging.WARN : import_logging.ERROR;
+      if (level === import_logging.WARN && /__file_marker__/gm.test(message)) {
+        report.annotate(import_logging.NOTICE, file, "mark");
+      } else {
+        report.add({ line, column, file, message, level });
+      }
+    }
+    await report.loadSources();
+    report.done(true);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Tsd
+});
+//# sourceMappingURL=tsd.cjs.map

package/dist/tsd.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/tsd.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,kBAA+B;AAC/B,qBAAoC;AACpC,mBAAyF;AACzF,aAAwB;AAMxB,IAAM,MACW,eAAQ,UACN,eAAQ,UAChB;AAIJ,IAAM,MAAN,MAAgC;AAAA,EAErC,YAA6B,WAAuB,CAAC,GAAG;AAA3B;AAAA,EAA4B;AAAA,EAEzD,MAAM,KAAK,OAAc,SAAiC;AACxD,UAAM,EAAE,KAAK,MAAM,aAAa,aAAa,IAAI,KAAK;AAItD,UAAM,MAAM,WAAO,qBAAQ,IAAI;AAAA;AAAA,UAA+B,yCAA2B;AAAA;AACzF,UAAM,cAAc,oBAAgB,sCAAwB,SAAK,qBAAQ,YAAY,CAAC;AAGtF,UAAM,YAAY,CAAE,GAAG,kBAAM,QAAQ,GAAG,EAAE,IAAI,GAAG,MAAM,cAAc,CAAC,EAAE,MAAM,CAAE;AAChF,YAAY,SAAS,KAAK;AAG1B,UAAM,cAAc,MAAM,IAAI;AAAA,MAC5B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAGD,UAAM,SAAS,QAAQ,IAAI,OAAO,6BAA6B;AAC/D,eAAW,QAAQ,aAAa;AAC9B,YAAM,EAAE,UAAU,QAAQ,MAAM,SAAS,SAAS,IAAI;AACtD,YAAM,WAAO,kCAAoB,KAAK,QAAQ;AAC9C,YAAM,QAAQ,aAAa,YAAY,sBAAO;AAE9C,UAAK,UAAU,uBAAU,oBAAoB,KAAK,OAAO,GAAI;AAC3D,eAAO,SAAS,uBAAQ,MAAM,MAAM;AAAA,MACtC,OAAO;AACL,eAAO,IAAI,EAAE,MAAM,QAAQ,MAAM,SAAS,MAAM,CAAC;AAAA,MACnD;AAAA,IACF;AAGA,UAAM,OAAO,YAAY;AACzB,WAAO,KAAK,IAAI;AAAA,EAClB;AACF;",
+  "names": []
+}

package/dist/tsd.d.ts

@@ -0,0 +1,9 @@
+/// <reference path="index.d.ts" />
+import { Files } from '@plugjs/plug';
+import type { Context, PipeParameters, Plug } from '@plugjs/plug/pipe';
+/** Writes some info about the current {@link Files} being passed around. */
+export declare class Tsd implements Plug<void> {
+    private readonly _options;
+    constructor(...args: PipeParameters<'tsd'>);
+    pipe(files: Files, context: Context): Promise<void>;
+}

package/dist/tsd.mjs

@@ -0,0 +1,43 @@
+// tsd.ts
+import { Files, resolve } from "@plugjs/plug";
+import { ERROR, NOTICE, WARN } from "@plugjs/plug/logging";
+import { assertRelativeChildPath, getCurrentWorkingDirectory, resolveAbsolutePath } from "@plugjs/plug/paths";
+import * as tsdLib from "tsd";
+var tsd = tsdLib.default.default ? tsdLib.default.default : tsdLib.default;
+var Tsd = class {
+  constructor(_options = {}) {
+    this._options = _options;
+  }
+  async pipe(files, context) {
+    const { cwd: _cwd, typingsFile: _typingsFile } = this._options;
+    const cwd = _cwd ? resolve(_cwd) : (
+      /* coverage ignore next */
+      getCurrentWorkingDirectory()
+    );
+    const typingsFile = _typingsFile && assertRelativeChildPath(cwd, resolve(_typingsFile));
+    const testFiles = [...Files.builder(cwd).add(...files.absolutePaths()).build()];
+    void 0, context, this._options;
+    const diagnostics = await tsd({
+      cwd,
+      typingsFile,
+      testFiles
+    });
+    const report = context.log.report("Typescript Definitions Test");
+    for (const diag of diagnostics) {
+      const { fileName, column, line, message, severity } = diag;
+      const file = resolveAbsolutePath(cwd, fileName);
+      const level = severity === "warning" ? WARN : ERROR;
+      if (level === WARN && /__file_marker__/gm.test(message)) {
+        report.annotate(NOTICE, file, "mark");
+      } else {
+        report.add({ line, column, file, message, level });
+      }
+    }
+    await report.loadSources();
+    report.done(true);
+  }
+};
+export {
+  Tsd
+};
+//# sourceMappingURL=tsd.mjs.map

package/dist/tsd.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/tsd.ts"],
+  "mappings": ";AAGA,SAAS,OAAO,eAAe;AAC/B,SAAS,OAAO,QAAQ,YAAY;AACpC,SAAS,yBAAyB,4BAA4B,2BAA2B;AACzF,YAAY,YAAY;AAMxB,IAAM,MACW,eAAQ,UACN,eAAQ,UAChB;AAIJ,IAAM,MAAN,MAAgC;AAAA,EAErC,YAA6B,WAAuB,CAAC,GAAG;AAA3B;AAAA,EAA4B;AAAA,EAEzD,MAAM,KAAK,OAAc,SAAiC;AACxD,UAAM,EAAE,KAAK,MAAM,aAAa,aAAa,IAAI,KAAK;AAItD,UAAM,MAAM,OAAO,QAAQ,IAAI;AAAA;AAAA,MAA+B,2BAA2B;AAAA;AACzF,UAAM,cAAc,gBAAgB,wBAAwB,KAAK,QAAQ,YAAY,CAAC;AAGtF,UAAM,YAAY,CAAE,GAAG,MAAM,QAAQ,GAAG,EAAE,IAAI,GAAG,MAAM,cAAc,CAAC,EAAE,MAAM,CAAE;AAChF,YAAY,SAAS,KAAK;AAG1B,UAAM,cAAc,MAAM,IAAI;AAAA,MAC5B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAGD,UAAM,SAAS,QAAQ,IAAI,OAAO,6BAA6B;AAC/D,eAAW,QAAQ,aAAa;AAC9B,YAAM,EAAE,UAAU,QAAQ,MAAM,SAAS,SAAS,IAAI;AACtD,YAAM,OAAO,oBAAoB,KAAK,QAAQ;AAC9C,YAAM,QAAQ,aAAa,YAAY,OAAO;AAE9C,UAAK,UAAU,QAAU,oBAAoB,KAAK,OAAO,GAAI;AAC3D,eAAO,SAAS,QAAQ,MAAM,MAAM;AAAA,MACtC,OAAO;AACL,eAAO,IAAI,EAAE,MAAM,QAAQ,MAAM,SAAS,MAAM,CAAC;AAAA,MACnD;AAAA,IACF;AAGA,UAAM,OAAO,YAAY;AACzB,WAAO,KAAK,IAAI;AAAA,EAClB;AACF;",
+  "names": []
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@plugjs/tsd",
+  "version": "0.2.0",
+  "type": "commonjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "author": "Juit Developers <developers@juit.com>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "tsd": "^0.25.0"
+  },
+  "peerDependencies": {
+    "@plugjs/plug": "0.2.0"
+  },
+  "files": [
+    "*.md",
+    "dist/",
+    "src/"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+import { installForking } from '@plugjs/plug/fork'
+import { requireResolve } from '@plugjs/plug/paths'
+
+export interface TsdOptions {
+  cwd?: string,
+  typingsFile?: string,
+}
+
+declare module '@plugjs/plug' {
+  export interface Pipe {
+    /**
+     * Run all tests from incoming {@link Files} with `Tsd`.
+     *
+     * @param options Options to comfigure Tsd.
+     */
+    tsd(options?: TsdOptions): Pipe
+  }
+}
+
+installForking('tsd', requireResolve(__fileurl, './tsd'), 'Tsd')

package/src/tsd.ts

@@ -0,0 +1,60 @@
+// Reference ourselves, so that the constructor's parameters are correct
+/// <reference path="./index.ts" />
+
+import { Files, resolve } from '@plugjs/plug'
+import { ERROR, NOTICE, WARN } from '@plugjs/plug/logging'
+import { assertRelativeChildPath, getCurrentWorkingDirectory, resolveAbsolutePath } from '@plugjs/plug/paths'
+import * as tsdLib from 'tsd'
+
+import type { Context, PipeParameters, Plug } from '@plugjs/plug/pipe'
+import type { TsdOptions } from './index'
+
+// I _hate_ default exports!
+const tsd: typeof tsdLib.default =
+  (<any> tsdLib).default.default ?
+    (<any> tsdLib).default.default :
+    tsdLib.default
+
+
+/** Writes some info about the current {@link Files} being passed around. */
+export class Tsd implements Plug<void> {
+  constructor(...args: PipeParameters<'tsd'>)
+  constructor(private readonly _options: TsdOptions = {}) {}
+
+  async pipe(files: Files, context: Context): Promise<void> {
+    const { cwd: _cwd, typingsFile: _typingsFile } = this._options
+
+    // Resolve the absolute directory, and optionally the typings file relative to it
+    const cwd = _cwd ? resolve(_cwd) : /* coverage ignore next */ getCurrentWorkingDirectory()
+    const typingsFile = _typingsFile && assertRelativeChildPath(cwd, resolve(_typingsFile))
+
+    // Convert incoming files, relativizing them to the `cwd` specified in options
+    const testFiles = [ ...Files.builder(cwd).add(...files.absolutePaths()).build() ]
+    void files, context, this._options
+
+    // Let TSD do its thing
+    const diagnostics = await tsd({
+      cwd,
+      typingsFile,
+      testFiles,
+    })
+
+    // Prepare a report out of the diagnostics
+    const report = context.log.report('Typescript Definitions Test')
+    for (const diag of diagnostics) {
+      const { fileName, column, line, message, severity } = diag
+      const file = resolveAbsolutePath(cwd, fileName)
+      const level = severity === 'warning' ? WARN : ERROR
+
+      if ((level === WARN) && (/__file_marker__/gm.test(message))) {
+        report.annotate(NOTICE, file, 'mark')
+      } else {
+        report.add({ line, column, file, message, level })
+      }
+    }
+
+    // Load up sources and report!
+    await report.loadSources()
+    report.done(true)
+  }
+}