0.1.0 • Published 7 years ago
@daern91/build-actions v0.1.0
build-actions
A small library to diff Customers and build update actions.
Installation
Required Tools and Dependencies
- Node (This project uses the current LTS node version, which is
v8.9.4
)
Setup (git)
Execute these commands in the project's root directory:
git clone https://github.com/daern91/build-actions.git
- Clone the git repocd build-actions/
- Move into package foldernpm i
- Install all dependencies
CLI Usage
npm run generate-data
- Generate a data.json file with test customers.- Duplicate the data.json file and change some of the customer info in the new copy, e.g.
email
. buildactions import --file testCustomers/<newFileName.json>
Setup (npm)
npm install @daern91/build-actions
Usage
const buildActions = require('@daern91/build-actions');
const actions = buildActions(oldCustomerObject, newCustomerObject);
// Output should be an array of update actions
NOTE: You may also use CLI by installing package globally with npm install @daern91/build-actions -g
Tests
npm test
for full testing including lint.npm run cover
for full testing including coverage.
Requirements
- Setup the project in a github repository
- Export
buildActions
function - Create test data generator
- Write a CLI (matching with ID instead of name)
- Provide JSDoc
- Tests
- Lint
- README
- Use ES6
- TravisCI
- Cucumber features for CLI integration tests (provided that you did the advanced part)