@amigocloud/js-client v1.0.5

Development

Requirements

The following tools are necessary to start working on adding new features to the @amigocloud/js-client library

• yarn
• np

Install

For development, you need to install dependencies with the command:

yarn

For testing use:

yarn dev

To run the tests, use:

yarn test

When changes are ready, commit your changes as usual with git, husky and standardjs will take care of review and format the code as much as possible, there are cases that standardjs will complain about malformed code or not good code being used, so you will have to take a look and fix them manually.

Deploying

As a prerequisite, you will have to be logged in the npm registry, to do so, run this command:

npm login

It will ask for the username, password and email associated with the amigocloud account.

After all changes are merged and all the fixes have been done, to be able to deploy a new version of the library, you will have to use the following command:

yarn deploy

This command will take care of running the tests and prompting the user to setup the next version of the package as well. If everything is setup correctly, it will also publish the new version to npm as well as uploading the code to gitlab and create the corresponding tag with the new version, this is important so we don't break existing implementations of external parties, when they're ready to update, they will be able to opt in by running yarn upgrade @amigocloud/js-client