heredoc
v1.3.1
Published
multiline strings for javascript
Downloads
2,328
Readme
heredoc
multiline strings for javascript
usage
this technique takes advantage of Function.prototype.toString()
var heredoc = require('heredoc')
var str = heredoc(function () {/*
within this comment block,
any text
will
be
treated
as
pre-formatted
multiline text
(kinda like html <pre>)
*/})
console.log(str)
You can also strip leading indentation:
var text = heredoc.strip(function() {/*
<body>
<p>indented strings are fine.</p>
<p>the preceding spaces will be shrinked.</p>
</body>
*/})
will result in:
<body>
<p>indented strings are fine.</p>
<p>the preceding spaces will be shrinked.</p>
</body>
AMD
heredoc
defines itself as an AMD module for use in AMD environments.
installation
$ npm install heredoc
testing
Install all dependencies:
$ npm install
$ npm test # run tests in node
$ npm run test-browser # start a server to run tests in browser
$ open http://localhost:5000/test/runner.html
contributors
- jden [email protected]
- Jason Kuhrt [email protected]
- Guy Bedford [email protected]
- Jake Chen [email protected]
kudos
thanks to @izs - I first saw this technique when reading through npm source. I find it to be much neater than lots of manual string concatenation.
license
ISC