@rushstack/heft-node-rig 2.3.5 → 2.3.7

package/LICENSE

@@ -1,24 +1,24 @@
-@rushstack/heft-node-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-node-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,30 +1,30 @@
-## @rushstack/heft-node-rig
-
-A rig package for Node.js 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: `default`
-
-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-node-rig"
-}
-```
-
-The config files provided by this rig profile can be found in the [heft-node-rig/profiles/default](
-https://github.com/microsoft/rushstack/tree/main/rigs/heft-node-rig/profiles/default) source folder.
-
-
-## Links
-
-- [CHANGELOG.md](
-  https://github.com/microsoft/rushstack/blob/main/rigs/heft-node-rig/CHANGELOG.md) - Find
-  out what's new in the latest version
-
-`@rushstack/heft-node-rig` is part of the [Rush Stack](https://rushstack.io/) family of projects.
+## @rushstack/heft-node-rig
+
+A rig package for Node.js 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: `default`
+
+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-node-rig"
+}
+```
+
+The config files provided by this rig profile can be found in the [heft-node-rig/profiles/default](
+https://github.com/microsoft/rushstack/tree/main/rigs/heft-node-rig/profiles/default) source folder.
+
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/rigs/heft-node-rig/CHANGELOG.md) - Find
+  out what's new in the latest version
+
+`@rushstack/heft-node-rig` is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/heft-node-rig",
-  "version": "2.3.5",
+  "version": "2.3.7",
   "description": "A rig package for Node.js projects that build using Heft",
   "license": "MIT",
   "repository": {
@@ -16,10 +16,10 @@
     "eslint": "~8.7.0",
     "jest-environment-node": "~29.5.0",
     "typescript": "~5.0.4",
-    "@microsoft/api-extractor": "7.38.0",
     "@rushstack/eslint-config": "3.4.1",
+    "@microsoft/api-extractor": "7.38.0",
     "@rushstack/heft-api-extractor-plugin": "0.2.9",
-    "@rushstack/heft-jest-plugin": "0.9.9",
+    "@rushstack/heft-jest-plugin": "0.10.1",
     "@rushstack/heft-lint-plugin": "0.2.9",
     "@rushstack/heft-typescript-plugin": "0.2.9"
   },

package/profiles/default/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/v0/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/v0/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/default/config/heft.json

@@ -1,63 +1,63 @@
-/**
- * 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-commonjs"] }],
-
-      "tasksByName": {
-        "typescript": {
-          "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"
-          }
-        },
-        "node-service": {
-          "taskDependencies": ["typescript"],
-          "taskPlugin": {
-            "pluginPackage": "@rushstack/heft",
-            "pluginName": "node-service-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-commonjs"] }],
+
+      "tasksByName": {
+        "typescript": {
+          "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"
+          }
+        },
+        "node-service": {
+          "taskDependencies": ["typescript"],
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft",
+            "pluginName": "node-service-plugin"
+          }
+        }
+      }
+    },
+
+    "test": {
+      "phaseDependencies": ["build"],
+      "tasksByName": {
+        "jest": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-jest-plugin"
+          }
+        }
+      }
+    }
+  }
+}

package/profiles/default/config/jest.config.json

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

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

@@ -1,12 +1,12 @@
-{
-  "operationSettings": [
-    {
-      "operationName": "_phase:build",
-      "outputFolderNames": ["dist", "lib", "lib-commonjs", "temp"]
-    },
-    {
-      "operationName": "build",
-      "outputFolderNames": ["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/default/config/typescript.json

@@ -1,71 +1,71 @@
-/**
- * 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"
-    // }
-  ],
-
-  /**
-   * 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": [".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/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"
+    // }
+  ],
+
+  /**
+   * 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": [".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/default/includes/eslint/mixins/friendly-locals.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/mixins/friendly-locals']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/mixins/friendly-locals']
+};

package/profiles/default/includes/eslint/mixins/packlets.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/mixins/packlets']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/mixins/packlets']
+};

package/profiles/default/includes/eslint/mixins/react.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/mixins/react']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/mixins/react']
+};

package/profiles/default/includes/eslint/mixins/tsdoc.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/mixins/tsdoc']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/mixins/tsdoc']
+};

package/profiles/default/includes/eslint/patch/custom-config-package-names.js

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-require('@rushstack/eslint-config/patch/custom-config-package-names');
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+require('@rushstack/eslint-config/patch/custom-config-package-names');

package/profiles/default/includes/eslint/patch/modern-module-resolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-require('@rushstack/eslint-config/patch/modern-module-resolution');
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+require('@rushstack/eslint-config/patch/modern-module-resolution');

package/profiles/default/includes/eslint/profile/node-trusted-tool.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/profile/node-trusted-tool']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/profile/node-trusted-tool']
+};

package/profiles/default/includes/eslint/profile/node.js

@@ -1,6 +1,6 @@
-// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/profile/node']
-};
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+module.exports = {
+  extends: ['@rushstack/eslint-config/profile/node']
+};

package/profiles/default/tsconfig-base.json

@@ -1,31 +1,31 @@
-{
-  "$schema": "http://json.schemastore.org/tsconfig",
-
-  "compilerOptions": {
-    "outDir": "../../../../../lib",
-    "rootDir": "../../../../../src",
-
-    "forceConsistentCasingInFileNames": true,
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "declarationMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strict": true,
-    "useUnknownInCatchVariables": false,
-    "esModuleInterop": true,
-    "noEmitOnError": false,
-    "allowUnreachableCode": false,
-
-    "types": ["heft-jest"],
-    "typeRoots": ["../../../../../node_modules/@types", "../../node_modules/@types"],
-
-    "module": "commonjs",
-    "target": "es2017",
-    "lib": ["es2017"],
-
-    "incremental": true
-  },
-  "include": ["../../../../../src/**/*.ts", "../../../../../src/**/*.tsx"]
-}
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+
+  "compilerOptions": {
+    "outDir": "../../../../../lib",
+    "rootDir": "../../../../../src",
+
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "experimentalDecorators": true,
+    "strict": true,
+    "useUnknownInCatchVariables": false,
+    "esModuleInterop": true,
+    "noEmitOnError": false,
+    "allowUnreachableCode": false,
+
+    "types": ["heft-jest"],
+    "typeRoots": ["../../../../../node_modules/@types", "../../node_modules/@types"],
+
+    "module": "commonjs",
+    "target": "es2017",
+    "lib": ["es2017"],
+
+    "incremental": true
+  },
+  "include": ["../../../../../src/**/*.ts", "../../../../../src/**/*.tsx"]
+}