appc-npm

Appcelerator NPM Distribution

Package components for Appcelerator Titanium, Alloy and Arrow projects for distribution and dependency via NPM.

• Browse Appcelerator Components on NPM

NOTE: Running appc-npm <type> for your component only updates/adds a package.json and appc-npm postinstall executable. It adds no dependencies and does not change your code.

Install

$ [sudo] npm install -g appc-npm

Package & Publish

Simply navigate to your Titanium module or library, Alloy widget, sync adapter, Arrow connector or other component and run the CLI with the command for that component:

$ cd mywidget

$ appc-npm widget
+ alloy-widget-myWidget@1.0.0

$ npm publish
+ alloy-widget-myWidget@1.0.0

Use

Create or update the package.json for your project:

{
	...
	"dependencies": {
		"alloy-widget-myWidget": "1.0.0"
	}
}

Install the dependencies:

$ npm install

> alloy-widget-myWidget@1.0.0 postinstall /Users/fokkezb/myProject/node_modules/alloy-widget-myWidget
> node ./appc-npm

alloy-widget-myWidget@1.0.0 node_modules/alloy-widget-myWidget

After which you'll find the widget in:

./app/widgets/myWidget

Nested dependencies

You can add dependencies to other Appcelerator dependencies on NPM to the package.json of your packaged component. So if your Alloy widget depends on a library, module or other widget then you can install them all in one go.

$ npm install

> alloy-widget-myWidget@1.0.0 postinstall /Users/fokkezb/myProject/node_modules/alloy-widget-myWidget
> node ./appc-npm

> appc-lib-xp.ui@1.0.0 postinstall /Users/fokkezb/myProject/node_modules/alloy-widget-myWidget/node_modules/appc-lib-xp.ui
> node ./appc-npm

alloy-widget-myWidget@1.0.0 node_modules/alloy-widget-myWidget
├── appc-lib-xp.ui@1.0.0

After which you'll find the widget and the lib it depends on in:

./app/widgets/myWidget
./app/lib/xp.ui.js

Update

Run the command again to update the packaged installer, update the version (for components like Alloy widgets) and add missing files to copy.

$ appc-npm widget
+ alloy-widget-myWidget@1.0.1

Commands/Types

You can use the following commands or types of components:

widget

Alloy Widgets. Uses widget.json to populate the package.json, ignores that same file for the installer and uses alloy-widget-<id> as the package name.

• Browse Alloy widgets on NPM

sync

Alloy sync adapters. Searches for the first .js and uses alloy-sync-<filename> as the package name and 1.0.0 for the version. All other files are ignored for the installer.

• Browse Alloy sync adapters on NPM

lib

Titanium, Alloy or Arrow CommonJS libraries. Searches for the first .js and uses alloy-sync-<filename> as the package name and 1.0.0 for the version. All other files are ignored for the installer.

• Browse Appcelerator libraries on NPM

block

Arrow post or pre-blocks. Searches for the first .js to determine the base path and adds that file to the list of paths to copy to the project. The default package name is arrow-block-<filename> and version is 1.0.0.

• Browse Arrow blocks on NPM

TODO: module

Titanium modules. Searches for the most recent ZIP file and adds that file to the files field of the package.json so that only that file and our installer will be published to NPM. It also reads the manifest to use in the default package, which is ti-module-<id>, and for the version.

TODO: connector

Arrow connectors. Searches for appc.json to determine the base path and adds that same directory to the list of paths to copy. The existing package.json is updated with the postinstall script and appc-npm property containing the list of paths.