@rushstack/heft-web-rig 0.19.8 → 0.19.9

package/LICENSE

@@ -1,24 +1,24 @@
-@rushstack/heft-web-rig
-
-Copyright (c) Microsoft Corporation. All rights reserved.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+@rushstack/heft-web-rig
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,35 +1,35 @@
-## @rushstack/heft-web-rig
-
-A rig package for web projects that build using [Heft](https://www.npmjs.com/package/@rushstack/heft)
-build system.  To learn more about rig packages, consult the
-[@rushstack/rig-package](https://www.npmjs.com/package/@rushstack/rig-package) documentation.
-
-This rig provides the following profiles:
-
-- [app](./profiles/app/): For applications that get bundled using Webpack.
-- [library](./profiles/library/): For creating library packages to be consumed by other web projects.  ***Also use this profile for a library meant to be used by both Node.js and web apps.***
-
-
-To enable it, add a **rig.json** file to your project, as shown below:
-
-**config/rig.json**
-```js
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
-
-  "rigPackageName": "@rushstack/heft-web-rig",
-  "rigProfile": "library"
-}
-```
-
-The config files provided by this rig profile can be found in the [heft-web-rig/profiles/library](
-https://github.com/microsoft/rushstack/tree/main/rigs/heft-web-rig/profiles/library) source folder.
-
-
-## Links
-
-- [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/main/rigs/heft-web-rig/CHANGELOG.md) - Find
-  out what's new in the latest version
-
-`@rushstack/heft-web-rig` is part of the [Rush Stack](https://rushstack.io/) family of projects.
+## @rushstack/heft-web-rig
+
+A rig package for web projects that build using [Heft](https://www.npmjs.com/package/@rushstack/heft)
+build system.  To learn more about rig packages, consult the
+[@rushstack/rig-package](https://www.npmjs.com/package/@rushstack/rig-package) documentation.
+
+This rig provides the following profiles:
+
+- [app](./profiles/app/): For applications that get bundled using Webpack.
+- [library](./profiles/library/): For creating library packages to be consumed by other web projects.  ***Also use this profile for a library meant to be used by both Node.js and web apps.***
+
+
+To enable it, add a **rig.json** file to your project, as shown below:
+
+**config/rig.json**
+```js
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+
+  "rigPackageName": "@rushstack/heft-web-rig",
+  "rigProfile": "library"
+}
+```
+
+The config files provided by this rig profile can be found in the [heft-web-rig/profiles/library](
+https://github.com/microsoft/rushstack/tree/main/rigs/heft-web-rig/profiles/library) source folder.
+
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/rigs/heft-web-rig/CHANGELOG.md) - Find
+  out what's new in the latest version
+
+`@rushstack/heft-web-rig` is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/heft-web-rig",
-  "version": "0.19.8",
+  "version": "0.19.9",
   "description": "A rig package for web browser projects that build using Heft",
   "license": "MIT",
   "repository": {
@@ -9,7 +9,7 @@
     "directory": "rigs/heft-web-rig"
   },
   "peerDependencies": {
-    "@rushstack/heft": "^0.63.0"
+    "@rushstack/heft": "^0.63.1"
   },
   "dependencies": {
     "@types/heft-jest": "1.0.1",
@@ -32,17 +32,17 @@
     "webpack-bundle-analyzer": "~4.5.0",
     "webpack-merge": "~5.8.0",
     "webpack": "~5.82.1",
-    "@microsoft/api-extractor": "7.38.1",
     "@rushstack/eslint-config": "3.4.1",
-    "@rushstack/heft-api-extractor-plugin": "0.2.10",
-    "@rushstack/heft-jest-plugin": "0.10.2",
-    "@rushstack/heft-lint-plugin": "0.2.10",
-    "@rushstack/heft-sass-plugin": "0.12.10",
-    "@rushstack/heft-typescript-plugin": "0.2.10",
-    "@rushstack/heft-webpack5-plugin": "0.9.10"
+    "@rushstack/heft-jest-plugin": "0.10.3",
+    "@rushstack/heft-api-extractor-plugin": "0.2.11",
+    "@microsoft/api-extractor": "7.38.2",
+    "@rushstack/heft-lint-plugin": "0.2.11",
+    "@rushstack/heft-sass-plugin": "0.12.11",
+    "@rushstack/heft-typescript-plugin": "0.2.11",
+    "@rushstack/heft-webpack5-plugin": "0.9.11"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.63.0"
+    "@rushstack/heft": "0.63.1"
   },
   "scripts": {
     "build": "",

package/profiles/app/config/heft.json

@@ -1,68 +1,68 @@
-/**
- * Defines configuration used by core Heft.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
-
-  /**
-   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
-   * settings to be shared across multiple projects.
-   */
-  // "extends": "base-project/config/heft.json",
-
-  "aliasesByName": {
-    "start": {
-      "actionName": "build-watch",
-      "defaultParameters": ["--serve"]
-    }
-  },
-
-  "phasesByName": {
-    "build": {
-      "cleanFiles": [{ "includeGlobs": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6"] }],
-
-      "tasksByName": {
-        "sass": {
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-sass-plugin"
-          }
-        },
-        "typescript": {
-          "taskDependencies": ["sass"],
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-typescript-plugin"
-          }
-        },
-        "lint": {
-          "taskDependencies": ["typescript"],
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-lint-plugin"
-          }
-        },
-        "api-extractor": {
-          "taskDependencies": ["typescript"],
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-api-extractor-plugin"
-          }
-        },
-        "webpack": {
-          "taskDependencies": ["typescript"],
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-webpack5-plugin"
-          }
-        }
-      }
-    },
-
-    "test": {
-      "phaseDependencies": ["build"],
-      "tasksByName": {
-        "jest": {
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft-jest-plugin"
-          }
-        }
-      }
-    }
-  }
-}
+/**
+ * Defines configuration used by core Heft.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
+   * settings to be shared across multiple projects.
+   */
+  // "extends": "base-project/config/heft.json",
+
+  "aliasesByName": {
+    "start": {
+      "actionName": "build-watch",
+      "defaultParameters": ["--serve"]
+    }
+  },
+
+  "phasesByName": {
+    "build": {
+      "cleanFiles": [{ "includeGlobs": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6"] }],
+
+      "tasksByName": {
+        "sass": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-sass-plugin"
+          }
+        },
+        "typescript": {
+          "taskDependencies": ["sass"],
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-typescript-plugin"
+          }
+        },
+        "lint": {
+          "taskDependencies": ["typescript"],
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-lint-plugin"
+          }
+        },
+        "api-extractor": {
+          "taskDependencies": ["typescript"],
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-api-extractor-plugin"
+          }
+        },
+        "webpack": {
+          "taskDependencies": ["typescript"],
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-webpack5-plugin"
+          }
+        }
+      }
+    },
+
+    "test": {
+      "phaseDependencies": ["build"],
+      "tasksByName": {
+        "jest": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-jest-plugin"
+          }
+        }
+      }
+    }
+  }
+}

