commit | 0c330a11b30dc2ab093689c523ebfc129ecfdb4e | [log] [tgz] |
---|---|---|
author | Shazron Abdullah <shazron@apache.org> | Fri Aug 26 11:38:38 2016 -0700 |
committer | Shazron Abdullah <shazron@apache.org> | Fri Aug 26 11:38:38 2016 -0700 |
tree | ee4ca4337738bc6c32367ead120b8ba209769de8 | |
parent | 97081b674b922f1309671d48c26200aca079a6d7 [diff] |
CB-11773 - Add licenses missing found by audit-license-headers
This is a reference for building and publishing Cordova Templates.
template_package ├── package.json (for your template package to be published on npm) ├── index.js └── template_src (contains template files) ├── package.json ├── config.xml └── (files and folders that make up the template)
template_src
All files outside of template_src
are used to define parameters about the template. These files are not copied over at creation, so feel free to add a README or any other files outside of template_src.
index.js
points to where the template exists. You'll see that index.js usually looks like:
var path = require('path'); module.exports = { dirname : path.join(__dirname, 'template_src') };
package.json
tells you about the template. It is necessary state that "main": "index.js"
so that the reference to the template source in index.js
is propagated. All templates should contain the keyword "cordova:template"
so that the template is searchable on npm.
... "main": "index.js", ... "keywords": [ "cordova:template" ...
template_src
All files inside of template_src
compose the template from which a user would desire in order to create their project. Everything in this folder is copied over to the created project.
(The package.json in template_src
should be filled with information that describes the project that would be created from the template.)