From 06d3c2314cef291d2ca4ad8aee1de72b9a94d68f Mon Sep 17 00:00:00 2001 From: qihai Date: Thu, 2 Apr 2026 11:48:57 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20fix=20incorrect=20package=20name=20@mic?= =?UTF-8?q?rosoft/rush-sdk=20=E2=86=92=20@rushstack/rush-sdk=20in=20api.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- websites/rushjs.io/docs/pages/extensibility/api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/websites/rushjs.io/docs/pages/extensibility/api.md b/websites/rushjs.io/docs/pages/extensibility/api.md index a02ba60c5..9d45cc6b9 100644 --- a/websites/rushjs.io/docs/pages/extensibility/api.md +++ b/websites/rushjs.io/docs/pages/extensibility/api.md @@ -12,17 +12,17 @@ Below are some usage examples. ## rush-lib vs rush-sdk -You may notice that the NPM packages `@microsoft/rush-lib` and `rushstack/rush-sdk` export the same APIs. What is the difference? +You may notice that the NPM packages `@microsoft/rush-lib` and `@rushstack/rush-sdk` export the same APIs. What is the difference? - `@microsoft/rush-lib` is the **engine** of Rush that implements all the core features. It is a relatively large package that also includes some built-in Rush plugins, with many NPM dependencies. - `@microsoft/rush` is the **CLI** (command-line interface) that provides the `rush` and `rushx` commands that you can invoke from your shell. `@microsoft/rush` depends on `@microsoft/rush-lib`, however if your repository's **rush.json** file requests a different `rushVersion`, the [Rush "version selector"](../contributing.md) will automatically install the requested version of the `@microsoft/rush-lib` engine and use that instead. This ensures that CLI commands always have deterministic behavior, regardless of what version of `@microsoft/rush` is installed globally. -- `@microsoft/rush-sdk` is the **API** interface, which has very few NPM dependencies itself, and mainly acts as a proxy for accessing the `@microsoft/rush-lib` engine. It provides two main benefits: +- `@rushstack/rush-sdk` is the **API** interface, which has very few NPM dependencies itself, and mainly acts as a proxy for accessing the `@microsoft/rush-lib` engine. It provides two main benefits: - - **Version selector:** If your tool imports from `@microsoft/rush-sdk`, then it will load the appropriate version of the engine based on `rushVersion` from **rush.json**. This is important, for example if your script directly imports from `@microsoft/rush-lib` and it is a different version, then the engine may fail to parse a config file whose format has changed. + - **Version selector:** If your tool imports from `@rushstack/rush-sdk`, then it will load the appropriate version of the engine based on `rushVersion` from **rush.json**. This is important, for example if your script directly imports from `@microsoft/rush-lib` and it is a different version, then the engine may fail to parse a config file whose format has changed. - - **Internal APIs**: `@microsoft/rush-sdk` includes stubs that enable you to import internal API's from `@microsoft/rush-lib`. Internal APIs are normally difficult to access because that package is distributed as a Webpack bundle. + - **Internal APIs**: `@rushstack/rush-sdk` includes stubs that enable you to import internal API's from `@microsoft/rush-lib`. Internal APIs are normally difficult to access because that package is distributed as a Webpack bundle. See the [@rushstack/rush-sdk](https://www.npmjs.com/package/@rushstack/rush-sdk) documentation for more details.