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

de-heredoc

v0.0.5

Published

Transform "heredoc call" to "string literal" in JavaScript source code before minifications

Downloads

3

Readme

#de-heredoc Transform "heredoc call" to "string literal" in JavaScript source code before minifications.

Install

$ npm install de-heredoc

Usage

heredoc is a function to make multiline strings in JavaScript, there are already some libraries you can use e.g. heredoc and multiline.

$ cat test.js
var heredoc = require("heredoc");
var html = heredoc(function(){/*
    <div id="test">
        <span>foo</span>
        <span>bar</span>
    </div>
*/});
$ node
> var deHeredoc = require("de-heredoc")
> deHeredoc("test.js")
(^C again to quit)
>
$ cat test.js
var html='<div id="test">\n    <span>foo</span>\n    <span>bar</span>\n</div>';

Options

deHeredoc(file[, options])

options has 4 properties, from dependency beautify and whitespace.

from

Control file's type.

"file" (default)

file is a file path, change this file in place and return undefined. If the value of from is "file", then the file parameter can be an array.

deHeredoc(["a.js", "b.js", "c.js"], {from: "file"})

"string"

file is a string of JS source code, return the new source code.

deHeredoc('var foo = heredoc(function(){/*foo*/})',{
    from: "string"
}) // 'var foo="foo";'

"ast"

file is an UglifyJS AST object, return the new AST object.

var ast = UglifyJS.parse('var foo = heredoc(function(){/*foo*/})')
var newAst = deHeredoc(ast, {
    from: "ast"
})
newAst.print_to_string() // 'var foo="foo";'

dependency

The heredoc library's name.

"heredoc" (default)

deHeredoc('var multiline = require("maybesomepath/multiline");' +
          'var foo = multiline(function(){/*foo*/})',{
    from: "string",
    dependency: "multiline"
}) // 'var foo="foo";'

###beautify Beautify output source code or not.

false (default)

deHeredoc('if(1+1){var foo=heredoc(function(){/*foo*/})}', {
    from: "string",
    beautify: true
}) 
/*
if (1 + 1) {
    var foo = "foo";
}
*/

###whitespace Control whitespaces in output string literals, see Whitespaces

"indent" (default), "raw" and "oneline".

deHeredoc('var foo=heredoc(function(){/*  foo   */})', {
    from: "string",
    whitespace: "oneline"
}) // 'var foo="foo";'

Whitespaces

You can use parameter name to control whitespaces in output string literals.

indent

Strip the redundant leading whitespaces, and preserve other indents.

var html = heredoc(function(indent){/*
    <div id="test">
        <span>foo</span>
        <span>bar</span>
    </div>
*/});

will be transformed to

var html='<div id="test">\n    <span>foo</span>\n    <span>bar</span>\n</div>';

raw

Preserve all whitespaces.

var html = heredoc(function(raw){/*
    <div id="test">
        <span>foo</span>
        <span>bar</span>
    </div>
*/});

will be transformed to

var html='    <div id="test">\n        <span>foo</span>\n        <span>bar</span>\n    </div>';

oneline

Remove all leading and trailing whitespaces.

var html = heredoc(function(oneline){/*
    <div id="test">
        <span>foo</span>
        <span>bar</span>
    </div>
*/});

will be transformed to

var html='<div id="test"><span>foo</span><span>bar</span></div>';

License

MIT