From 19853b832bfad6b19276ea71ebc244547018c22b Mon Sep 17 00:00:00 2001 From: Andrey Antukh Date: Tue, 30 Dec 2025 12:12:26 +0100 Subject: [PATCH] :books: Update documentation --- plugins/docs/api-docs.md | 2 +- plugins/docs/create-angular-plugin.md | 6 +++--- plugins/docs/create-plugin.md | 4 ++-- plugins/docs/publish-package.md | 8 ++++---- plugins/docs/test-e2e.md | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/plugins/docs/api-docs.md b/plugins/docs/api-docs.md index 5d18f159e7..a8cf00b157 100644 --- a/plugins/docs/api-docs.md +++ b/plugins/docs/api-docs.md @@ -7,7 +7,7 @@ This document shows you how to create API documentation. If you want to see what the document will look like (the HTML that's generated), you can run the following command: ```shell -npm run build:doc +pnpm run build:doc ``` Once you've done that, you'll find the result in `./dist/doc` diff --git a/plugins/docs/create-angular-plugin.md b/plugins/docs/create-angular-plugin.md index 96aff805c5..bd69b009cd 100644 --- a/plugins/docs/create-angular-plugin.md +++ b/plugins/docs/create-angular-plugin.md @@ -13,7 +13,7 @@ Let's dive in. First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin: ```sh -npx nx g @nx/angular:app example-plugin --directory=apps/example-plugin --bundler=esbuild +pnpx nx g @nx/angular:app example-plugin --directory=apps/example-plugin --bundler=esbuild ``` ### Step 2: Configure the Manifest @@ -125,7 +125,7 @@ console.log('Hello Plugin'); Run this command: ```sh -npx nx run example-plugin:init +pnpx nx run example-plugin:init ``` This will run two tasks: `serve`, the usual Angular server, and `buildPlugin`, which will compile the `plugin.ts` file. @@ -143,7 +143,7 @@ You can also open the Plugin manager modal via: ### Step 9: Build plugin ``` -npx nx run example-plugin:build +pnpx nx run example-plugin:build ``` ### Learn More About Plugin Development diff --git a/plugins/docs/create-plugin.md b/plugins/docs/create-plugin.md index ceda5603ab..06f83ec6b5 100644 --- a/plugins/docs/create-plugin.md +++ b/plugins/docs/create-plugin.md @@ -13,7 +13,7 @@ Let's dive in. First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin: ```sh -npx nx g @nx/web:application example-plugin --directory=apps/example-plugin +pnpx nx g @nx/web:application example-plugin --directory=apps/example-plugin ``` ### Step 2: Migrate eslint to ESM @@ -73,7 +73,7 @@ Update your `tsconfig.app.json` to include the necessary TypeScript files for yo To preview your plugin, start a static server by running: ```sh -npx nx run example-plugin:build --watch & npx nx run example-plugin:preview +pnpx nx run example-plugin:build --watch & pnpx nx run example-plugin:preview ``` ### Step 7: Add TS parser to eslint diff --git a/plugins/docs/publish-package.md b/plugins/docs/publish-package.md index 1f6de33e87..aaee111e6a 100644 --- a/plugins/docs/publish-package.md +++ b/plugins/docs/publish-package.md @@ -22,7 +22,7 @@ expected, run the following command: ```shell git checkout main -npm run release +pnpm run release ``` ### Generating a Real Release @@ -30,7 +30,7 @@ npm run release To create an actual release, disable the dry-run option: ```shell -npm run release -- --dry-run false +pnpm run release -- --dry-run false ``` This command will: @@ -67,7 +67,7 @@ Documentation](https://nx.dev/recipes/nx-release/get-started-with-nx-release). To generate a preview version and avoid publishing it as the latest release, use: ```shell -npm run release -- --dry-run false --latest false --preid next +pnpm run release -- --dry-run false --latest false --preid next ``` For example, if the current version is `0.8.0` and you select the @@ -79,7 +79,7 @@ For example, if the current version is `0.8.0` and you select the To see more options, run: ```shell -npm run release -- --help +pnpm run release -- --help ``` ## Important Reminders diff --git a/plugins/docs/test-e2e.md b/plugins/docs/test-e2e.md index 278bf48035..135c42e280 100644 --- a/plugins/docs/test-e2e.md +++ b/plugins/docs/test-e2e.md @@ -17,7 +17,7 @@ Use the following command to execute the E2E tests: ```bash - npm run test:e2e + pnpm run test:e2e ``` ### Writing Tests @@ -77,5 +77,5 @@ If you need to refresh all the snapshopts run the test with the update option: ```bash - npm run test:e2e -- --update + pnpm run test:e2e -- --update ```