Merge pull request #3494 from iclanton/typings-generator-outputs

[typings-generator] Allow typings to be output to secondary folders.

Author: iclanton

build-tests/localization-plugin-test-03/webpack.config.js

@@ -117,6 +117,7 @@ function generateConfiguration(mode, outputFolderName) {
         },
         typingsOptions: {
           generatedTsFolder: path.resolve(__dirname, 'temp', 'loc-json-ts'),
+          secondaryGeneratedTsFolders: ['lib'],
           sourceRoot: path.resolve(__dirname, 'src'),
           exportAsDefault: true
         },

common/changes/@rushstack/heft-sass-plugin/typings-generator-outputs_2022-06-25-00-38.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-sass-plugin",
+      "comment": "Add an option to output typings to additional output folders.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-sass-plugin"
+}

common/changes/@rushstack/localization-utilities/typings-generator-outputs_2022-06-25-00-31.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/localization-utilities",
+      "comment": "Add an option to output typings to additional output folders.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/localization-utilities"
+}

common/changes/@rushstack/localization-utilities/typings-generator-outputs_2022-06-25-00-38.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/localization-utilities",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/localization-utilities"
+}

common/changes/@rushstack/typings-generator/typings-generator-outputs_2022-06-25-00-31.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/typings-generator",
+      "comment": "Add an option to output typings to additional output folders.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/typings-generator"
+}

common/changes/@rushstack/typings-generator/typings-generator-outputs_2022-06-25-00-38.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/typings-generator",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/typings-generator"
+}

common/changes/@rushstack/webpack4-localization-plugin/typings-generator-outputs_2022-06-25-00-44.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/webpack4-localization-plugin",
+      "comment": "Add an option to output typings to additional output folders.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/webpack4-localization-plugin"
+}

common/reviews/api/localization-utilities.api.md

