Skip to content

Commit

Permalink
Some more editing
Browse files Browse the repository at this point in the history
  • Loading branch information
octogonz committed Mar 19, 2021
1 parent 1cc0b33 commit 2274c0d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions apps/heft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,38 @@ Special purpose scripts become a headache to maintain, so it's better to replace
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
overriding the rig configuration. Consistency ensures that any person can easily contribute to any project.
overriding the rig configuration. Being consistent ensures that any person can easily contribute to any project.
Heft is a ready-made implementation of all these concepts.

You don’t need a monorepo to use Heft, however. It also works well for small standalone projects. Compared to other
similar systems, Heft has some unique design goals:

- **Scalable**: Heft interfaces with the [Rush Stack](https://rushstack.io/) family of tools, which are optimized
- **Scalable**: Heft interfaces with the [Rush Stack](https://rushstack.io/) family of tools, which are tailored
for large monorepos with many people and projects. Heft doesn't require Rush, though.

- **Optimized**: Heft tracks fine-grained performance metrics at each step. Although Heft is still in its
early stages, the TypeScript plugin already implements sophisticated optimizations such as: filesystem caching,
incremental compilation, symlinking of cache files to reduce copy times, hosting the compiler in a separate
worker process, and a unified compiler pass for Jest and Webpack.

- **Polished and complete**: Philosophically, Rush Stack aspires to provide a comprehensive solution for typical
TypeScript projects. Unopinionated task abstractions often work against this goal: It's expensive to optimize
and support (and document!) every possible cocktail of tech choices. The best optimizations and integrations
- **Complete**: Rush Stack aspires to establish a fully worked out solution for building typical TypeScript
projects. Unopinionated task abstractions often work against this goal: It is expensive to optimize and support
(and document!) every possible cocktail of tech choices. The best optimizations and integrations
make lots of assumptions about how tasks will interact. Heft is opinionated. Our aim is to agree on a recommended
toolkit that works well for a broad range of scenarios, then work together on the deep investments that will
make that a great experience.

- **Extensible**: Most projects require at least a few specialized tasks such as preprocessors, postprocessors,
or loaders. Heft is composed of 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 ships a predefined arrangement of "stages" that custom tasks hook into. Having
a standardized starting point makes it easier to get technical support for customized rigs.

- **Familiar**: Like Rush, Heft is a regular Node.js application -- developers don't need to install native
prerequisites such as Python, MSYS2, or the .NET Framework. Heft's source code is easy to understand and debug
because it's 100% TypeScript, the same programming language as your web projects. Developing for native targets
is still possible, of course.

- **Extensible**: Most projects require at least a few specialized tasks such as preprocessors, postprocessors,
or loaders. Heft is made of plugins that use the [tapable](https://www.npmjs.com/package/tapable)
hook system (familiar from Webpack), and it's easy to write your own plugins. Compared to loose architectures
such as Grunt or Gulp, Heft ships a predefined arrangement of "stages" for custom tasks to hook into. Working
from a standardized starting point makes it easier to get technical support for custom rigs.

- **Professional**: The Rush Stack projects are developed by and for engineers who ship major commercial services.
Each feature is designed, discussed in the open, and thoughtfully code reviewed. Despite being a free community
collaboration, this software is developed with the mindset that we'll be depending on it for many years to come.
Expand Down

0 comments on commit 2274c0d

Please sign in to comment.