@js4cytoscape/cyannotation-cx2js
v0.8.4
Published
Renders Cytoscape Desktop annotations from CX files via cytoscape.js-canvas
Downloads
5
Keywords
Readme
cx-annotation2js
Convert Cytoscape Desktop Annotations to cytoscape.js.
Builds off of cytoscape-canvas. A cytoscape.js extension to render a canvas over/under a Cytoscape.js graph.
Run targets
npm run build
: build projectnpm run build-prod
: build the project for productionnpm run clean
: clean the projectnpm run watch
: watch mode (debug mode enabled, autorebuild, autoreload)npm test
: run testsnpm run lint
: lint the project
Testing
All files /test
will be run by Mocha. You can npm test
to run all tests, or you can run mocha -g specific-test-name
(prerequisite: npm install -g mocha
) to run specific tests.
Chai is included to make the tests easier to read and write.
Publishing a release
- Make sure the tests are passing:
npm test
- Make sure the linting is passing:
npm run lint
- Bump the version number with
npm version
, in accordance with semver. Theversion
command innpm
updates bothpackage.json
and git tags, but note that it uses av
prefix on the tags (e.g.v1.2.3
). - For a bug fix / patch release, run
npm version patch
. - For a new feature release, run
npm version minor
. - For a breaking API change, run
npm version major.
- For a specific version number (e.g. 1.2.3), run
npm version 1.2.3
. - Push the release:
git push origin --tags
- Publish to npm:
npm publish .