@rushstack/heft-web-rig 0.7.1 → 0.8.2

package/README.md

@@ -1,31 +1,31 @@
-## @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 contains a single profile: `library`
-
-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/master/rigs/heft-web-rig/profiles/library) source folder.
-
-
-## Links
-
-- [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/master/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 contains a single profile: `library`
+
+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/master/rigs/heft-web-rig/profiles/library) source folder.
+
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/master/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.7.1",
+	"version": "0.8.2",
 	"description": "A rig package for web browser projects that build using Heft",
 	"license": "MIT",
 	"repository": {
@@ -9,21 +9,22 @@
 		"directory": "rigs/heft-web-rig"
 	},
 	"peerDependencies": {
-		"@rushstack/heft": "^0.44.1"
+		"@rushstack/heft": "^0.44.2"
 	},
 	"dependencies": {
-		"@microsoft/api-extractor": "7.19.3",
-		"@rushstack/heft-jest-plugin": "0.2.1",
-		"@rushstack/heft-sass-plugin": "0.3.2",
-		"@rushstack/heft-webpack4-plugin": "0.3.28",
-		"eslint": "~8.3.0",
+		"@microsoft/api-extractor": "7.19.4",
+		"@rushstack/heft-jest-plugin": "0.2.2",
+		"@rushstack/heft-sass-plugin": "0.3.6",
+		"@rushstack/heft-webpack4-plugin": "0.3.32",
+		"eslint": "~8.7.0",
 		"jest-environment-jsdom": "~27.4.2",
 		"typescript": "~4.5.2"
 	},
 	"devDependencies": {
-		"@rushstack/heft": "0.44.1"
+		"@rushstack/heft": "0.44.2"
 	},
 	"scripts": {
-		"build": ""
+		"build": "",
+		"_phase:build": ""
 	}
 }

package/profiles/library/config/api-extractor-task.json

@@ -1,21 +1,21 @@
-/**
- * Configures the API Extractor task for the Heft build system.
- *
- * This optional additional file customizes how the Heft task is invoked. The main analysis is
- * controlled by API Extractor's own "api-extractor.json" config file.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/api-extractor-task.schema.json"
-
-  /**
-   * If set to true, use the project's TypeScript compiler version for API Extractor's
-   * analysis. API Extractor's included TypeScript compiler can generally correctly
-   * analyze typings generated by older compilers, and referencing the project's compiler
-   * can cause issues. If issues are encountered with API Extractor's included compiler,
-   * set this option to true.
-   *
-   * This corresponds to API Extractor's "--typescript-compiler-folder" CLI option and
-   * "IExtractorInvokeOptions.typescriptCompilerFolder" API option. This option defaults to false.
-   */
-  // "useProjectTypescriptVersion": true
-}
+/**
+ * Configures the API Extractor task for the Heft build system.
+ *
+ * This optional additional file customizes how the Heft task is invoked. The main analysis is
+ * controlled by API Extractor's own "api-extractor.json" config file.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/api-extractor-task.schema.json"
+
+  /**
+   * If set to true, use the project's TypeScript compiler version for API Extractor's
+   * analysis. API Extractor's included TypeScript compiler can generally correctly
+   * analyze typings generated by older compilers, and referencing the project's compiler
+   * can cause issues. If issues are encountered with API Extractor's included compiler,
+   * set this option to true.
+   *
+   * This corresponds to API Extractor's "--typescript-compiler-folder" CLI option and
+   * "IExtractorInvokeOptions.typescriptCompilerFolder" API option. This option defaults to false.
+   */
+  // "useProjectTypescriptVersion": true
+}

package/profiles/library/config/heft.json