package/profiles/app/config/jest.config.json

@@ -1,3 +1,3 @@
-{
-  "extends": "@rushstack/heft-jest-plugin/includes/jest-web.config.json"
-}
+{
+  "extends": "@rushstack/heft-jest-plugin/includes/jest-web.config.json"
+}

package/profiles/app/config/rush-project.json

@@ -1,12 +1,12 @@
-{
-  "operationSettings": [
-    {
-      "operationName": "_phase:build",
-      "outputFolderNames": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6", "temp"]
-    },
-    {
-      "operationName": "build",
-      "outputFolderNames": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6", "temp"]
-    }
-  ]
-}
+{
+  "operationSettings": [
+    {
+      "operationName": "_phase:build",
+      "outputFolderNames": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6", "temp"]
+    },
+    {
+      "operationName": "build",
+      "outputFolderNames": ["dist", "lib", "lib-amd", "lib-commonjs", "lib-es6", "temp"]
+    }
+  ]
+}

package/profiles/app/config/sass.json

@@ -1,65 +1,65 @@
-/**
- * Configuration for @rushstack/heft-sass-plugin
- *
- * This optional additional file customizes Sass parsing, module resolution, and emitting of
- * Typescript .d.ts files.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-sass-plugin.schema.json",
-
-  /**
-   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
-   * settings to be shared across multiple projects.
-   */
-  // "extends": "base-project/config/serve-command.json",
-
-  /**
-   * The root directory for project source code.
-   *
-   * Default value: "src/"
-   */
-  // "srcFolder": "src/",
-
-  /**
-   * Output directory for generated Sass typings.
-   *
-   * Default value: "temp/sass-ts/"
-   */
-  // "generatedTsFolder": "temp/sass-ts/",
-
-  /**
-   * Determines whether export values are wrapped in a default property, or not.
-   *
-   * Default value: true
-   */
-  // "exportAsDefault": false,
-
-  /**
-   * If specified, folders where compiled CSS files will be emitted to. They will be named by appending
-   * ".css" to the source file name for ease of reference translation.
-   *
-   * Default value: undefined
-   */
-  // "cssOutputFolders": ["lib", "lib-commonjs"],
-
-  /**
-   * Files with these extensions will pass through the Sass transpiler for typings generation.
-   *
-   * Default value: [".sass", ".scss", ".css"]
-   */
-  "fileExtensions": [".sass", ".scss"]
-
-  /**
-   * A list of paths used when resolving Sass imports.  The paths should be relative to the project root.
-   *
-   * Default value: ["node_modules", "src"]
-   */
-  // "importIncludePaths": ["node_modules", "src"],
-
-  /**
-   * A list of file paths relative to the "src" folder that should be excluded from typings generation.
-   *
-   * Default value: undefined
-   */
-  // "excludeFiles": []
-}
+/**
+ * Configuration for @rushstack/heft-sass-plugin
+ *
+ * This optional additional file customizes Sass parsing, module resolution, and emitting of
+ * Typescript .d.ts files.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-sass-plugin.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
+   * settings to be shared across multiple projects.
+   */
+  // "extends": "base-project/config/serve-command.json",
+
+  /**
+   * The root directory for project source code.
+   *
+   * Default value: "src/"
+   */
+  // "srcFolder": "src/",
+
+  /**
+   * Output directory for generated Sass typings.
+   *
+   * Default value: "temp/sass-ts/"
+   */
+  // "generatedTsFolder": "temp/sass-ts/",
+
+  /**
+   * Determines whether export values are wrapped in a default property, or not.
+   *
+   * Default value: true
+   */
+  // "exportAsDefault": false,
+
+  /**
+   * If specified, folders where compiled CSS files will be emitted to. They will be named by appending
+   * ".css" to the source file name for ease of reference translation.
+   *
+   * Default value: undefined
+   */
+  // "cssOutputFolders": ["lib", "lib-commonjs"],
+
+  /**
+   * Files with these extensions will pass through the Sass transpiler for typings generation.
+   *
+   * Default value: [".sass", ".scss", ".css"]
+   */
+  "fileExtensions": [".sass", ".scss"]
+
+  /**
+   * A list of paths used when resolving Sass imports.  The paths should be relative to the project root.
+   *
+   * Default value: ["node_modules", "src"]
+   */
+  // "importIncludePaths": ["node_modules", "src"],
+
+  /**
+   * A list of file paths relative to the "src" folder that should be excluded from typings generation.
+   *
+   * Default value: undefined
+   */
+  // "excludeFiles": []
+}

