npm - @rushstack/typings-generator - Versions diffs - 0.4.6 → 0.5.0 - Mend

@rushstack/typings-generator 0.4.6 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/CHANGELOG.json +20 -0
package/CHANGELOG.md +8 -1
package/README.md +4 -5
package/dist/tsdoc-metadata.json +1 -1
package/dist/typings-generator.d.ts +6 -2
package/lib/TypingsGenerator.d.ts +6 -2
package/lib/TypingsGenerator.d.ts.map +1 -1
package/lib/TypingsGenerator.js +29 -30
package/lib/TypingsGenerator.js.map +1 -1
package/package.json +3 -3

package/CHANGELOG.json CHANGED Viewed

@@ -1,6 +1,26 @@
 {
   "name": "@rushstack/typings-generator",
   "entries": [
+    {
+      "version": "0.5.0",
+      "tag": "@rushstack/typings-generator_v0.5.0",
+      "date": "Mon, 29 Nov 2021 07:26:16 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "(BREAKING CHANGE) Remove \"filesToIgnore\" option in favor of \"globsToIgnore.\""
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.42.3`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft-node-rig\" to `1.2.31`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.4.6",
       "tag": "@rushstack/typings-generator_v0.4.6",

package/CHANGELOG.md CHANGED Viewed

@@ -1,6 +1,13 @@
 # Change Log - @rushstack/typings-generator
-This log was last generated on Sat, 06 Nov 2021 00:09:13 GMT and should not be manually modified.
+This log was last generated on Mon, 29 Nov 2021 07:26:16 GMT and should not be manually modified.
+## 0.5.0
+Mon, 29 Nov 2021 07:26:16 GMT
+### Minor changes
+- (BREAKING CHANGE) Remove "filesToIgnore" option in favor of "globsToIgnore."
 ## 0.4.6
 Sat, 06 Nov 2021 00:09:13 GMT

package/README.md CHANGED Viewed

@@ -61,10 +61,10 @@ return TypeScript declarations for the file it is called with.
 Optionally provide a [Terminal](https://github.com/microsoft/rushstack/blob/master/libraries/node-core-library/src/Terminal/Terminal.ts)
 object for logging. If one isn't provided, logs will go to the console.
-### `filesToIgnore`
+### `globsToIgnore`
-Optionally, provide an array of paths to files that should be ignored. These paths can either be absolute
-paths, or paths relative to the [`srcFolder`](#srcFolder--)
+Optionally, provide an array of globs matching files that should be ignored. These globs are evaluated
+under [`srcFolder`](#srcFolder--)
 ## `StringValuesTypingsGenerator`
@@ -125,8 +125,7 @@ is set to `IExportStyles`. If not specified, the interface name will be `IExport
 ## Links
-- [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/master/libraries/typings-generator/CHANGELOG.md) - Find
+- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/master/libraries/typings-generator/CHANGELOG.md) - Find
   out what's new in the latest version
 - [API Reference](https://rushstack.io/pages/api/typings-generator/)

package/dist/tsdoc-metadata.json CHANGED Viewed

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.18.15"
+      "packageVersion": "7.18.19"
     }
   ]
 }

package/dist/typings-generator.d.ts CHANGED Viewed

@@ -39,6 +39,12 @@ export declare interface ITypingsGeneratorOptions<TTypingsResult = string | unde
     fileExtensions: string[];
     parseAndGenerateTypings: (fileContents: string, filePath: string) => TTypingsResult | Promise<TTypingsResult>;
     terminal?: ITerminal;
+    globsToIgnore?: string[];
+    /**
+     * @deprecated
+     *
+     * TODO: Remove when version 1.0.0 is released.
+     */
     filesToIgnore?: string[];
 }