@@ -1,58 +1,58 @@
-/**
- * Defines configuration used by core Heft.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/heft.schema.json",
-
-  "eventActions": [
-    {
-      /**
-       * The kind of built-in operation that should be performed.
-       * The "deleteGlobs" action deletes files or folders that match the
-       * specified glob patterns.
-       */
-      "actionKind": "deleteGlobs",
-
-      /**
-       * The stage of the Heft run during which this action should occur. Note that actions specified in heft.json
-       * occur at the end of the stage of the Heft run.
-       */
-      "heftEvent": "clean",
-
-      /**
-       * A user-defined tag whose purpose is to allow configs to replace/delete handlers that were added by other
-       * configs.
-       */
-      "actionId": "defaultClean",
-
-      /**
-       * Glob patterns to be deleted. The paths are resolved relative to the project folder.
-       * Recommend exactly matching with "projectOutputFolderNames" in rush-project.json.
-       */
-      "globsToDelete": ["dist", "lib", "lib-commonjs", "temp"]
-    }
-  ],
-
-  /**
-   * The list of Heft plugins to be loaded.
-   */
-  "heftPlugins": [
-    {
-      /**
-       * The path to the plugin package.
-       */
-      "plugin": "@rushstack/heft-webpack4-plugin"
-
-      /**
-       * An optional object that provides additional settings that may be defined by the plugin.
-       */
-      // "options": { }
-    },
-    {
-      "plugin": "@rushstack/heft-jest-plugin"
-    },
-    {
-      "plugin": "@rushstack/heft-sass-plugin"
-    }
-  ]
-}
+/**
+ * Defines configuration used by core Heft.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/heft.schema.json",
+
+  "eventActions": [
+    {
+      /**
+       * The kind of built-in operation that should be performed.
+       * The "deleteGlobs" action deletes files or folders that match the
+       * specified glob patterns.
+       */
+      "actionKind": "deleteGlobs",
+
+      /**
+       * The stage of the Heft run during which this action should occur. Note that actions specified in heft.json
+       * occur at the end of the stage of the Heft run.
+       */
+      "heftEvent": "clean",
+
+      /**
+       * A user-defined tag whose purpose is to allow configs to replace/delete handlers that were added by other
+       * configs.
+       */
+      "actionId": "defaultClean",
+
+      /**
+       * Glob patterns to be deleted. The paths are resolved relative to the project folder.
+       * Recommend exactly matching with "projectOutputFolderNames" in rush-project.json.
+       */
+      "globsToDelete": ["dist", "lib", "lib-commonjs", "temp"]
+    }
+  ],
+
+  /**
+   * The list of Heft plugins to be loaded.
+   */
+  "heftPlugins": [
+    {
+      /**
+       * The path to the plugin package.
+       */
+      "plugin": "@rushstack/heft-webpack4-plugin"
+
+      /**
+       * An optional object that provides additional settings that may be defined by the plugin.
+       */
+      // "options": { }
+    },
+    {
+      "plugin": "@rushstack/heft-jest-plugin"
+    },
+    {
+      "plugin": "@rushstack/heft-sass-plugin"
+    }
+  ]
+}

package/profiles/library/config/jest.config.json

@@ -1,5 +1,5 @@
-{
-  "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json",
-
-  "testEnvironment": "jest-environment-jsdom"
-}
+{
+  "extends": "@rushstack/heft-jest-plugin/includes/jest-shared.config.json",
+
+  "testEnvironment": "jest-environment-jsdom"
+}

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

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

package/profiles/library/config/sass.json

@@ -1,47 +1,47 @@
-/**
- * Configures the Sass Typings plugin for the Heft build system.
- *
- * This optional additional file customizes Sass parsing, module resolution, and emitting of
- * typings files for the Typescript compiler.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/sass.schema.json"
-
-  /**
-   * Source code root directory.
-   * This is where .css, .sass, and .scss files will be searched for to generate typings.
-   */
-  // "srcFolder": "src",
-
-  /**
-   * Output directory for generated Sass typings.
-   */
-  // "generatedTsFolder": "temp/sass-ts",
-
-  /**
-   * Determines if export values are wrapped in a default property, or not.
-   */
-  // "exportAsDefault": true,
-
-  /**
-   * Files with these extensions will pass through the Sass transpiler for typings generation.
-   */
-  // "fileExtensions": [
-  //   ".sass",
-  //   ".scss",
-  //   ".css
-  // ],
-
-  /**
-   * A list of paths used when resolving Sass imports.
-   */
-  // "importIncludePaths": [
-  //   "node_modules",
-  //   "src"
-  // ],
-
-  /**
-   * A list of file paths relative to the "src" folder that should be excluded from typings generation.
-   */
-  // "excludeFiles": []
-}
+/**
+ * Configures the Sass Typings plugin for the Heft build system.
+ *
+ * This optional additional file customizes Sass parsing, module resolution, and emitting of
+ * typings files for the Typescript compiler.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/sass.schema.json"
+
+  /**
+   * Source code root directory.
+   * This is where .css, .sass, and .scss files will be searched for to generate typings.
+   */
+  // "srcFolder": "src",
+
+  /**
+   * Output directory for generated Sass typings.
+   */
+  // "generatedTsFolder": "temp/sass-ts",
+
+  /**
+   * Determines if export values are wrapped in a default property, or not.
+   */
+  // "exportAsDefault": true,
+
+  /**
+   * Files with these extensions will pass through the Sass transpiler for typings generation.
+   */
+  // "fileExtensions": [
+  //   ".sass",
+  //   ".scss",
+  //   ".css
+  // ],
+
+  /**
+   * A list of paths used when resolving Sass imports.
+   */
+  // "importIncludePaths": [
+  //   "node_modules",
+  //   "src"
+  // ],
+
+  /**
+   * A list of file paths relative to the "src" folder that should be excluded from typings generation.
+   */
+  // "excludeFiles": []
+}

