tabstops

JavaScript library and API for parsing, compiling and rendering snippets with tabstops.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm (requires Node.js >=8):

$ npm install --save tabstops

Usage

const TabStops = require('tabstops');

// pass a string as the first argument 
const tabstops = new Tabstops('console.log("$1");');

console.log(tabstops.render()); //=> 'console.log("");'

tabstops.set(1, 'It worked!');
console.log(tabstops.render()); //=> 'console.log("It worked!");'

tabstops.set(2, 'Warning!');
console.log(tabstops.render()); //=> 'console.log("Warning!");'

Docs

WIP - docs are on the way!!!

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.8.0, on July 24, 2019.