Developing the library

Testing

Call 'ng test' to run the tests with Karma and a headless Chrome. Tests results will be written to ./test-results/

Working with this library

To use the library within another node module, you need to build, pack, and deploy the library into our artifactory. To do this, you first have to login to the artifactory via npm login. This has to be done only once. Afterwards by calling ./gradlew npmPublishToArtifactory the library will be built, packed and deployed to our artifactory. The deployed library will be automatically named using the following schema: fs-spartacus-common-%VERSION-snapshot-%TICKETID.%TIMESTAMP.tgz

Example: fs-spartacus-common-0.0.1-snapshot-spart-24.20200622171615.tgz

To use the newest deployed snapshot version belonging to your ticket, add the following line to the package.json file of the storefront and any other module:

"dependencies": {
    ...,
    'fs-spartacus-common": "^0.0.1-snapshot-spart-24"
}

Publishing the library

The library will be automatically published to the npmjs.org registry everytime we run the release plan.

Link to our library on npmjs.org: https://www.npmjs.com/package/fs-spartacus-common