This Rug project contains Atomist Rug archive project
The AddLocalEditor editor adds an editor for modifying the local project, initiating a Rug archive if needed.
A source code project.
This Rug takes following parameters.
| Name | Required | Default | Description |
|---|---|---|---|
editorName |
Yes | Name of the editor to add, it should start with a capital letter and contain only alphanumeric characters | |
description |
No | "an editor for modifying this project" | A short description of what the editor will do |
Run this Rug as follows:
$ cd project/directory
$ rug edit atomist-rugs:rug-tutorials:AddLocalEditor \
editorName=MyLocalEditor \
description='does something useful'
This will add a Rug editor as .atomist/editors/MyLocalEditor.ts. If
the project is currently set up for Atomist, it will also create the
.atomist directory with appropriate initial contents like the
manifest.yml and package.json files.
sample Rug TypeScript editor
Put your editor prerequisites here.
This Rug takes following parameters.
| Name | Required | Default | Description |
|---|---|---|---|
inputParameter |
Yes | Example input parameter |
Run this Rug as follows:
$ cd project/directory
$ rug edit atomist-rugs:rug-editors:MyFirstEditor \
inputParameter='some value'
Explain what your editor does here.
General support questions should be discussed in the #support
channel on our community Slack team
at atomist-community.slack.com.
If you find a problem, please create an issue.
You can build, test, and install the project locally with the Rug CLI.
$ rug test
$ rug install
To clean up cached files and update TypeScript dependencies, run this command.
$ ( cd .atomist && find editors generators handlers tests -name '*.js' -print0 | xargs -0 rm; rm -rf node_modules; npm install && rug clean )
To create a new release of the project, simply push a tag of the form
M.N.P where M, N, and P are integers that form the next
appropriate semantic version for release. For example:
$ git tag -a 1.2.3
The Travis CI build (see badge at the top of this page) will automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes. It will also automatically upload the needed artifacts.
Created by Atomist. Need Help? Join our Slack team.