This Extension Pack for an Atomist SDM integrates Checkstyle, a static analysis tool for Java.
$ npm install @atomist/sdm-pack-checkstyle
import { checkstyleSupport } from "@atomist/sdm-pack-checkstyle";
sdm.addExtensionPack(checkstyleSupport({
enabled: true,
checkstylePath: "<path to a downloaded checkstyle-VERSION-all.jar>",
}));
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 will need to install [node][] to build and test this project.
To run tests, define a GITHUB_TOKEN to any valid token that has repo access. The tests will create and delete repositories.
Define GITHUB_VISIBILITY=public if you want these to be public; default is private. You'll get a 422 response from repo creation if you don't pay for private repos.
Command | Reason |
---|---|
npm install |
install all the required packages |
npm run build |
lint, compile, and test |
npm run lint |
run tslint against the TypeScript |
npm run compile |
compile all TypeScript into JavaScript |
npm test |
run tests and ensure everything is working |
npm run clean |
remove stray compiled JavaScript files and build directory |
To create a new release of the project, update the version in
package.json and then push a tag for the version. The version must be
of the form M.N.P
where M
, N
, and P
are integers that form the
next appropriate semantic version for release. The version
in the package.json must be the same as the tag. For example:
$ npm version 1.2.3
$ git tag -a -m 'The ABC release' 1.2.3
$ git push origin 1.2.3
The Travis CI build (see badge at the top of this page) will publish the NPM module and 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.
Created by Atomist. Need Help? Join our Slack team.