❤
npm
Sign UpSign In

heredoc

1.3.1 • Public • Published

heredoc

multiline strings for javascript

js-standard-style Circle CI

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

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

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.3.1
    658
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.3.1
    658
  • 1.3.0
    1
  • 1.2.0
    3
  • 1.1.0
    12
  • 1.0.0
    2

Package Sidebar

Install

npm i heredoc

Repository

github.com/jden/heredoc

Homepage

github.com/jden/heredoc

Weekly Downloads

676

Version

1.3.1

License

ISC

Last publish

Collaborators

    Try on RunKit
    Report malware