package/profiles/library/config/typescript.json

@@ -1,68 +1,68 @@
-/**
- * Configures the TypeScript plugin for Heft.  This plugin also manages linting.
- */
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/heft/typescript.schema.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": "commonjs",
-
-      /**
-       * (Required) The name of the folder where the output will be written.
-       */
-      "outFolderName": "lib-commonjs"
-    }
-  ],
-
-  /**
-   * Specifies the intermediary folder that tests will use.  Because Jest uses the
-   * Node.js runtime to execute tests, the module format must be CommonJS.
-   *
-   * The default value is "lib".
-   */
-  "emitFolderNameForTests": "lib-commonjs",
-
-  /**
-   * If set to "true", the TSlint task will not be invoked.
-   */
-  // "disableTslint": true,
-
-  /**
-   * Set this to change the maximum number of file handles that will be opened concurrently for writing.
-   * The default is 50.
-   */
-  // "maxWriteParallelism": 50,
-
-  /**
-   * Describes the way files should be statically coped from src to TS output folders
-   */
-  "staticAssetsToCopy": {
-    /**
-     * File extensions that should be copied from the src folder to the destination folder(s).
-     */
-    "fileExtensions": [".json"]
-
-    /**
-     * 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/typescript.schema.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": "commonjs",
+
+      /**
+       * (Required) The name of the folder where the output will be written.
+       */
+      "outFolderName": "lib-commonjs"
+    }
+  ],
+
+  /**
+   * Specifies the intermediary folder that tests will use.  Because Jest uses the
+   * Node.js runtime to execute tests, the module format must be CommonJS.
+   *
+   * The default value is "lib".
+   */
+  "emitFolderNameForTests": "lib-commonjs",
+
+  /**
+   * If set to "true", the TSlint task will not be invoked.
+   */
+  // "disableTslint": true,
+
+  /**
+   * Set this to change the maximum number of file handles that will be opened concurrently for writing.
+   * The default is 50.
+   */
+  // "maxWriteParallelism": 50,
+
+  /**
+   * Describes the way files should be statically coped from src to TS output folders
+   */
+  "staticAssetsToCopy": {
+    /**
+     * File extensions that should be copied from the src folder to the destination folder(s).
+     */
+    "fileExtensions": [".json"]
+
+    /**
+     * 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"
+    // ]
+  }
+}

package/profiles/library/tsconfig-base.json

@@ -1,29 +1,29 @@
-{
-  "$schema": "http://json.schemastore.org/tsconfig",
-
-  "compilerOptions": {
-    "outDir": "../../../../../lib",
-    "rootDir": "../../../../../src",
-    "rootDirs": ["../../../../../src", "../../../../../temp/sass-ts"],
-
-    "forceConsistentCasingInFileNames": true,
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "declarationMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "noEmitOnError": false,
-    "allowUnreachableCode": false,
-
-    "types": [],
-
-    "module": "esnext",
-    "moduleResolution": "node",
-    "target": "es5",
-    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"]
-  },
-  "include": ["../../../../../src/**/*.ts", "../../../../../src/**/*.tsx"]
-}
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+
+  "compilerOptions": {
+    "outDir": "../../../../../lib",
+    "rootDir": "../../../../../src",
+    "rootDirs": ["../../../../../src", "../../../../../temp/sass-ts"],
+
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "experimentalDecorators": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "noEmitOnError": false,
+    "allowUnreachableCode": false,
+
+    "types": [],
+
+    "module": "esnext",
+    "moduleResolution": "node",
+    "target": "es5",
+    "lib": ["es5", "scripthost", "es2015.collection", "es2015.promise", "es2015.iterable", "dom"]
+  },
+  "include": ["../../../../../src/**/*.ts", "../../../../../src/**/*.tsx"]
+}