@@ -5,6 +5,7 @@
 ```ts
 
 import { ITerminal } from '@rushstack/node-core-library';
+import { ITypingsGeneratorBaseOptions } from '@rushstack/typings-generator';
 import { NewlineKind } from '@rushstack/node-core-library';
 import { StringValuesTypingsGenerator } from '@rushstack/typings-generator';
 
@@ -76,25 +77,17 @@ export interface IPseudolocaleOptions {
 }
 
 // @public (undocumented)
-export interface ITypingsGeneratorOptions {
+export interface ITypingsGeneratorOptions extends ITypingsGeneratorBaseOptions {
     // (undocumented)
     exportAsDefault?: boolean;
     // (undocumented)
-    generatedTsFolder: string;
-    // (undocumented)
-    globsToIgnore?: string[];
-    // (undocumented)
     ignoreMissingResxComments?: boolean | undefined;
     // (undocumented)
     ignoreString?: IgnoreStringFunction;
     // (undocumented)
     processComment?: (comment: string | undefined, resxFilePath: string, stringName: string) => string | undefined;
     // (undocumented)
     resxNewlineNormalization?: NewlineKind | undefined;
-    // (undocumented)
-    srcFolder: string;
-    // (undocumented)
-    terminal?: ITerminal;
 }
 
 // @public (undocumented)

common/reviews/api/typings-generator.api.md

@@ -27,25 +27,31 @@ export interface IStringValueTypings {
 }
 
 // @public (undocumented)
-export interface ITypingsGeneratorOptions<TTypingsResult = string | undefined> {
-    // (undocumented)
-    fileExtensions: string[];
-    // @deprecated (undocumented)
-    filesToIgnore?: string[];
+export interface ITypingsGeneratorBaseOptions {
     // (undocumented)
     generatedTsFolder: string;
     // (undocumented)
-    getAdditionalOutputFiles?: (relativePath: string) => string[];
-    // (undocumented)
     globsToIgnore?: string[];
     // (undocumented)
-    parseAndGenerateTypings: (fileContents: string, filePath: string, relativePath: string) => TTypingsResult | Promise<TTypingsResult>;
+    secondaryGeneratedTsFolders?: string[];
     // (undocumented)
     srcFolder: string;
     // (undocumented)
     terminal?: ITerminal;
 }
 
+// @public (undocumented)
+export interface ITypingsGeneratorOptions<TTypingsResult = string | undefined> extends ITypingsGeneratorBaseOptions {
+    // (undocumented)
+    fileExtensions: string[];
+    // @deprecated (undocumented)
+    filesToIgnore?: string[];
+    // (undocumented)
+    getAdditionalOutputFiles?: (relativePath: string) => string[];
+    // (undocumented)
+    parseAndGenerateTypings: (fileContents: string, filePath: string, relativePath: string) => TTypingsResult | Promise<TTypingsResult>;
+}
+
 // @public
 export class StringValuesTypingsGenerator extends TypingsGenerator {
     constructor(options: IStringValuesTypingsGeneratorOptions);

common/reviews/api/webpack4-localization-plugin.api.md

@@ -134,6 +134,7 @@ export interface ITypingsGenerationOptions {
     // @deprecated (undocumented)
     ignoreString?: (resxFilePath: string, stringName: string) => boolean;
     processComment?: (comment: string | undefined, resxFilePath: string, stringName: string) => string | undefined;
+    secondaryGeneratedTsFolders?: string[];
     sourceRoot?: string;
 }
 

heft-plugins/heft-sass-plugin/src/SassTypingsGenerator.ts

@@ -24,6 +24,11 @@ export interface ISassConfiguration {
    */
   generatedTsFolder?: string;
 
+  /**
+   * Optional additional folders to which Sass typings should be output.
+   */
+  secondaryGeneratedTsFolders?: string[];
+
   /**
    * Output directories for compiled CSS
    */
@@ -103,6 +108,7 @@ export class SassTypingsGenerator extends StringValuesTypingsGenerator {
       exportAsDefaultInterfaceName,
       fileExtensions,
       filesToIgnore: sassConfiguration.excludeFiles,
+      secondaryGeneratedTsFolders: sassConfiguration.secondaryGeneratedTsFolders,
 
       getAdditionalOutputFiles: getCssPaths,
 

heft-plugins/heft-sass-plugin/src/SassTypingsPlugin.ts

@@ -11,6 +11,7 @@ import type {
 } from '@rushstack/heft';
 import { ConfigurationFile, PathResolutionMethod } from '@rushstack/heft-config-file';
 import { JsonSchema } from '@rushstack/node-core-library';
+
 import { ISassConfiguration, SassTypingsGenerator } from './SassTypingsGenerator';
 import { Async } from './utilities/Async';
 

heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json

@@ -27,6 +27,14 @@
       "description": "Output directory for generated Sass typings."
     },
 
+    "secondaryGeneratedTsFolders": {
+      "type": "array",
+      "description": "Optional additional folders to which Sass typings should be output.",
+      "items": {
+        "type": "string"
+      }
+    },
+
     "exportAsDefault": {
       "type": "boolean",
       "description": "Determines whether export values are wrapped in a default property, or not."

heft-plugins/heft-sass-plugin/src/schemas/templates/sass.json

@@ -24,6 +24,11 @@
    */
   // "generatedTsFolder": "temp/sass-ts/",
 
+  /**
+   * Optional additional folders to which Sass typings should be output.
+   */
+  // "secondaryGeneratedTsFolders": [],
+
   /**
    * Determines whether export values are wrapped in a default property, or not.
    *

libraries/localization-utilities/src/TypingsGenerator.ts

@@ -1,21 +1,21 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { StringValuesTypingsGenerator, IStringValueTyping } from '@rushstack/typings-generator';
-import { ITerminal, NewlineKind } from '@rushstack/node-core-library';
+import {
+  StringValuesTypingsGenerator,
+  IStringValueTyping,
+  ITypingsGeneratorBaseOptions
+} from '@rushstack/typings-generator';
+import { NewlineKind } from '@rushstack/node-core-library';
 
 import type { IgnoreStringFunction, ILocalizationFile } from './interfaces';
 import { parseLocFile } from './LocFileParser';
 
 /**
  * @public
  */
-export interface ITypingsGeneratorOptions {
-  srcFolder: string;
-  generatedTsFolder: string;
-  terminal?: ITerminal;
+export interface ITypingsGeneratorOptions extends ITypingsGeneratorBaseOptions {
   exportAsDefault?: boolean;
-  globsToIgnore?: string[];
   resxNewlineNormalization?: NewlineKind | undefined;
   ignoreMissingResxComments?: boolean | undefined;
   ignoreString?: IgnoreStringFunction;

libraries/typings-generator/src/TypingsGenerator.ts

@@ -19,18 +19,26 @@ import * as chokidar from 'chokidar';
 /**
  * @public
  */
-export interface ITypingsGeneratorOptions<TTypingsResult = string | undefined> {
+export interface ITypingsGeneratorBaseOptions {
   srcFolder: string;
   generatedTsFolder: string;
+  secondaryGeneratedTsFolders?: string[];
+  globsToIgnore?: string[];
+  terminal?: ITerminal;
+}
+
+/**
+ * @public
+ */
+export interface ITypingsGeneratorOptions<TTypingsResult = string | undefined>
+  extends ITypingsGeneratorBaseOptions {
   fileExtensions: string[];
   parseAndGenerateTypings: (
     fileContents: string,
     filePath: string,
     relativePath: string
   ) => TTypingsResult | Promise<TTypingsResult>;
   getAdditionalOutputFiles?: (relativePath: string) => string[];
-  terminal?: ITerminal;
-  globsToIgnore?: string[];
   /**
    * @deprecated
    *
@@ -209,9 +217,9 @@ export class TypingsGenerator {
   }
 
   public getOutputFilePaths(relativePath: string): string[] {
-    const typingsFile: string = this._getTypingsFilePath(relativePath);
+    const typingsFilePaths: Iterable<string> = this._getTypingsFilePaths(relativePath);
     const additionalPaths: string[] | undefined = this._options.getAdditionalOutputFiles?.(relativePath);
-    return additionalPaths ? [typingsFile, ...additionalPaths] : [typingsFile];
+    return additionalPaths ? [...typingsFilePaths, ...additionalPaths] : Array.from(typingsFilePaths);
   }
 
   private async _reprocessFiles(relativePaths: Iterable<string>): Promise<void> {
@@ -271,12 +279,13 @@ export class TypingsGenerator {
         typingsData
       ].join(EOL);
 
-      const generatedTsFilePath: string = this._getTypingsFilePath(relativePath);
-
-      await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {
-        ensureFolderExists: true,
-        convertLineEndings: NewlineKind.OsDefault
-      });
+      const generatedTsFilePaths: Iterable<string> = this._getTypingsFilePaths(relativePath);
+      for (const generatedTsFilePath of generatedTsFilePaths) {
+        await FileSystem.writeFileAsync(generatedTsFilePath, prefixedTypingsData, {
+          ensureFolderExists: true,
+          convertLineEndings: NewlineKind.OsDefault
+        });
+      }
     } catch (e) {
       this._options.terminal!.writeError(
         `Error occurred parsing and generating typings for file "${resolvedPath}": ${e}`
@@ -297,8 +306,15 @@ export class TypingsGenerator {
     }
   }
 
-  private _getTypingsFilePath(relativePath: string): string {
-    return path.resolve(this._options.generatedTsFolder, `${relativePath}.d.ts`);
+  private *_getTypingsFilePaths(relativePath: string): Iterable<string> {
+    const { generatedTsFolder, secondaryGeneratedTsFolders } = this._options;
+    const dtsFilename: string = `${relativePath}.d.ts`;
+    yield path.resolve(generatedTsFolder, dtsFilename);
+    if (secondaryGeneratedTsFolders) {
+      for (const secondaryGeneratedTsFolder of secondaryGeneratedTsFolders) {
+        yield path.resolve(secondaryGeneratedTsFolder, dtsFilename);
+      }
+    }
   }
 
   private _normalizeFileExtensions(fileExtensions: string[]): string[] {

libraries/typings-generator/src/index.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-export { ITypingsGeneratorOptions, TypingsGenerator } from './TypingsGenerator';
+export { ITypingsGeneratorBaseOptions, ITypingsGeneratorOptions, TypingsGenerator } from './TypingsGenerator';
 
 export {
   IStringValueTyping,

webpack/localization-plugin-4/src/LocalizationPlugin.ts

@@ -167,6 +167,17 @@ export class LocalizationPlugin implements Webpack.Plugin {
           this._options.typingsOptions.sourceRoot
         );
       }
+
+      const secondaryGeneratedTsFolders: string[] | undefined =
+        this._options.typingsOptions.secondaryGeneratedTsFolders;
+      if (secondaryGeneratedTsFolders) {
+        for (let i: number = 0; i < secondaryGeneratedTsFolders.length; i++) {
+          const secondaryGeneratedTsFolder: string = secondaryGeneratedTsFolders[i];
+          if (!path.isAbsolute(secondaryGeneratedTsFolder)) {
+            secondaryGeneratedTsFolders[i] = path.resolve(compiler.context, secondaryGeneratedTsFolder);
+          }
+        }
+      }
     }
 
     // https://github.com/webpack/webpack-dev-server/pull/1929/files#diff-15fb51940da53816af13330d8ce69b4eR66
@@ -179,6 +190,7 @@ export class LocalizationPlugin implements Webpack.Plugin {
       typingsPreprocessor = new TypingsGenerator({
         srcFolder: this._options.typingsOptions.sourceRoot || compiler.context,
         generatedTsFolder: this._options.typingsOptions.generatedTsFolder,
+        secondaryGeneratedTsFolders: this._options.typingsOptions.secondaryGeneratedTsFolders,
         exportAsDefault: this._options.typingsOptions.exportAsDefault,
         globsToIgnore: this._options.globsToIgnore,
         ignoreString: this._options.ignoreString,

webpack/localization-plugin-4/src/interfaces.ts

@@ -32,6 +32,11 @@ export interface ITypingsGenerationOptions {
    */
   generatedTsFolder: string;
 
+  /**
+   * Optional additional folders into which `.d.ts` files for loc files should be dropped.
+   */
+  secondaryGeneratedTsFolders?: string[];
+
   /**
    * This optional property overrides the compiler context for discovery of localization files
    * for which typings should be generated.