@rushstack/heft - npm Package Compare versions

Comparing version 0.56.2 to 0.56.3

dist/heft.d.ts

@@ -443,3 +443,3 @@ /**
      * The scoped logger for the lifecycle plugin. Messages logged with this logger will be prefixed
-     * with the plugin name, in the format "[lifecycle:<pluginName>]". It is highly recommended that
+     * with the plugin name, in the format `[lifecycle:<pluginName>]`. It is highly recommended that
      * writing to the console be performed via the logger, as it will ensure that logging messages
@@ -742,3 +742,3 @@ * are labeled with the source of the message.
      * The scoped logger for the task. Messages logged with this logger will be prefixed with
-     * the phase and task name, in the format "[<phaseName>:<taskName>]". It is highly recommended
+     * the phase and task name, in the format `[<phaseName>:<taskName>]`. It is highly recommended
      * that writing to the console be performed via the logger, as it will ensure that logging messages
@@ -745,0 +745,0 @@ * are labeled with the source of the message.

lib/pluginFramework/HeftLifecycleSession.d.ts

@@ -40,3 +40,3 @@ import type { AsyncParallelHook } from 'tapable';
      * The scoped logger for the lifecycle plugin. Messages logged with this logger will be prefixed
-     * with the plugin name, in the format "[lifecycle:<pluginName>]". It is highly recommended that
+     * with the plugin name, in the format `[lifecycle:<pluginName>]`. It is highly recommended that
      * writing to the console be performed via the logger, as it will ensure that logging messages
@@ -43,0 +43,0 @@ * are labeled with the source of the message.

lib/pluginFramework/HeftTaskSession.d.ts

@@ -95,3 +95,3 @@ import { AsyncParallelHook, AsyncSeriesWaterfallHook } from 'tapable';
      * The scoped logger for the task. Messages logged with this logger will be prefixed with
-     * the phase and task name, in the format "[<phaseName>:<taskName>]". It is highly recommended
+     * the phase and task name, in the format `[<phaseName>:<taskName>]`. It is highly recommended
      * that writing to the console be performed via the logger, as it will ensure that logging messages
@@ -98,0 +98,0 @@ * are labeled with the source of the message.

package.json

 {
   "name": "@rushstack/heft",
-  "version": "0.56.2",
+  "version": "0.56.3",
   "description": "Build all your JavaScript projects the same way: A way that works.",
@@ -55,3 +55,3 @@ "keywords": [
     "typescript": "~5.0.4",
-    "@microsoft/api-extractor": "7.36.1",
+    "@microsoft/api-extractor": "7.36.2",
     "@rushstack/eslint-config": "3.3.2"
@@ -58,0 +58,0 @@ },

README.md

@@ -19,9 +19,9 @@ # @rushstack/heft
 
-Heft is typically launched by the `"build"` action from a **package.json** file. It's designed for use in
-a monorepo with potentially hundreds of projects, where the [Rush](https://rushjs.io/) orchestrator invokes
-a `"build"` action separately in each project folder. In this situation, everything must execute as fast as possible.
+Heft is typically launched by **package.json** commands such as `"npm run build"` or `"npm run test"`. It's designed
+for use in a monorepo with potentially hundreds of projects, where the [Rush](https://rushjs.io/) orchestrator invokes
+these commands separately in each project folder. In this situation, everything must execute as fast as possible.
 Special purpose scripts become a headache to maintain, so it's better to replace them with a reusable engine that's
 driven by config files. In a large repo, you'll want to minimize duplication of these config files across projects.
 Ultimately, you'll want to define a small set of stereotypical project types
-(["rigs"](https://rushstack.io/pages/heft/rig_packages/)) that you will maintain, then discourage projects from
+(["rigs"](https://rushstack.io/pages/heft/rig_packages/)) to officially support, then discourage projects from
 overriding the rig configuration. Being consistent ensures that any person can easily contribute to any project.
@@ -37,4 +37,5 @@ Heft is a ready-made implementation of all these concepts.
 - **Optimized**: Heft tracks fine-grained performance metrics at each step. The TypeScript plugin implements
-  sophisticated optimizations such as: filesystem caching, incremental compilation, multi-target emit,
-  a unified compiler pass for Jest/Webpack/ESLint, and hosting the compiler in a separate worker process.
+  sophisticated optimizations such as: filesystem caching, incremental compilation, simultaneous multi-target emit,
+  and a unified compiler pass for Jest/Webpack/ESLint. JSON config files and plugin manifests enable fast
+  querying of metadata without evaluating potentially inefficient script code.
 
@@ -50,5 +51,5 @@ - **Complete**: Rush Stack aspires to establish a fully worked out solution for building typical TypeScript
   or loaders. Heft is organized around plugins using the [tapable](https://www.npmjs.com/package/tapable)
-  hook system (familiar from Webpack). It's easy to write your own plugins.  Compared to loose architectures
-  such as Grunt or Gulp, Heft's plugin-system is organized around explicit easy-to-read config files.
-  Customizations generally will extend a standard rig rather than starting from scratch.
+  hook system (familiar from Webpack). Strongly typed APIs make it easy to write your own plugins. Compared to
+  loose architectures such as Grunt or Gulp, Heft's plugin-system is organized around explicit easy-to-read
+  config files. Customizations generally will extend a standard rig rather than starting from scratch.
 
@@ -60,5 +61,5 @@ - **Familiar**: Like Rush, Heft is a regular Node.js application -- developers don't need to install native
 
-- **Professional**: The Rush Stack projects are developed by and for engineers who ship large scale commercial apps.
-  Each feature is designed, discussed in the open, and thoughtfully code reviewed. Breaking changes require
-  us to migrate thousands of our own projects, so upgrades are relatively painless compared to typical
+- **Professional**: The Rush Stack projects are developed by and for engineers who ship large scale commercial
+  apps. Each feature is designed, discussed in the open, and thoughtfully code reviewed. Breaking changes
+  require us to migrate thousands of our own projects, so upgrades are relatively painless compared to typical
   Node.js tooling.
@@ -65,0 +66,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

985051

increased by0.01%

Number of lines in readme file

91

increased by1.11%

No dependency changes