@@ -61,7 +67,6 @@ export declare class TypingsGenerator {
     private _targetMap;
     private _dependencyMap;
     protected _options: ITypingsGeneratorOptions;
-    private _filesToIgnoreVal;
     constructor(options: ITypingsGeneratorOptions);
     generateTypingsAsync(): Promise<void>;
     runWatcherAsync(): Promise<void>;
@@ -73,7 +78,6 @@ export declare class TypingsGenerator {
      */
     registerDependency(target: string, dependency: string): void;
     private _parseFileAndGenerateTypingsAsync;
-    private get _filesToIgnore();
     private _clearDependencies;
     private _getDependencyTargets;
     private _getTypingsFilePath;

package/lib/TypingsGenerator.d.ts CHANGED Viewed

@@ -8,6 +8,12 @@ export interface ITypingsGeneratorOptions<TTypingsResult = string | undefined> {
     fileExtensions: string[];
     parseAndGenerateTypings: (fileContents: string, filePath: string) => TTypingsResult | Promise<TTypingsResult>;
     terminal?: ITerminal;
+    globsToIgnore?: string[];
+    /**
+     * @deprecated
+     *
+     * TODO: Remove when version 1.0.0 is released.
+     */
     filesToIgnore?: string[];
 }
 /**
@@ -19,7 +25,6 @@ export declare class TypingsGenerator {
     private _targetMap;
     private _dependencyMap;
     protected _options: ITypingsGeneratorOptions;
-    private _filesToIgnoreVal;
     constructor(options: ITypingsGeneratorOptions);
     generateTypingsAsync(): Promise<void>;
     runWatcherAsync(): Promise<void>;
@@ -31,7 +36,6 @@ export declare class TypingsGenerator {
      */
     registerDependency(target: string, dependency: string): void;
     private _parseFileAndGenerateTypingsAsync;
-    private get _filesToIgnore();
     private _clearDependencies;
     private _getDependencyTargets;
     private _getTypingsFilePath;

package/lib/TypingsGenerator.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TypingsGenerator.d.ts","sourceRoot":"","sources":["../src/TypingsGenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,SAAS,~~EAKV~~,MAAM,8BAA8B,CAAC;AAMtC;;GAEG;AACH,MAAM,WAAW,wBAAwB,CAAC,cAAc,GAAG,MAAM,GAAG,SAAS;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,uBAAuB,EAAE,CACvB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,KACb,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,UAAU,CAA2B;IAG7C,OAAO,CAAC,cAAc,CAA2B;IAEjD,SAAS,CAAC,QAAQ,EAAE,wBAAwB,CAAC;~~IAE7C~~,OAAO,~~CAAC,iBAAiB,CAA0B;gBAEhC,OAAO,~~EAAE,wBAAwB;~~IAwCvC~~,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;~~IAgBrC~~,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;~~IAqB7C~~;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;YAgBrD,iCAAiC;~~IA0C~~/C,OAAO,~~KAAK,cAAc,GASzB;IAED,OAAO,~~CAAC,kBAAkB;IAU1B,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,mBAAmB;~~IAO3B~~,OAAO,CAAC,wBAAwB;CAYjC"}
1	+ {"version":3,"file":"TypingsGenerator.d.ts","sourceRoot":"","sources":["../src/TypingsGenerator.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,SAAS,EAOV,MAAM,8BAA8B,CAAC;AAMtC;;GAEG;AACH,MAAM,WAAW,wBAAwB,CAAC,cAAc,GAAG,MAAM,GAAG,SAAS;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,uBAAuB,EAAE,CACvB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,KACb,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,UAAU,CAA2B;IAG7C,OAAO,CAAC,cAAc,CAA2B;IAEjD,SAAS,CAAC,QAAQ,EAAE,wBAAwB,CAAC;gBAE1B,OAAO,EAAE,wBAAwB;IA4CvC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBrC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB7C;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;YAgBrD,iCAAiC;IAuC/C,OAAO,CAAC,kBAAkB;IAU1B,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,wBAAwB;CAYjC"}

package/lib/TypingsGenerator.js CHANGED Viewed

@@ -20,10 +20,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypingsGenerator = void 0;
 const node_core_library_1 = require("@rushstack/node-core-library");
-const glob = __importStar(require("glob"));
+const glob_1 = __importDefault(require("glob"));
 const path = __importStar(require("path"));
 const os_1 = require("os");
 const chokidar = __importStar(require("chokidar"));
@@ -35,6 +38,9 @@ const chokidar = __importStar(require("chokidar"));
 class TypingsGenerator {
     constructor(options) {
         this._options = Object.assign({}, options);
+        if (options.filesToIgnore) {
+            throw new Error('The filesToIgnore option is no longer supported. Please use globsToIgnore instead.');
+        }
         if (!this._options.generatedTsFolder) {
             throw new Error('generatedTsFolder must be provided');
         }
@@ -50,8 +56,8 @@ class TypingsGenerator {
         if (!this._options.fileExtensions || this._options.fileExtensions.length === 0) {
             throw new Error('At least one file extension must be provided.');
         }
-        if (!this._options.filesToIgnore) {
-            this._options.filesToIgnore = [];
+        if (!this._options.globsToIgnore) {
+            this._options.globsToIgnore = [];
         }
         if (!this._options.terminal) {
             this._options.terminal = new node_core_library_1.Terminal(new node_core_library_1.ConsoleTerminalProvider({ verboseEnabled: true }));
@@ -62,22 +68,25 @@ class TypingsGenerator {
     }
     async generateTypingsAsync() {
         await node_core_library_1.FileSystem.ensureEmptyFolderAsync(this._options.generatedTsFolder);
-        const filePaths = glob.sync(path.join('**', `*+(${this._options.fileExtensions.join('|')})`), {
+        const filePaths = await node_core_library_1.LegacyAdapters.convertCallbackToPromise(glob_1.default, `**/*+(${this._options.fileExtensions.join('|')})`, {
             cwd: this._options.srcFolder,
             absolute: true,
             nosort: true,
-            nodir: true
+            nodir: true,
+            ignore: this._options.globsToIgnore
         });
-        for (let filePath of filePaths) {
-            filePath = path.resolve(this._options.srcFolder, filePath);
+        await node_core_library_1.Async.forEachAsync(filePaths, async (filePath) => {
+            filePath = `${this._options.srcFolder}/${filePath}`;
             await this._parseFileAndGenerateTypingsAsync(filePath);
-        }
+        }, { concurrency: 50 });
     }
     async runWatcherAsync() {
         await node_core_library_1.FileSystem.ensureFolderAsync(this._options.generatedTsFolder);
-        const globBase = path.resolve(this._options.srcFolder, '**');
+        const globBase = `${this._options.srcFolder}/**`;
         await new Promise((resolve, reject) => {
-            const watcher = chokidar.watch(this._options.fileExtensions.map((fileExtension) => path.join(globBase, `*${fileExtension}`)));
+            const watcher = chokidar.watch(this._options.fileExtensions.map((fileExtension) => `${globBase}/*${fileExtension}`), {
+                ignored: this._options.globsToIgnore
+            });
             const boundGenerateTypingsFunction = this._parseFileAndGenerateTypingsAsync.bind(this);
             watcher.on('add', boundGenerateTypingsFunction);
             watcher.on('change', boundGenerateTypingsFunction);
@@ -108,20 +117,17 @@ class TypingsGenerator {
         }
         dependencyTargetSet.add(target);
     }
-    async _parseFileAndGenerateTypingsAsync(locFilePath) {
-        if (this._filesToIgnore.has(locFilePath)) {
-            return;
-        }
+    async _parseFileAndGenerateTypingsAsync(filePath) {
         // Clear registered dependencies prior to reprocessing.
-        this._clearDependencies(locFilePath);
+        this._clearDependencies(filePath);
         // Check for targets that register this file as a dependency, and reprocess them too.
-        for (const target of this._getDependencyTargets(locFilePath)) {
+        for (const target of this._getDependencyTargets(filePath)) {
             await this._parseFileAndGenerateTypingsAsync(target);
         }
         try {
-            const fileContents = await node_core_library_1.FileSystem.readFileAsync(locFilePath);
-            const typingsData = await this._options.parseAndGenerateTypings(fileContents, locFilePath);
-            const generatedTsFilePath = this._getTypingsFilePath(locFilePath);
+            const fileContents = await node_core_library_1.FileSystem.readFileAsync(filePath);
+            const typingsData = await this._options.parseAndGenerateTypings(fileContents, filePath);
+            const generatedTsFilePath = this._getTypingsFilePath(filePath);
             // Typings data will be undefined when no types should be generated for the parsed file.
             if (typingsData === undefined) {
                 return;
@@ -137,16 +143,8 @@ class TypingsGenerator {
             });
         }
         catch (e) {
-            this._options.terminal.writeError(`Error occurred parsing and generating typings for file "${locFilePath}": ${e}`);
-        }
-    }
-    get _filesToIgnore() {
-        if (!this._filesToIgnoreVal) {
-            this._filesToIgnoreVal = new Set(this._options.filesToIgnore.map((fileToIgnore) => {
-                return path.resolve(this._options.srcFolder, fileToIgnore);
-            }));
+            this._options.terminal.writeError(`Error occurred parsing and generating typings for file "${filePath}": ${e}`);
         }
-        return this._filesToIgnoreVal;
     }
     _clearDependencies(target) {
         const targetDependencySet = this._targetMap.get(target);
@@ -161,8 +159,9 @@ class TypingsGenerator {
         var _a;
         return [...(((_a = this._dependencyMap.get(dependency)) === null || _a === void 0 ? void 0 : _a.keys()) || [])];
     }
-    _getTypingsFilePath(locFilePath) {
-        return path.resolve(this._options.generatedTsFolder, path.relative(this._options.srcFolder, `${locFilePath}.d.ts`));
+    _getTypingsFilePath(filePath) {
+        const relativeSourceFilePath = path.relative(this._options.srcFolder, `${filePath}.d.ts`);
+        return `${this._options.generatedTsFolder}/${relativeSourceFilePath}`;
     }
     _normalizeFileExtensions(fileExtensions) {
         const result = [];

package/lib/TypingsGenerator.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"TypingsGenerator.js","sourceRoot":"","sources":["../src/TypingsGenerator.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,oEAOsC;AACtC,2CAA6B;AAC7B,2CAA6B;AAC7B,2BAAyB;AACzB,mDAAqC;AAiBrC;;;;GAIG;AACH,MAAa,gBAAgB;IAW3B,YAAmB,OAAiC;QAClD,IAAI,CAAC,QAAQ,qBACR,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,IAAI,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YAC1E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC1E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,EAAE,CAAC;SAClC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,4BAAQ,CAAC,IAAI,2CAAuB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SAC9F;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAE3F,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,8BAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEzE,MAAM,SAAS,GAAa,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACtG,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAC5B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QAEH,KAAK,IAAI,QAAQ,IAAI,SAAS,EAAE;YAC9B,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;SACxD;IACH,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,8BAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEpE,MAAM,QAAQ,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAErE,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC1C,MAAM,OAAO,GAAuB,QAAQ,CAAC,KAAK,CAChD,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC,CAC9F,CAAC;YACF,MAAM,4BAA4B,GAChC,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAC;YAChD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;YACnD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACtC,MAAM,mBAAmB,GAAW,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBACvE,MAAM,8BAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,MAAc,EAAE,UAAkB;QAC1D,IAAI,mBAAmB,GAA4B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/E,IAAI,CAAC,mBAAmB,EAAE;YACxB,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;SAClD;QACD,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEpC,IAAI,mBAAmB,GAA4B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,EAAE;YACxB,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;SAC1D;QACD,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,WAAmB;QACjE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;YACxC,OAAO;SACR;QACD,uDAAuD;QACvD,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAErC,qFAAqF;QACrF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,EAAE;YAC5D,MAAM,IAAI,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;SACtD;QAED,IAAI;YACF,MAAM,YAAY,GAAW,MAAM,8BAAU,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACzE,MAAM,WAAW,GAAuB,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACjF,YAAY,EACZ,WAAW,CACZ,CAAC;YACF,MAAM,mBAAmB,GAAW,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAE1E,wFAAwF;YACxF,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,OAAO;aACR;YAED,MAAM,mBAAmB,GAAW;gBAClC,qFAAqF;gBACrF,EAAE;gBACF,WAAW;aACZ,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC;YAEZ,MAAM,8BAAU,CAAC,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,EAAE;gBACxE,kBAAkB,EAAE,IAAI;gBACxB,kBAAkB,sBAAuB;aAC1C,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,QAAQ,CAAC,QAAS,CAAC,UAAU,CAChC,2DAA2D,WAAW,MAAM,CAAC,EAAE,CAChF,CAAC;SACH;IACH,CAAC;IAED,IAAY,cAAc;QACxB,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAC9B,IAAI,CAAC,QAAQ,CAAC,aAAc,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;gBAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YAC7D,CAAC,CAAC,CACH,CAAC;SACH;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAEO,kBAAkB,CAAC,MAAc;QACvC,MAAM,mBAAmB,GAA4B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjF,IAAI,mBAAmB,EAAE;YACvB,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE;gBAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;aACrD;YACD,mBAAmB,CAAC,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;IAEO,qBAAqB,CAAC,UAAkB;;QAC9C,OAAO,CAAC,GAAG,CAAC,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,IAAI,EAAE,KAAI,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IAEO,mBAAmB,CAAC,WAAmB;QAC7C,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,WAAW,OAAO,CAAC,CAC9D,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAAC,cAAwB;QACvD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;YAC1C,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;aAClC;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC5B;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AApMD,4CAoMC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport {\r\n FileSystem,\r\n ITerminal,\r\n Terminal,\r\n ConsoleTerminalProvider,\r\n Path,\r\n NewlineKind\r\n} from '@rushstack/node-core-library';\r\nimport * as glob from 'glob';\r\nimport * as path from 'path';\r\nimport { EOL } from 'os';\r\nimport * as chokidar from 'chokidar';\r\n\r\n/*\r\n @public\r\n /\r\nexport interface ITypingsGeneratorOptions<TTypingsResult = string \| undefined> {\r\n srcFolder: string;\r\n generatedTsFolder: string;\r\n fileExtensions: string[];\r\n parseAndGenerateTypings: (\r\n fileContents: string,\r\n filePath: string\r\n ) => TTypingsResult \| Promise<TTypingsResult>;\r\n terminal?: ITerminal;\r\n filesToIgnore?: string[];\r\n}\r\n\r\n/\r\n This is a simple tool that generates .d.ts files for non-TS files.\r\n \r\n @public\r\n /\r\nexport class TypingsGenerator {\r\n // Map of target file path -> Set<dependency file path>\r\n private _targetMap: Map<string, Set<string>>;\r\n\r\n // Map of dependency file path -> Set<target file path>\r\n private _dependencyMap: Map<string, Set<string>>;\r\n\r\n protected _options: ITypingsGeneratorOptions;\r\n\r\n private _filesToIgnoreVal: Set<string> \| undefined;\r\n\r\n public constructor(options: ITypingsGeneratorOptions) {\r\n this._options = {\r\n ...options\r\n };\r\n\r\n if (!this._options.generatedTsFolder) {\r\n throw new Error('generatedTsFolder must be provided');\r\n }\r\n\r\n if (!this._options.srcFolder) {\r\n throw new Error('srcFolder must be provided');\r\n }\r\n\r\n if (Path.isUnder(this._options.srcFolder, this._options.generatedTsFolder)) {\r\n throw new Error('srcFolder must not be under generatedTsFolder');\r\n }\r\n\r\n if (Path.isUnder(this._options.generatedTsFolder, this._options.srcFolder)) {\r\n throw new Error('generatedTsFolder must not be under srcFolder');\r\n }\r\n\r\n if (!this._options.fileExtensions \|\| this._options.fileExtensions.length === 0) {\r\n throw new Error('At least one file extension must be provided.');\r\n }\r\n\r\n if (!this._options.filesToIgnore) {\r\n this._options.filesToIgnore = [];\r\n }\r\n\r\n if (!this._options.terminal) {\r\n this._options.terminal = new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));\r\n }\r\n\r\n this._options.fileExtensions = this._normalizeFileExtensions(this._options.fileExtensions);\r\n\r\n this._targetMap = new Map();\r\n\r\n this._dependencyMap = new Map();\r\n }\r\n\r\n public async generateTypingsAsync(): Promise<void> {\r\n await FileSystem.ensureEmptyFolderAsync(this._options.generatedTsFolder);\r\n\r\n const filePaths: string[] = glob.sync(path.join('', `+(${this._options.fileExtensions.join('\|')})`), {\r\n cwd: this._options.srcFolder,\r\n absolute: true,\r\n nosort: true,\r\n nodir: true\r\n });\r\n\r\n for (let filePath of filePaths) {\r\n filePath = path.resolve(this._options.srcFolder, filePath);\r\n await this._parseFileAndGenerateTypingsAsync(filePath);\r\n }\r\n }\r\n\r\n public async runWatcherAsync(): Promise<void> {\r\n await FileSystem.ensureFolderAsync(this._options.generatedTsFolder);\r\n\r\n const globBase: string = path.resolve(this._options.srcFolder, '*');\r\n\r\n await new Promise((resolve, reject): void => {\r\n const watcher: chokidar.FSWatcher = chokidar.watch(\r\n this._options.fileExtensions.map((fileExtension) => path.join(globBase, `${fileExtension}`))\r\n );\r\n const boundGenerateTypingsFunction: (filePath: string) => Promise<void> =\r\n this._parseFileAndGenerateTypingsAsync.bind(this);\r\n watcher.on('add', boundGenerateTypingsFunction);\r\n watcher.on('change', boundGenerateTypingsFunction);\r\n watcher.on('unlink', async (filePath) => {\r\n const generatedTsFilePath: string = this._getTypingsFilePath(filePath);\r\n await FileSystem.deleteFileAsync(generatedTsFilePath);\r\n });\r\n watcher.on('error', reject);\r\n });\r\n }\r\n\r\n /*\r\n Register file dependencies that may effect the typings of a target file.\r\n * Note: This feature is only useful in watch mode.\r\n * The registerDependency method must be called in the body of parseAndGenerateTypings every\r\n * time because the registry for a file is cleared at the beginning of processing.\r\n */\r\n public registerDependency(target: string, dependency: string): void {\r\n let targetDependencySet: Set<string> \| undefined = this._targetMap.get(target);\r\n if (!targetDependencySet) {\r\n targetDependencySet = new Set();\r\n this._targetMap.set(target, targetDependencySet);\r\n }\r\n targetDependencySet.add(dependency);\r\n\r\n let dependencyTargetSet: Set<string> \| undefined = this._dependencyMap.get(dependency);\r\n if (!dependencyTargetSet) {\r\n dependencyTargetSet = new Set();\r\n this._dependencyMap.set(dependency, dependencyTargetSet);\r\n }\r\n dependencyTargetSet.add(target);\r\n }\r\n\r\n private async _parseFileAndGenerateTypingsAsync(locFilePath: string): Promise<void> {\r\n if (this._filesToIgnore.has(locFilePath)) {\r\n return;\r\n }\r\n // Clear registered dependencies prior to reprocessing.\r\n this._clearDependencies(locFilePath);\r\n\r\n // Check for targets that register this file as a dependency, and reprocess them too.\r\n for (const target of this._getDependencyTargets(locFilePath)) {\r\n await this._parseFileAndGenerateTypingsAsync(target);\r\n }\r\n\r\n try {\r\n const fileContents: string = await FileSystem.readFileAsync(locFilePath);\r\n const typingsData: string \| undefined = await this._options.parseAndGenerateTypings(\r\n fileContents,\r\n locFilePath\r\n );\r\n const generatedTsFilePath: string = this._getTypingsFilePath(locFilePath);\r\n\r\n // Typings data will be undefined when no types should be generated for the parsed file.\r\n if (typingsData === undefined) {\r\n return;\r\n }\r\n\r\n const prefixedTypingsData: string = [\r\n '// This file was generated by a tool. Modifying it will produce unexpected behavior',\r\n '',\r\n typingsData\r\n ].join(EOL);\r\n\r\n await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {\r\n ensureFolderExists: true,\r\n convertLineEndings: NewlineKind.OsDefault\r\n });\r\n } catch (e) {\r\n this._options.terminal!.writeError(\r\n `Error occurred parsing and generating typings for file \"${locFilePath}\": ${e}`\r\n );\r\n }\r\n }\r\n\r\n private get _filesToIgnore(): Set<string> {\r\n if (!this._filesToIgnoreVal) {\r\n this._filesToIgnoreVal = new Set<string>(\r\n this._options.filesToIgnore!.map((fileToIgnore) => {\r\n return path.resolve(this._options.srcFolder, fileToIgnore);\r\n })\r\n );\r\n }\r\n return this._filesToIgnoreVal;\r\n }\r\n\r\n private _clearDependencies(target: string): void {\r\n const targetDependencySet: Set<string> \| undefined = this._targetMap.get(target);\r\n if (targetDependencySet) {\r\n for (const dependency of targetDependencySet) {\r\n this._dependencyMap.get(dependency)!.delete(target);\r\n }\r\n targetDependencySet.clear();\r\n }\r\n }\r\n\r\n private _getDependencyTargets(dependency: string): string[] {\r\n return [...(this._dependencyMap.get(dependency)?.keys() \|\| [])];\r\n }\r\n\r\n private _getTypingsFilePath(locFilePath: string): string {\r\n return path.resolve(\r\n this._options.generatedTsFolder,\r\n path.relative(this._options.srcFolder, `${locFilePath}.d.ts`)\r\n );\r\n }\r\n\r\n private _normalizeFileExtensions(fileExtensions: string[]): string[] {\r\n const result: string[] = [];\r\n for (const fileExtension of fileExtensions) {\r\n if (!fileExtension.startsWith('.')) {\r\n result.push(`.${fileExtension}`);\r\n } else {\r\n result.push(fileExtension);\r\n }\r\n }\r\n\r\n return result;\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"TypingsGenerator.js","sourceRoot":"","sources":["../src/TypingsGenerator.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,oEASsC;AACtC,gDAAwB;AACxB,2CAA6B;AAC7B,2BAAyB;AACzB,mDAAqC;AAuBrC;;;;GAIG;AACH,MAAa,gBAAgB;IAS3B,YAAmB,OAAiC;QAClD,IAAI,CAAC,QAAQ,qBACR,OAAO,CACX,CAAC;QAEF,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;SACvG;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QAED,IAAI,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YAC1E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,wBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC1E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9E,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;YAChC,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,EAAE,CAAC;SAClC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,IAAI,4BAAQ,CAAC,IAAI,2CAAuB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SAC9F;QAED,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAE3F,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,8BAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEzE,MAAM,SAAS,GAAa,MAAM,kCAAc,CAAC,wBAAwB,CACvE,cAAI,EACJ,SAAS,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAClD;YACE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAC5B,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;SACpC,CACF,CAAC;QAEF,MAAM,yBAAK,CAAC,YAAY,CACtB,SAAS,EACT,KAAK,EAAE,QAAgB,EAAE,EAAE;YACzB,QAAQ,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;YACpD,MAAM,IAAI,CAAC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QACzD,CAAC,EACD,EAAE,WAAW,EAAE,EAAE,EAAE,CACpB,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,8BAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEpE,MAAM,QAAQ,GAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,CAAC;QAEzD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC1C,MAAM,OAAO,GAAuB,QAAQ,CAAC,KAAK,CAChD,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,QAAQ,KAAK,aAAa,EAAE,CAAC,EACpF;gBACE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;aACrC,CACF,CAAC;YACF,MAAM,4BAA4B,GAChC,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAC;YAChD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;YACnD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACtC,MAAM,mBAAmB,GAAW,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBACvE,MAAM,8BAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,MAAc,EAAE,UAAkB;QAC1D,IAAI,mBAAmB,GAA4B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/E,IAAI,CAAC,mBAAmB,EAAE;YACxB,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;SAClD;QACD,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEpC,IAAI,mBAAmB,GAA4B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,EAAE;YACxB,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;YAChC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;SAC1D;QACD,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,QAAgB;QAC9D,uDAAuD;QACvD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QAElC,qFAAqF;QACrF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE;YACzD,MAAM,IAAI,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;SACtD;QAED,IAAI;YACF,MAAM,YAAY,GAAW,MAAM,8BAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACtE,MAAM,WAAW,GAAuB,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACjF,YAAY,EACZ,QAAQ,CACT,CAAC;YACF,MAAM,mBAAmB,GAAW,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAEvE,wFAAwF;YACxF,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,OAAO;aACR;YAED,MAAM,mBAAmB,GAAW;gBAClC,qFAAqF;gBACrF,EAAE;gBACF,WAAW;aACZ,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC;YAEZ,MAAM,8BAAU,CAAC,cAAc,CAAC,mBAAmB,EAAE,mBAAmB,EAAE;gBACxE,kBAAkB,EAAE,IAAI;gBACxB,kBAAkB,sBAAuB;aAC1C,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,QAAQ,CAAC,QAAS,CAAC,UAAU,CAChC,2DAA2D,QAAQ,MAAM,CAAC,EAAE,CAC7E,CAAC;SACH;IACH,CAAC;IAEO,kBAAkB,CAAC,MAAc;QACvC,MAAM,mBAAmB,GAA4B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjF,IAAI,mBAAmB,EAAE;YACvB,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE;gBAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;aACrD;YACD,mBAAmB,CAAC,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;IAEO,qBAAqB,CAAC,UAAkB;;QAC9C,OAAO,CAAC,GAAG,CAAC,CAAA,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,IAAI,EAAE,KAAI,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IAEO,mBAAmB,CAAC,QAAgB;QAC1C,MAAM,sBAAsB,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC;QAClG,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,IAAI,sBAAsB,EAAE,CAAC;IACxE,CAAC;IAEO,wBAAwB,CAAC,cAAwB;QACvD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;YAC1C,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;aAClC;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC5B;SACF;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAlMD,4CAkMC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport {\r\n FileSystem,\r\n ITerminal,\r\n Terminal,\r\n ConsoleTerminalProvider,\r\n Path,\r\n NewlineKind,\r\n LegacyAdapters,\r\n Async\r\n} from '@rushstack/node-core-library';\r\nimport glob from 'glob';\r\nimport * as path from 'path';\r\nimport { EOL } from 'os';\r\nimport * as chokidar from 'chokidar';\r\n\r\n/*\r\n @public\r\n /\r\nexport interface ITypingsGeneratorOptions<TTypingsResult = string \| undefined> {\r\n srcFolder: string;\r\n generatedTsFolder: string;\r\n fileExtensions: string[];\r\n parseAndGenerateTypings: (\r\n fileContents: string,\r\n filePath: string\r\n ) => TTypingsResult \| Promise<TTypingsResult>;\r\n terminal?: ITerminal;\r\n globsToIgnore?: string[];\r\n /\r\n @deprecated\r\n \r\n TODO: Remove when version 1.0.0 is released.\r\n /\r\n filesToIgnore?: string[];\r\n}\r\n\r\n/\r\n This is a simple tool that generates .d.ts files for non-TS files.\r\n \r\n @public\r\n /\r\nexport class TypingsGenerator {\r\n // Map of target file path -> Set<dependency file path>\r\n private _targetMap: Map<string, Set<string>>;\r\n\r\n // Map of dependency file path -> Set<target file path>\r\n private _dependencyMap: Map<string, Set<string>>;\r\n\r\n protected _options: ITypingsGeneratorOptions;\r\n\r\n public constructor(options: ITypingsGeneratorOptions) {\r\n this._options = {\r\n ...options\r\n };\r\n\r\n if (options.filesToIgnore) {\r\n throw new Error('The filesToIgnore option is no longer supported. Please use globsToIgnore instead.');\r\n }\r\n\r\n if (!this._options.generatedTsFolder) {\r\n throw new Error('generatedTsFolder must be provided');\r\n }\r\n\r\n if (!this._options.srcFolder) {\r\n throw new Error('srcFolder must be provided');\r\n }\r\n\r\n if (Path.isUnder(this._options.srcFolder, this._options.generatedTsFolder)) {\r\n throw new Error('srcFolder must not be under generatedTsFolder');\r\n }\r\n\r\n if (Path.isUnder(this._options.generatedTsFolder, this._options.srcFolder)) {\r\n throw new Error('generatedTsFolder must not be under srcFolder');\r\n }\r\n\r\n if (!this._options.fileExtensions \|\| this._options.fileExtensions.length === 0) {\r\n throw new Error('At least one file extension must be provided.');\r\n }\r\n\r\n if (!this._options.globsToIgnore) {\r\n this._options.globsToIgnore = [];\r\n }\r\n\r\n if (!this._options.terminal) {\r\n this._options.terminal = new Terminal(new ConsoleTerminalProvider({ verboseEnabled: true }));\r\n }\r\n\r\n this._options.fileExtensions = this._normalizeFileExtensions(this._options.fileExtensions);\r\n\r\n this._targetMap = new Map();\r\n\r\n this._dependencyMap = new Map();\r\n }\r\n\r\n public async generateTypingsAsync(): Promise<void> {\r\n await FileSystem.ensureEmptyFolderAsync(this._options.generatedTsFolder);\r\n\r\n const filePaths: string[] = await LegacyAdapters.convertCallbackToPromise(\r\n glob,\r\n `/+(${this._options.fileExtensions.join('\|')})`,\r\n {\r\n cwd: this._options.srcFolder,\r\n absolute: true,\r\n nosort: true,\r\n nodir: true,\r\n ignore: this._options.globsToIgnore\r\n }\r\n );\r\n\r\n await Async.forEachAsync(\r\n filePaths,\r\n async (filePath: string) => {\r\n filePath = `${this._options.srcFolder}/${filePath}`;\r\n await this._parseFileAndGenerateTypingsAsync(filePath);\r\n },\r\n { concurrency: 50 }\r\n );\r\n }\r\n\r\n public async runWatcherAsync(): Promise<void> {\r\n await FileSystem.ensureFolderAsync(this._options.generatedTsFolder);\r\n\r\n const globBase: string = `${this._options.srcFolder}/*`;\r\n\r\n await new Promise((resolve, reject): void => {\r\n const watcher: chokidar.FSWatcher = chokidar.watch(\r\n this._options.fileExtensions.map((fileExtension) => `${globBase}/${fileExtension}`),\r\n {\r\n ignored: this._options.globsToIgnore\r\n }\r\n );\r\n const boundGenerateTypingsFunction: (filePath: string) => Promise<void> =\r\n this._parseFileAndGenerateTypingsAsync.bind(this);\r\n watcher.on('add', boundGenerateTypingsFunction);\r\n watcher.on('change', boundGenerateTypingsFunction);\r\n watcher.on('unlink', async (filePath) => {\r\n const generatedTsFilePath: string = this._getTypingsFilePath(filePath);\r\n await FileSystem.deleteFileAsync(generatedTsFilePath);\r\n });\r\n watcher.on('error', reject);\r\n });\r\n }\r\n\r\n /*\r\n Register file dependencies that may effect the typings of a target file.\r\n * Note: This feature is only useful in watch mode.\r\n * The registerDependency method must be called in the body of parseAndGenerateTypings every\r\n * time because the registry for a file is cleared at the beginning of processing.\r\n */\r\n public registerDependency(target: string, dependency: string): void {\r\n let targetDependencySet: Set<string> \| undefined = this._targetMap.get(target);\r\n if (!targetDependencySet) {\r\n targetDependencySet = new Set();\r\n this._targetMap.set(target, targetDependencySet);\r\n }\r\n targetDependencySet.add(dependency);\r\n\r\n let dependencyTargetSet: Set<string> \| undefined = this._dependencyMap.get(dependency);\r\n if (!dependencyTargetSet) {\r\n dependencyTargetSet = new Set();\r\n this._dependencyMap.set(dependency, dependencyTargetSet);\r\n }\r\n dependencyTargetSet.add(target);\r\n }\r\n\r\n private async _parseFileAndGenerateTypingsAsync(filePath: string): Promise<void> {\r\n // Clear registered dependencies prior to reprocessing.\r\n this._clearDependencies(filePath);\r\n\r\n // Check for targets that register this file as a dependency, and reprocess them too.\r\n for (const target of this._getDependencyTargets(filePath)) {\r\n await this._parseFileAndGenerateTypingsAsync(target);\r\n }\r\n\r\n try {\r\n const fileContents: string = await FileSystem.readFileAsync(filePath);\r\n const typingsData: string \| undefined = await this._options.parseAndGenerateTypings(\r\n fileContents,\r\n filePath\r\n );\r\n const generatedTsFilePath: string = this._getTypingsFilePath(filePath);\r\n\r\n // Typings data will be undefined when no types should be generated for the parsed file.\r\n if (typingsData === undefined) {\r\n return;\r\n }\r\n\r\n const prefixedTypingsData: string = [\r\n '// This file was generated by a tool. Modifying it will produce unexpected behavior',\r\n '',\r\n typingsData\r\n ].join(EOL);\r\n\r\n await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {\r\n ensureFolderExists: true,\r\n convertLineEndings: NewlineKind.OsDefault\r\n });\r\n } catch (e) {\r\n this._options.terminal!.writeError(\r\n `Error occurred parsing and generating typings for file \"${filePath}\": ${e}`\r\n );\r\n }\r\n }\r\n\r\n private _clearDependencies(target: string): void {\r\n const targetDependencySet: Set<string> \| undefined = this._targetMap.get(target);\r\n if (targetDependencySet) {\r\n for (const dependency of targetDependencySet) {\r\n this._dependencyMap.get(dependency)!.delete(target);\r\n }\r\n targetDependencySet.clear();\r\n }\r\n }\r\n\r\n private _getDependencyTargets(dependency: string): string[] {\r\n return [...(this._dependencyMap.get(dependency)?.keys() \|\| [])];\r\n }\r\n\r\n private _getTypingsFilePath(filePath: string): string {\r\n const relativeSourceFilePath: string = path.relative(this._options.srcFolder, `${filePath}.d.ts`);\r\n return `${this._options.generatedTsFolder}/${relativeSourceFilePath}`;\r\n }\r\n\r\n private _normalizeFileExtensions(fileExtensions: string[]): string[] {\r\n const result: string[] = [];\r\n for (const fileExtension of fileExtensions) {\r\n if (!fileExtension.startsWith('.')) {\r\n result.push(`.${fileExtension}`);\r\n } else {\r\n result.push(fileExtension);\r\n }\r\n }\r\n\r\n return result;\r\n }\r\n}\r\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@rushstack/typings-generator",
-	"version": "0.4.6",
+	"version": "0.5.0",
 	"description": "This library provides functionality for automatically generating typings for non-TS files.",
 	"keywords": [
 		"dts",
@@ -23,8 +23,8 @@
 	},
 	"devDependencies": {
 		"@rushstack/eslint-config": "2.4.5",
-		"@rushstack/heft": "0.41.6",
-		"@rushstack/heft-node-rig": "1.2.25",
+		"@rushstack/heft": "0.42.3",
+		"@rushstack/heft-node-rig": "1.2.31",
 		"@types/glob": "7.1.1"
 	},
 	"scripts": {