@adobe/commerce-cif-common v1.0.0
Commerce Integration Framework - common module for all implementations
CIF REST Common module implementation contains the common actions that will be used by customers to sequence their actions and common code useful for any implementation.
Currently one action is implemented: src/web-action-transformer
.
The common code consist from validators, exceptions, utils etc.: src/shared
Getting Started
To install all npm dependencies and bootstrap lerna, simply run:
npm install
Note: npm dependencies are managed with lerna lerna.
Testing
For testing, each package is configured to perform a static code analysis using ESLint as well as executing Mocha unit tests. For unit tests, chai.js is used for assertions and sinon.js can be used for mocking. We use istanbul.js to collect testing code coverage.
To run linting, tests and coverage analysis, run npm test
in the root folder.
Deployment
Deployment instructions are available in the repository specific to each CIF REST integration.
Contributing
Contributions are welcomed! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.