Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/propelics/tiapp-updater
Updates the tiapp.xml file based on a JSON file configuration. Usefull for projects that require different settings for the app name, version, description, etc.
https://github.com/propelics/tiapp-updater
configuration npm tiapp titanium
Last synced: 3 months ago
JSON representation
Updates the tiapp.xml file based on a JSON file configuration. Usefull for projects that require different settings for the app name, version, description, etc.
- Host: GitHub
- URL: https://github.com/propelics/tiapp-updater
- Owner: anexinet
- Created: 2017-07-27T15:33:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T19:17:21.000Z (over 1 year ago)
- Last Synced: 2024-08-18T21:03:00.913Z (3 months ago)
- Topics: configuration, npm, tiapp, titanium
- Language: JavaScript
- Size: 15.1 MB
- Stars: 8
- Watchers: 19
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# tiapp-updater
## Introduction
For Titanium projects. Automatically updates the tiapp.xml file based on a given configguration file and an environment to load from that config file.
## Basic usage
### From CLI:
```bash
$ npm install --save-dev tiapp-updater
$ ./node_modules/js-updater/bin/jsupdater --tiapp --config --env [--save]
```
### From Node:
```javascript
var tiappUpdater = require('tiapp-updater');
newTiapp = tiappUpdater.updateTiapp({
tiapp: 'path-to-tiapp.xml',
config: 'path-to-config.json',
env: 'env-to-load',
save: true // false to prevent the tiapp.xml file to be edited
});
console.log(newTiapp);
```
## Config file and environment
The config file can be a JSON file or any JS file that returns an object.
An environment (`env`) is any first-level key loaded from the config file.
There could be an special `global` key inside the config file. If `global` is defined, the properties will be applied in cascade (`global` then `env` will replace the repeated properties).
### Example config.json
```json
{
"global": {
"appId": "com.test.generic",
"appName": "Generic Name",
"guid": "11111111-1111-1111-1111-111111111111",
"version:format": "major.minor.build",
"properties": {
"appc-app-id": "111111111111111111111111"
}
},
"dev": {
"appId": "com.test.dev",
"appName": "My App DEV",
"version:format": "major.minor.build|bump.0"
},
"test": {
"appId": "com.test.test",
"appName": "My App TEST",
"version:format": "major.minor.build.1"
},
"pre-prod": {
"appId": "com.test.preprod",
"appName": "My App PRE-PROD",
"version:format": "major.minor.build.2"
},
"prod": {
"appId": "com.test.prod",
"appName": "My App",
"guid": "22222222-2222-2222-2222-222222222222",
"version:format": "major.minor",
"properties": {
"appc-app-id": "app-id-prod"
}
}
}
```
### Properties supported
- **`appId`** modifies the `com.app.identifier` value.
- **`guid`** modifies the `App GUID` value.
- **`appName`** modifies the `App Name` value.
- **Note:** In Android, you may have an `` tag within the `` with the property `android:name`. If that's the case, this will be updated too as long as this is the **first** `activity` tag inside `application`.
- **`version:format`** modifies the version of the app following a given format, the available values for formatting are:
- **`major`** the current first value of the version (**1**.0.0).
- **`minor`** the current second value of the version (1.**0**.0).
- **`build`** the current third value of the version (1.0.**0**).
- **Any digit(s)** will just copy them in the given spot of the version (e.g. Given version `1.0.0` and format `major.minor.3` will generate `1.0.3`).
- **Functions**. Additional to the format, some function(s) could be applied with the caret character (`|`). This will generate first the value from the format, then apply the given functions from left to right. Supported functions so far:
- **`bump`** Will add 1 to the number.
- **`properties`** will add/modify the `` tag(s).
- If the given id already exists in the tiapp.xml, it will replace it.
- If the id does not exist, will create a new `property` tag.
- Note this will **not** remove `property` tags at any time.
## License
Copyright 2017 Propelics, Inc.
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.