x
/
js-generator-openstack
Code Issues Proposed changes
RETIRED, Yeoman Project Management template for JavaScript Projects.
39 Commits 1 Branch 4 Tags 790 KiB
Go to file
Michael Krotscheck 36695dd8f8
Corrected unit test in gerrit prompt(). 
The method was testing the init() method, not the prompt() method.
This corrects the test.

Change-Id: Id26e386aa3d6be0eb7d4778cf068679fec01426b
 		2016-05-20 11:28:09 -07:00
generators/app Consistent function spacing. 2016-05-20 10:48:59 -07:00
spec Corrected unit test in gerrit prompt(). 2016-05-20 11:28:09 -07:00
.editorconfig Updates from generator-generator 2016-03-22 04:24:04 -07:00
.eslintignore Corrected istanbul.yml config to put reports in /cover 2016-03-29 11:07:04 -07:00
.eslintrc Eslint support 2016-03-29 08:33:23 -07:00
.gitignore Added .gitignore creation 2016-03-29 10:59:06 -07:00
.gitreview Corrected .gitreview 2016-05-11 18:13:55 +00:00
.istanbul.yml Corrected istanbul.yml config to put reports in /cover 2016-03-29 11:07:04 -07:00
.travis.yml Updated travis options 2016-03-22 07:33:41 -07:00
.yo-rc.json Removed "How to apply" section from LICENSE 2016-03-29 10:58:06 -07:00
LICENSE Removed "How to apply" section from LICENSE 2016-03-29 10:58:06 -07:00
README.md Added TODO list to README 2016-03-30 04:23:35 -07:00
package.json Changed .gitreview 2016-05-09 15:32:17 -07:00

README.md

generator-openstack

generator-openstack is OpenStack's JavaScript project templating and maintenance engine. It permits you to:

  1. ...create a new OpenStack JavaScript project.
  2. ...update an existing project with new settings, requirements, and tools.

Quick Start

Creating and updating a project follows the exact same steps:

  1. Prerequisites: nodejs, npm
  2. npm install -g yo generator-openstack
  3. cd my_project_directory
  4. yo openstack

The generator also provides a non-interactive mode: yo openstack --non-interactive

Contributing

This project uses itself as a code management tool. In order to set up your environment for development, please follow these steps:

  1. Prerequisites: nodejs, npm, git, git review
  2. npm install -g yo
  3. git clone git://git.openstack.org/openstack/js-generator-openstack
  4. cd js-generator-openstack
  5. npm install
  6. git review -s

This should set up your project directory and make it ready for development.

Some useful development commands

  • npm link - Link this project into your global npm runtime. This allows you to run the project (via yo openstack) as if it was installed via npm install -g
  • npm test - Run all the tests.
  • npm run lint - Perform a linting check.

TODO List

Looking for something to add? Here's a quick checklist:

  • Prompt user for the project name, and make it accessible to all submodules.
  • Choose the type of project they'd like to generate: Library, Web UI, or CLI Node App
    • Basic project setup for these different types will also be needed.
  • package.json creation and maintenance
  • Ensure that license is persisted into package.json
  • dependency propagation from global requirements
  • CLI documentation for --non-interactive

Project Resources