arshadkazmi42 / strmat

Node plugin for string formatting like python

strmat

Node plugin for string formatting with dynamic values like python

Install

npm install strmat

or

yarn add strmat

Usage

const Strmat = require('strmat');

const string = 'This will {0} using dynamic {1}';
const values = ['format', 'queries'];
const formattedString = Strmat.format(string, values);

// Output:
// This will format using dyamic queries


const string = 'This will {firstKey} using dynamic {secondKey}';
const values = {
  'firstKey': 'format',
  'secondKey': 'queries'
};
const formattedString = Strmat.format(string, values);

// Output:
// This will format using dyamic queries


const string = 'This will not use dynamic values';
const values = {};
const formattedString = Strmat.format(string, values);

// Output
// This will not use dynamic values


const string = 'This will not use dynamic values';
const values = [];
const formattedString = Strmat.format(string, values);

// Output
// This will not use dynamic values


const string = undefined;
const values = ['format'];
const formattedString = Strmat.format(string, values);

// Output
// undefined

Contributing

Interested in contributing to this project? You can log any issues or suggestion related to this library here.

Read our contributing guide to get started with contributing to the codebase.

strmat's Issues

Change to replace all

Currently the libray replaces only the first occurence of the placeholder.

But we need it to support replace all the occurences.

For this there should be a chane at this line

https://github.com/arshadkazmi42/strmat/blob/master/index.js#L15

To use regex with g to replace all.

fix vulnerability

• Delete package-lock.json
• Run npm install
• Commit package-lock.json
• Create pull request

add badges

You can refer flip-remote (README) for list of badges

Change github workflow to trigger on PR

Change this line

https://github.com/arshadkazmi42/strmat/blob/master/.github/workflows/nodejs.yml#L3

similar to these lines

https://github.com/gh-conf/rhof/blob/master/.github/workflows/nodejs.yml#L3-L5

Fix vulnerability issue

Change travis to github workflow

Remove contributors section from README.md file

Github shows the contributors list on right side bar, so we don't need to maintain it in our README file.

Lets remove the contributors section completely from the README.md file

Release v1.1.0