https://github.com/arzyu/capacitor-sync-version

Syncing version from package.json to android/ios platform in the capacitor projects.
https://github.com/arzyu/capacitor-sync-version

capacitor capacitor-sync-version

Last synced: 6 days ago
JSON representation

Syncing version from package.json to android/ios platform in the capacitor projects.

• Host: GitHub
• URL: https://github.com/arzyu/capacitor-sync-version
• Owner: arzyu
• Created: 2021-07-19T11:04:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-10T09:41:44.000Z (about 3 years ago)
• Last Synced: 2024-04-24T14:09:12.717Z (7 months ago)
• Topics: capacitor, capacitor-sync-version
• Language: TypeScript
• Homepage:
• Size: 56.6 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# capacitor-sync-version

![npm package version](https://img.shields.io/npm/v/capacitor-sync-version?style=flat-square) ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green?style=flat-square)

Syncing version from package.json to target platform in the capacitor projects.

Currently supported platforms are: `[android, ios]`.

## Installation

```shell

npm add --save-dev capacitor-sync-version

```

## Additional preparation for Android only

**Step 1**. Create a file named `app.properties` in `./android/app/`, then add the following properties:

```

versionName=0.0.1

versionCode=1

```

These properties will be updated when capacitor-sync-version running.

**Step 2**. Adjust codes to referrence these properties in `./android/app/build.gradle`.

* Add the following codes after `apply plugin: 'com.android.application'`:

  ```

  def appProperties = new Properties();

  file("app.properties").withInputStream { appProperties.load(it) }

  ```

* Update properties in `defaultConfig {}` block:

  ```

  defaultConfig {

    versionCode appProperties.getProperty("versionCode").toInteger()

    versionName appProperties.getProperty("versionName")

  }

  ```

## Usage

The simplest way to use capacitor-sync-version is running it in the [capacitor hooks](https://capacitorjs.com/docs/cli/hooks).

Just adding the following script to `package.json`:

```json

{

  "scripts": {

    "capacitor:copy:before": "capacitor-sync-version"

  }

}

```

In this way, capacitor-sync-version will be run before capacitor copy command, e.g., `npx cap copy`.

Other ways to run capacitor-sync-version are:

```shell

# sync for android only

capacitor-sync-version android

# sync for both android and ios

capacitor-sync-version android ios

```

## Licence

MIT