Skip to content

Latest commit

 

History

History
109 lines (74 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

109 lines (74 loc) · 3.31 KB
Raw

Contributing

See CONTRIBUTING.md in the Capacitor repo for more general contribution guidelines.

Developing Capacitor Plugins

Local Setup

  1. Fork and clone this repo.

  2. Install the monorepo dependencies.

    npm install

  3. Install SwiftLint if you're on macOS. Contributions to iOS code will be linted in CI if you don't have macOS.

    brew install swiftlint

Sometimes, it may be necessary to work on Capacitor in parellel with the plugin(s). In this case, a few extra steps are necessary:

  1. Follow the Capacitor repo's local setup instructions.

  2. Toggle each plugin to use your local copy of Capacitor.

    npm run toggle-local

    💡 Remember not to commit unnecessary changes to package.json and package-lock.json.

  3. Make sure your app is using local copies of the Capacitor plugin and Capacitor core.

    cd my-app/
npm install ../path/to/capacitor-plugins/<plugin>
npm install ../path/to/capacitor/core
npm install ../path/to/capacitor/android
npm install ../path/to/capacitor/ios

Monorepo Scripts

To aid in managing these plugins, this repo has a variety of scripts (located in scripts/) that can be run with npm.

npm run set-capacitor-version "<version>"

This script is for setting the version (or version range) of Capacitor packages in each plugin's package.json. It will also run lerna bootstrap for you.

npm run toggle-local

📝 Requires Capacitor to be cloned in a sibling directory.

This script is for switching between Capacitor packages from npm and Capacitor packages installed locally. It will also run lerna bootstrap for you.

If you get npm errors, you can try installing from scratch:

  1. Reset the changes in package.json files.

  2. Clear out all node_modules.

    npx lerna exec 'rm -fr package-lock.json && rm -fr node_modules'
rm -fr node_modules

  3. Install with local dependencies:

    npm run toggle-local

npm run apply-patches "<package>"

This script is for copying git changes from one plugin to all plugins.

To use:

  1. Make sure your staging area is clean, e.g. git reset
  2. Stage the changes from (and only from) your package, e.g. git add -p -- text-zoom/
  3. Run the script with <package> being the npm name of your package, e.g. npm run apply-patches @capacitor/text-zoom

Publishing Capacitor Plugins

Capacitor packages are published using Lerna with independent versioning.

During Capacitor 3 development, the following workflow is used to create dev releases:

  1. Make sure the README.md files are updated with the current API.

    • Run the doc generator.

      npx lerna run docgen

    • Commit any changes.

  2. Create the next development version. The following command will:

    • Create a release commit with a generated changelog
    • Create a git tag
    • Push to the main branch
    • Create a GitHub release

    npx lerna version

  3. Wait for CI to publish the new tagged version.