package/profiles/app/config/typescript.json

@@ -1,98 +1,98 @@
-/**
- * Configures the TypeScript plugin for Heft.  This plugin also manages linting.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/typescript.schema.json",
-
-  /**
-   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
-   * settings to be shared across multiple projects.
-   */
-  // "extends": "base-project/config/typescript.json",
-
-  /**
-   * If provided, emit these module kinds in addition to the modules specified in the tsconfig.
-   * Note that this option only applies to the main tsconfig.json configuration.
-   */
-  "additionalModuleKindsToEmit": [
-    // {
-    //   /**
-    //    * (Required) Must be one of "commonjs", "amd", "umd", "system", "es2015", "esnext"
-    //    */
-    //  "moduleKind": "amd",
-    //
-    //   /**
-    //    * (Required) The name of the folder where the output will be written.
-    //    */
-    //    "outFolderName": "lib-amd"
-    // }
-
-    {
-      "moduleKind": "commonjs",
-      "outFolderName": "lib-commonjs"
-    }
-  ],
-
-  /**
-   * If true, emit CommonJS module output to the folder specified in the tsconfig "outDir" compiler option with the .cjs extension alongside (or instead of, if TSConfig specifies CommonJS) the default compilation output.
-   */
-  // "emitCjsExtensionForCommonJS": true,
-
-  /**
-   * If true, emit ESNext module output to the folder specified in the tsconfig "outDir" compiler option with the .mjs extension alongside (or instead of, if TSConfig specifies ESNext) the default compilation output.
-   */
-  // "emitMjsExtensionForESModule": true,
-
-  /**
-   * If true and "isolatedModules" is configured in tsconfig.json, use a worker thread to run transpilation concurrently with type checking and declaration emit.
-   */
-  // "useTranspilerWorker": true
-
-  /**
-   * Configures additional file types that should be copied into the TypeScript compiler's emit folders, for example
-   * so that these files can be resolved by import statements.
-   */
-  "staticAssetsToCopy": {
-    /**
-     * File extensions that should be copied from the src folder to the destination folder(s).
-     */
-    "fileExtensions": [
-      ".aac",
-      ".css",
-      ".eot",
-      ".gif",
-      ".jpeg",
-      ".jpg",
-      ".json",
-      ".m4a",
-      ".mp3",
-      ".mp4",
-      ".oga",
-      ".otf",
-      ".png",
-      ".scss",
-      ".svg",
-      ".ttf",
-      ".wav",
-      ".webm",
-      ".webp",
-      ".woff",
-      ".woff2"
-    ]
-
-    /**
-     * Glob patterns that should be explicitly included.
-     */
-    // "includeGlobs": [
-    //   "some/path/*.js"
-    // ],
-
-    /**
-     * Glob patterns that should be explicitly excluded. This takes precedence over globs listed
-     * in "includeGlobs" and files that match the file extensions provided in "fileExtensions".
-     */
-    // "excludeGlobs": [
-    //   "some/path/*.css"
-    // ]
-  }
-}
+/**
+ * Configures the TypeScript plugin for Heft.  This plugin also manages linting.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/typescript.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
+   * settings to be shared across multiple projects.
+   */
+  // "extends": "base-project/config/typescript.json",
+
+  /**
+   * If provided, emit these module kinds in addition to the modules specified in the tsconfig.
+   * Note that this option only applies to the main tsconfig.json configuration.
+   */
+  "additionalModuleKindsToEmit": [
+    // {
+    //   /**
+    //    * (Required) Must be one of "commonjs", "amd", "umd", "system", "es2015", "esnext"
+    //    */
+    //  "moduleKind": "amd",
+    //
+    //   /**
+    //    * (Required) The name of the folder where the output will be written.
+    //    */
+    //    "outFolderName": "lib-amd"
+    // }
+
+    {
+      "moduleKind": "commonjs",
+      "outFolderName": "lib-commonjs"
+    }
+  ],
+
+  /**
+   * If true, emit CommonJS module output to the folder specified in the tsconfig "outDir" compiler option with the .cjs extension alongside (or instead of, if TSConfig specifies CommonJS) the default compilation output.
+   */
+  // "emitCjsExtensionForCommonJS": true,
+
+  /**
+   * If true, emit ESNext module output to the folder specified in the tsconfig "outDir" compiler option with the .mjs extension alongside (or instead of, if TSConfig specifies ESNext) the default compilation output.
+   */
+  // "emitMjsExtensionForESModule": true,
+
+  /**
+   * If true and "isolatedModules" is configured in tsconfig.json, use a worker thread to run transpilation concurrently with type checking and declaration emit.
+   */
+  // "useTranspilerWorker": true
+
+  /**
+   * Configures additional file types that should be copied into the TypeScript compiler's emit folders, for example
+   * so that these files can be resolved by import statements.
+   */
+  "staticAssetsToCopy": {
+    /**
+     * File extensions that should be copied from the src folder to the destination folder(s).
+     */
+    "fileExtensions": [
+      ".aac",
+      ".css",
+      ".eot",
+      ".gif",
+      ".jpeg",
+      ".jpg",
+      ".json",
+      ".m4a",
+      ".mp3",
+      ".mp4",
+      ".oga",
+      ".otf",
+      ".png",
+      ".scss",
+      ".svg",
+      ".ttf",
+      ".wav",
+      ".webm",
+      ".webp",
+      ".woff",
+      ".woff2"
+    ]
+
+    /**
+     * Glob patterns that should be explicitly included.
+     */
+    // "includeGlobs": [
+    //   "some/path/*.js"
+    // ],
+
+    /**
+     * Glob patterns that should be explicitly excluded. This takes precedence over globs listed
+     * in "includeGlobs" and files that match the file extensions provided in "fileExtensions".
+     */
+    // "excludeGlobs": [
+    //   "some/path/*.css"
+    // ]
+  }
+}