@interaktiv/ti-plugin-install

Utility that automates Appcelerator Titanium CLI plugins installation.

This Solution

Utility that automates Appcelerator Titanium CLI plugins installation.

Table of Contents

• Installation
• Usage
  • CLI Usage
  • Module Usage
• Other Use Cases
• Acknowledgements
• License

Installation

This module can be installed via npm which is bundled with Node.js and should be installed as one of your project's dependencies:

npm install -D @interaktiv/ti-plugin-install

It can also be installed as a global package.

Usage

CLI Usage

To install a plugin that is installed as a npm package in the project directory just use:

ti-plugin-install --plugin <YOUR_PLUGIN_ID>

# e.g.

ti-plugin-install --plugin generic-ti-plugin

# Add the plugin into the tiapp.xml plugins section by running

ti-plugin-install --plugin generic-ti-plugin --update-tiapp

# Additionally we can run the CLI for another directory by passing the project
# directory to the command

ti-plugin-install --plugin generic-ti-plugin --project-dir <MY_GREAT_APP>

Module Usage

For programmatically access the module exposes different methods:

import { run, runCli } from '@interaktiv/ti-plugin-install';

// By default the `run()` method parses `process.argv` to get the
// params but you can provide an custom argv array directly to it
const argv = [
  '--project-dir',
  'MY_GREAT_APP',
  '--plugin',
  'generic-ti-plugin',
  '--update-tiapp',
];

await run(argv);

// With run CLI we can directly provide the configuration with argv usage

const config = {
  projectDir: 'MY_GREAT_APP',
  plugin: 'generic-ti-plugin',
  updateTiapp: true, // Defaults to false
};

await runCli(config);

Other Use Cases

If you lack some use cases, you are welcome to open a pull request and add it. We'll come back to you and see how we can support your use case and present it to all devs.

Please consult the contribution guides before contributing.

Acknowledgements

This library is heavily inspired by ti-plugin-install. Thank you 💚

License

MIT Copyright © 2020-present die.interaktiven GmbH & Co. KG