From 31dff816d5ff87d15d9c650676ecde4ce1430459 Mon Sep 17 00:00:00 2001 From: jcesarmobile Date: Thu, 27 Jun 2024 10:39:19 +0200 Subject: [PATCH 1/2] docs(contributing): Use pnpm to install --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f875180..0cd8238a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ This guide provides instructions for contributing to this Capacitor plugin. 1. Install the dependencies. ```shell - npm install + pnpm install ``` 1. Install SwiftLint if you're on macOS. From 6879d7f660089df6dd0e6a78b98005330c5813f6 Mon Sep 17 00:00:00 2001 From: Joseph Pender Date: Mon, 24 Nov 2025 15:14:07 -0600 Subject: [PATCH 2/2] Updating references to npm --- CONTRIBUTING.md | 16 +++------------- packages/capacitor-plugin/CONTRIBUTING.md | 18 ++++-------------- 2 files changed, 7 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cd8238a..74ffa3d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ This guide provides instructions for contributing to this Capacitor plugin. ### Scripts -#### `npm run build` +#### `pnpm run build` Build the plugin web assets and generate plugin API documentation using [`@capacitor/docgen`](https://github.com/ionic-team/capacitor-docgen). @@ -29,24 +29,14 @@ It will compile the TypeScript code from `src/` into ESM JavaScript in `dist/esm Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This file is used in apps without bundlers by including it as a script in `index.html`. -#### `npm run verify` +#### `pnpm run verify` Build and validate the web and native projects. This is useful to run in CI to verify that the plugin builds for all platforms. -#### `npm run lint` / `npm run fmt` +#### `pnpm run lint` / `pnpm run fmt` Check formatting and code quality, autoformat/autofix if possible. This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation. - -## Publishing - -There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run: - -```shell -npm publish -``` - -> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it. diff --git a/packages/capacitor-plugin/CONTRIBUTING.md b/packages/capacitor-plugin/CONTRIBUTING.md index 3f875180..74ffa3d1 100644 --- a/packages/capacitor-plugin/CONTRIBUTING.md +++ b/packages/capacitor-plugin/CONTRIBUTING.md @@ -10,7 +10,7 @@ This guide provides instructions for contributing to this Capacitor plugin. 1. Install the dependencies. ```shell - npm install + pnpm install ``` 1. Install SwiftLint if you're on macOS. @@ -21,7 +21,7 @@ This guide provides instructions for contributing to this Capacitor plugin. ### Scripts -#### `npm run build` +#### `pnpm run build` Build the plugin web assets and generate plugin API documentation using [`@capacitor/docgen`](https://github.com/ionic-team/capacitor-docgen). @@ -29,24 +29,14 @@ It will compile the TypeScript code from `src/` into ESM JavaScript in `dist/esm Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This file is used in apps without bundlers by including it as a script in `index.html`. -#### `npm run verify` +#### `pnpm run verify` Build and validate the web and native projects. This is useful to run in CI to verify that the plugin builds for all platforms. -#### `npm run lint` / `npm run fmt` +#### `pnpm run lint` / `pnpm run fmt` Check formatting and code quality, autoformat/autofix if possible. This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation. - -## Publishing - -There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run: - -```shell -npm publish -``` - -> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it.