README.md

https://rushstack.io/

 

The home for various projects maintained by the Rush Stack community, whose mission is to develop reusable tooling for large scale TypeScript monorepos.

Documentation Links

• What is Rush Stack? - learn about the mission behind these projects
• API reference - browse API documentation for NPM packages
• Gitter chat room - chat with the Rush Stack developers
• Rush - a build orchestrator for large scale TypeScript monorepos
• API Extractor - create .d.ts rollups and track your TypeScript API signatures
• API Documenter - use TSDoc comments to publish an API documentation website

Published Packages

Folder	Version	Changelog	Package
/apps/api-documenter		changelog	@microsoft/api-documenter
/apps/api-extractor		changelog	@microsoft/api-extractor
/apps/api-extractor-model		changelog	@microsoft/api-extractor-model
/apps/rush		changelog	@microsoft/rush
/apps/rush-buildxl		changelog	@microsoft/rush-buildxl
/apps/rush-lib		changelog	@microsoft/rush-lib
/core-build/gulp-core-build		changelog	@microsoft/gulp-core-build
/core-build/gulp-core-build-mocha		changelog	@microsoft/gulp-core-build-mocha
/core-build/gulp-core-build-sass		changelog	@microsoft/gulp-core-build-sass
/core-build/gulp-core-build-serve		changelog	@microsoft/gulp-core-build-serve
/core-build/gulp-core-build-typescript		changelog	@microsoft/gulp-core-build-typescript
/core-build/gulp-core-build-webpack		changelog	@microsoft/gulp-core-build-webpack
/core-build/node-library-build		changelog	@microsoft/node-library-build
/core-build/web-library-build		changelog	@microsoft/web-library-build
/libraries/load-themed-styles		changelog	@microsoft/load-themed-styles
/libraries/node-core-library		changelog	@microsoft/node-core-library
/libraries/package-deps-hash		changelog	@microsoft/package-deps-hash
/libraries/stream-collator		changelog	@microsoft/stream-collator
/libraries/ts-command-line		changelog	@microsoft/ts-command-line
/stack/eslint-config		changelog	@rushstack/eslint-config
/stack/rush-stack		changelog	@microsoft/rush-stack
/stack/rush-stack-compiler-2.4		changelog	@microsoft/rush-stack-compiler-2.4
/stack/rush-stack-compiler-2.7		changelog	@microsoft/rush-stack-compiler-2.7
/stack/rush-stack-compiler-2.8		changelog	@microsoft/rush-stack-compiler-2.8
/stack/rush-stack-compiler-2.9		changelog	@microsoft/rush-stack-compiler-2.9
/stack/rush-stack-compiler-3.0		changelog	@microsoft/rush-stack-compiler-3.0
/stack/rush-stack-compiler-3.1		changelog	@microsoft/rush-stack-compiler-3.1
/stack/rush-stack-compiler-3.2		changelog	@microsoft/rush-stack-compiler-3.2
/stack/rush-stack-compiler-3.3		changelog	@microsoft/rush-stack-compiler-3.3
/stack/rush-stack-compiler-3.4		changelog	@microsoft/rush-stack-compiler-3.4
/stack/rush-stack-compiler-3.5		changelog	@microsoft/rush-stack-compiler-3.5
/webpack/loader-load-themed-styles		changelog	@microsoft/loader-load-themed-styles
/webpack/loader-raw-script		changelog	@microsoft/loader-raw-script
/webpack/loader-set-webpack-public-path		changelog	@microsoft/loader-set-webpack-public-path
/webpack/resolve-chunk-plugin		changelog	@microsoft/resolve-chunk-plugin
/webpack/set-webpack-public-path-plugin		changelog	@microsoft/set-webpack-public-path-plugin

Unpublished Local Projects

Folder	Description
/build-tests/api-documenter-test	Building this project is a regression test for api-documenter
/build-tests/api-extractor-lib1-test	Building this project is a regression test for api-extractor
/build-tests/api-extractor-lib2-test	Building this project is a regression test for api-extractor
/build-tests/api-extractor-lib3-test	Building this project is a regression test for api-extractor
/build-tests/api-extractor-scenarios	Building this project is a regression test for api-extractor
/build-tests/api-extractor-test-01	Building this project is a regression test for api-extractor
/build-tests/api-extractor-test-02	Building this project is a regression test for api-extractor
/build-tests/api-extractor-test-03	Building this project is a regression test for api-extractor
/build-tests/api-extractor-test-04	Building this project is a regression test for api-extractor
/build-tests/node-library-build-test
/build-tests/rush-stack-compiler-2.4-library-test
/build-tests/rush-stack-compiler-2.7-library-test
/build-tests/rush-stack-compiler-2.8-library-test
/build-tests/rush-stack-compiler-2.9-library-test
/build-tests/rush-stack-compiler-3.0-library-test
/build-tests/rush-stack-compiler-3.1-library-test
/build-tests/rush-stack-compiler-3.2-library-test
/build-tests/rush-stack-compiler-3.3-library-test
/build-tests/rush-stack-compiler-3.4-library-test
/build-tests/rush-stack-compiler-3.5-library-test
/build-tests/rush-stack-library-test
/build-tests/web-library-build-test
/libraries/rushell	Execute shell commands using a consistent syntax on every platform
/repo-scripts/doc-plugin-rush-stack	API Documenter plugin used with the rushstack.io website
/repo-scripts/generate-api-docs	Used to generate API docs for the rushstack.io website
/repo-scripts/repo-toolbox	Used to execute various operations specific to this repo
/stack/rush-stack-compiler-shared

Contributor Notice

This repo welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This repo has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.