/ember-addon-genie

Interactive blueprints for setting up an addon with a build, ember-try. release to gh-pages, and docs

Primary LanguageJavaScriptMIT LicenseMIT

Ember Addon Genie

npm version Build Status

Blueprint for setting up an addon with a build, ember-try scenarios, code coverage, and documentation via YUI

Installation

ember install ember-addon-genie

Looking for help?

If it is a bug please open an issue on GitHub.

Blueprints

When you first install ember-addon-genie or run the default blueprint via ember g ember-addon-genie you will get the following prompt to select which components you want to include in your addon.

prompt

Note: All items are already pre-selected, press SPACE to deselect and ENTER to continue

genie-init

  • Takes your selected options and installs the correct packages
  • Modifies package.json to add some missing information such as repo details, author, and demoURL

genie-init

genie-chrome

  • Setup TravisCI to run your tests with Chrome instead of PhantomJS

genie-coverage

  • Setup ember-cli-blanket
  • Setup CodeClimate for code coverage reporting integration with TravisCI
    • A prompt will ask you for your CodeClimate repo token, if you don't have it, just press ENTER and you can modify it later in your .travis.yml or run ember g genie-coverage

Get Your CodeClimate Token

  1. Create a CodeClimate account for your github repo

  2. Grab your CODECLIMATE_REPO_TOKEN from Settings --> Test Coverage --> JavaScript

    You will see something along the lines of:

    CODECLIMATE_REPO_TOKEN=<YOUR_REPO_TOKEN> codeclimate-test-reporter < lcov.info

genie-coverage

genie-try

  • Setup ember-try scenarios with TravisCI
    • A prompt will ask you to enter a comma separated list of Ember versions you want to create scenarios for (ex. 1.13, 2.2, 2.4 2.5)

genie-try

genie-gh-pages

  • Setup ember-release to publish a new version of your addon's demo app when to the gh-pages branch when you release to NPM

Setup Github Pages

Please follow the instructions on the ember-cli-github-pages README to setup your gh-pages branch

genie-gh-pages

genie-changelog

  • Setup ember-release to update the changelog with the latest commits via ember-cli-changelog

genie-docs

  • Setup YUIDoc via ember-cli-yuidoc
    • Config is setup so docs will be present in production mode. This means that when you run ember release it will publish your addon's demo page AND your updated docs to the gh-pages branch

Usage

To view your docs you will need to use

ember serve --docs

Once your server is ready, navigate to localhost:4200/docs and you should see all your YUIDoc defined classes and modules.

genie-try