js4cytoscape is a collection of JavaScript / TypeScript libraries for processing CX, accessing NDEx API, and calling Cytoscape Desktop Automation via CyREST. These libraries are maintained by the Cytoscape Core Developer team.
This monorepo was derived from the following repositories:
All of the above are now in archived and all new features and bug fixes will be available from here.
The latest versions of these libraries are available in the following npm repository:
https://www.npmjs.com/org/js4cytoscape
For html users, add this to the <head> of your page (specify version @#.#.# or remove to get latest):
<script src="https://unpkg.com/@js4cytoscape/js4cytoscape@#.#.#/dist/main.js"></script>
For npm users:
npm install @js4cytoscape/PACKAGE-NAME
For yarn users:
yarn add @js4cytoscape/PACKAGE-NAME
Please read the documents in each package directory (TBD)
This repository uses NPM and its Workspace and you need to follow these rules to avoid accidentally add unnecessary dependencies and package-lock.json files.
To build the latest versions, please run the following commands:
git@github.com:cytoscape/js4cytoscape.git
cd js4cytoscape
git checkout develop
npm install
npm run build --workspaces
This creates new builds of all packages in your local directory. To use these builds for development, please link those using npm link command.
All dev-dependencies should be added to the project root. To add a new dev-dependency, run the following command in the root directory:
npm install PACKAGE-NAME --save-dev
If you need to add a new dependency to a specific sub-project, you should run:
npm install PACKAGE-NAME -w packages/SUBPROJECT-NAME
-
Create a new branch as a working branch.
-
Make changes in the code.
-
Update the version attribute in package.json file under that package. For dev releases, its value should be something like "0.4.3-alpha.1".
-
Push all changes to Github.
-
Build that package and release to NPM as a prerelease. For example, to publish this "0.4.3-alpha.1" release of ndex-client to NPM, run these commands
cd ndex-client npm run build npm publish --tag next -
If there are no errors in the prerelease, create a pull request from that branch and merge changes to develop branch.
-
Tag the develop branch with that prerelease using this format
package_name-vsemVerion. For example,git tag -a cx2js-v0.6.7-alpha.0 -m 'cx2js prerelease v0.6.7-alpha.0' git push origin --tags -
Delete your working branch.