@j2inn/podify

Podify

Build your TypeScript/JavaScript module into a POD file!

Guide

Install the module into your project...

npm install @j2inn/podify --save-dev

By default, podify attempts to use your module's package.json file to create a POD file. To try it out run...

npx podify

Some things to note...

• The POD file's name, version and description uses your module's package.json name, version and description.
• The POD file is generated in a dist sub-directory in your project.
• Your project's dist folder is included in the POD file.

Configuration

The default settings might not be to everyone's test. To customize the settings generate a pod.config.js file in your project...

npx podify --init

This generates a JavaScript file with your project's default parameters that can be customized further. This file will be automatically detected when running podify.

A pod.config.json configuration file is also supported.

POD Configuration Properties

By pod.config.js and pod.config.json support the following properties...

• name: The name of your POD file. This should end with 'Ext'. By default converted from package.json.
• version: The POD file's description. By default converted from package.json.
• description: The POD file's description. By default converted from package.json.
• organization: An object with an organization's name and url properties.
• destination: The destination folder where the POD file is generated.
• folders: An array of objects with localPath for the local path and podPath for the directory in the POD file.

Base path

By default, podify runs against your current working directory. To use an alternate working directory, please specify a path...

npx podify --path /foo/bar

FAN_HOME

If your FAN_HOME environment variable is defined (and the directory exists), the POD will be additionally copied over to ${FAN_HOME}/lib/fan.