Skip to content

Latest commit

 

History

History
 
 

rush-sdk

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
config
config
 
 
src
src
 
 
.eslintrc.js
.eslintrc.js
 
 
.npmignore
.npmignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@rushstack/rush-sdk

This is a companion package for the Rush tool. See the @microsoft/rush package for details.

⚠ THIS PACKAGE IS EXPERIMENTAL ⚠

The @rushstack/rush-sdk package acts as a lightweight proxy for accessing the APIs of the @microsoft/rush-lib engine. It is intended to support three different use cases:

  1. Rush plugins should import from @rushstack/rush-sdk instead of @microsoft/rush-lib. This gives plugins full access to Rush APIs while avoiding a redundant installation of those packages. At runtime, the APIs will be bound to the correct rushVersion from rush.json, and guaranteed to be the same @microsoft/rush-lib module instance as the plugin host.

  2. When authoring unit tests for a Rush plugin, developers should add @microsoft/rush-lib to their package.json devDependencies. In this context, @rushstack/rush-sdk will resolve to that instance for testing purposes.

  3. For scripts and tools that are designed to be used in a Rush monorepo, in the future @rushstack/rush-sdk will automatically invoke install-run-rush.js and load the local installation. This ensures that tools load a compatible version of the Rush engine for the given branch. Once this is implemented, @rushstack/rush-sdk can replace @microsoft/rush-lib entirely as the official API interface, with the latter serving as the underlying implementation.

The @rushstack/rush-sdk API declarations are identical to the corresponding version of @microsoft/rush-lib.

Debugging

Verbose logging can be turn on by set environment variable RUSH_SDK_DEBUG to 1

Links

Rush is part of the Rush Stack family of projects.