Chops-suey

Chops-suey replaces a string that contains a single or more words within double curly braces (ex. {{bread}}) with a given object's properties values (the property names must be the same as the words within the curly braces).

Usage

The app is using ts-node to run typescript projects.

The chops method won't work if both or one of the parameters are missing or in an incorrect format.

To run the app use the following command: npx ts-node lib/index.ts

Example

const dataset = {
  hobby1: "video games",
  hobby2: "beer"
}
const template = "I love {{hobby1}} and {{hobby2}}.";
chops(template, dataset);

// result
// I love video games and beer.

Installation

clone the repository and run npm install or alternatively npm i chops-suey

Tests

Tests can be run with the following command npm test

CI/CD

There's 2 GitHub Workflow Actions set up for the project.

One runs tests when a PR is created.

The second one publishes the project to npm.

In order to successfully publish the project, the version in package.json must be changed.