jt-chops

Comments related to the task / requirements:

1. I didn't add tests for parameters' types and missing parameters, because TypeScript helps with that and gives error immediately if that's the case. *2. I am sorry, I noticed the semantic commits quite too late, so I decided to add here how they should have been here: *

docs: Add code block to repo tree 
docs: Write documentation 
refactor: remove unused import 
feat: Wrap all functions together 
refactor: Make comment clearer 
feat: Implementation of replace occurence 
refactor: Console log results for easier development process 
refactor: test: Remove unnecessary file 
refactor: test: Add more scenarios to test with 
test: Remove unnecessary test file 
feat: Function that converts an object to key-value pairs 
setup: Error handling for empty params 
setup: Add key value type for supported data 
setup: Add more todos based on task requirements 
setup: Add required packages, Add required configs, Add TODOs 
Initial commit

Description

This is a function that helps you in dealing with templating. By given template (string) and dataset (key-value pair) it finds and replaces the template keys with their corresponding value from the dataset.

Example:

const dataset1 = {
  bread: "baguette",
  cheese: "brie cheese",
};
const myTemplate1 = "I like to eat {{bread}} and {{cheese}}";

chop(myTemplate1, dataset1);
// I like to eat baguette and brie cheese. 

Repository overview

├── README.md
├── jestconfig.json
├── package-lock.json
├── package.json
├── src
│   ├── __tests__
│   │   └── obj-to-key-value-pairs.test.ts
│   ├── chop.ts
│   ├── helpers
│   │   ├── _obj-to-key-value-pairs.ts
│   │   └── _replace-occurence.ts
│   ├── index.ts
│   └── types
│       └── supported-data.type.ts
└── tsconfig.json

How to Install and Run

1. Install dependencies npm i
2. Build project npm run build
3. Run js file from /lib node ./lib/index.js