pronpush-plugin-compiler v1.0.2

pronpush-plugin-compiler

Compile your PronPush Plugins the easy way

Installation

Simply install as a global package using npm

npm install -g pronpush-plugin-compiler

Usage/Commands

The compiler comes with an interactive shell that you can start by this command:

pronpush-plugin-compiler

You then get some information about the base configuration aswell as a help command

Configuration

Configuration is split into META and COMPILER

You can view your current configuration at any time by just entering config

META

Updating META configs works using the set <property> <value> command:

ppc@version ~$ set author John Doe
ppc@version ~$ set package_name my-first-plugin

COMPILER

Updating COMPILER, therefore source and target property, is done using both source <file> and target <file> commands:

ppc@version ~$ source ./my-folder/plugin.js
ppc@version ~$ target ./plugin.ppp

Both commands directly check whether the paths are available/valid and notify you about the results.

Compiling

Before compiling, you should check whether your configuration is complete and not missing any required parameters.

If you enter check, the module provides you with information about missing properties or a message telling you that you are ready to compile

To compile your plugin to the target path, just use the compile command:

ppc@version ~$ compile

To avoid errors, compile internally checks whether your configuration is complete before actually compiling your plugin.

Important notes

The compiler does NOT (yet)

• Lint your code
• Run your code
• Sign your code Linting and signing are done at Runtime in the PronPush client.

A Documentation for available APIs in a plugin will follow soon.