ember-addon-genie
v0.2.0Ember Addon Genie
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.
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-chrome
- Setup TravisCI to run your tests with Chrome instead of PhantomJS
genie-coverage
- Setup ember-cli-code-coverage
- 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 runember g genie-coverage
- 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
Get Your CodeClimate Token
Create a CodeClimate account for your github repo
Grab your
CODECLIMATE_REPO_TOKEN
from Settings --> Test Coverage --> JavaScriptYou will see something along the lines of:
CODECLIMATE_REPO_TOKEN=<YOUR_REPO_TOKEN> codeclimate-test-reporter < lcov.info
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
)
- A prompt will ask you to enter a comma separated list of Ember versions you want to create scenarios for (ex.
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
genie-changelog
- Setup ember-release to update the changelog with the latest commits
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
- Config is setup so docs will be present in production mode. This means that when you run
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.
Commands
genie:changelog
Generate a changelog in markdown by comparing the given version to the given branch of a repo.
Available Options
user
: The repo user or org. Defaults to your current git usernamerepo
: The repo name. Defaults to your current project's nameversion
: The version to be compared with the branch. Defaults to your current repo's versionnew-version
: The new version. This is used to title the changes when written to filebranch
: The branch to compare with the version. Defaults to 'master'write
: If set to true will write tofile
. Defaults falsefile
: Path to changelog file. Defaults to 'CHANGELOG.md'
ember genie:changelog --user=ember-cli --repo=ember-cli --version=2.6.0 --branch=master --write=true --file=CHANGELOG.md
Metadata
- MIT
- >= 0.10.0
- Offir Golan
- released 12/17/2018