npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hedo

v1.1.2

Published

Yet another here doc implementation using template literals

Downloads

4

Readme

hedo

npm license maintenance

Yet another here doc implementation using template literals.

Example

Consider phlebas.js:

// phlebas.js

const hedo = require('hedo')

const phlebas = hedo(`
            IV. Death by Water

    Phlebas the Phoenician, a fortnight dead,
    Forgot the cry of gulls, and the deep sea swell
    And the profit and loss.
                          A current under sea
    Picked his bones in whispers. As he rose and fell
    He passed the stages of his age and youth
    Entering the whirlpool.
                          Gentile or Jew
    O you who turn the wheel and look to windward,
    Consider Phlebas, who was once handsome and tall as you.
`)

console.log(phlebas)

Running this script will give the following result:

nn@Arkady:~$ node phlebas.js
        IV. Death by Water

Phlebas the Phoenician, a fortnight dead,
Forgot the cry of gulls, and the deep sea swell
And the profit and loss.
                      A current under sea
Picked his bones in whispers. As he rose and fell
He passed the stages of his age and youth
Entering the whirlpool.
                      Gentile or Jew
O you who turn the wheel and look to windward,
Consider Phlebas, who was once handsome and tall as you.

nn@Arkady:~$ ▮

Preserving Some Indentation

Suppose you want to preserve some level of indentation. To do so, specify a number as either the first or second argument to hedo. The given number of spaces will be preserved:

// preserve.js

const hedo = require('hedo')

const metasyntatic = hedo(4, `
            foo
              bar
                baz
              bat
            quz
`)

console.log(metasyntatic)

Four spaces of indentation will be preserved:

nn@Arkady:~$ node preserve.js
    foo
      bar
        baz
      bat
    quz

nn@Arkady:~$ ▮

Tagged Templates

hedo is also usable as a template tag:

hedo`
  foo
    bar
    baz
`

In this form, space can be preserved like this:

hedo(2)`
  foo
    bar
    baz
`

Newlines in Interpolated Variables

Most importantly, the tagged form of hedo handles newlines in interpolated variables gracefully. For example:

// inter-a.js

const hedo = require('hedo')

const example = "a\n  b\nc\n"
const inter = hedo`
  foo
    bar
    ${example}
  baz
`
console.log(inter)

Will produce:

nn@Arkady:~$ node inter-a.js
foo
  bar
  a
    b
  c
bat

nn@Arkady:~$ ▮

Conversely, with the standard form of hedo:

// inter-b.js

const hedo = require('hedo')

const example = "a\n  b\nc\n"
const inter = hedo(`
  foo
    bar
    ${example}
  baz
`)
console.log(inter)

Will produce mangled output:

nn@Arkady:~$ node inter-b.js
foo
  bar
  a
  b
c
bat

nn@Arkady:~$ ▮

Installation

npm install hedo

License

Available under the terms of the MIT license.

Copyright 2022 nn / @0E9B061F