You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Arghyadeep Kundu 709fcd1a8d Fixed typo 12 months ago
.github Fixed typo 12 months ago
test Added jest test cases 12 months ago
.gitignore Initial commit 1 year ago
.npmignore Added jest test cases 12 months ago
README.md Added jest test cases 12 months ago
index.js Fixed issue happening for multiple items in varList 1 year ago
package-lock.json Added jest test cases 12 months ago
package.json Added jest test cases 12 months ago
sonar-project.properties Added sonar properties 1 year ago

README.md

Vanes : Format strings with placeholders (Node.js)

CI Quality Gate Status npm npm bundle size Libraries.io SourceRank Depfu Snyk Vulnerabilities for npm package npm NPM

This package can help you format your strings easily with placeholders. Comes in handy when you are importing the strings from another module.

Why Vanes?

When you're importing a string from a module, it is not possible to use $-based placeholders because the variables serving as the placeholders may not exist in the module where the strings are declared. To solve this, we came up with Vanes.

Using Vanes, you can place any keyword as your placeholder as long as you tie them in with braces (Remember: no spaces between the braces and the keyword). When you import the string in your other module, just pass that string and a comma separated key-value object where keys are the placeholders in the string and values are the variables or constants you want to replace them with.

And, voila! Vanes will return you a string with all the values replaced.

Installation

NPM

Install from command line:

npm install --save vanes

Or

Install via package.json:

Add the following to your package.json file under dependencies

"vanes": "1.0.2"

Basic Usage

const vanes = require('vanes');

let str = `Hello, {var}!`;
let value = 'World';

let result = vanes(str, {var: value});

console.log(result) 

//Output - Hello, World!

API

vanes(string, {key: value})

  • string: input string with placeholders in it

  • key: variable serving as the placeholder in the string

  • value: variable name/constant value that needs to replace the placeholder(key) in the string

Multiple key-value pairs can be sent separated by comma.

Unit Testing

Unit testing has been added as part of the latest release. To run the test case, download the package and run npm test.

License

Vanes is published under the MIT license. For more information, see the accompanying LICENSE file.




PS:

If you find this package useful, please consider giving a star to this project on Github.

And, if you are willing to buy me a coffee, that would be awesome. :)