npm-dollar

A package.json scripts helper.

New in V2

npm-dollar is now super greedy in exiting the execution as soon as something goes wrong.

wut

It simplifies organization of package.json scripts using bash, instead of sh, and passing escaped arguments all along.

Following a configuration example:

// inside the package.json file
{
  "devDependencies": {
    "npm-dollar": "latest"
  },
  "scripts": {
    "$": "npm-dollar"
  },
  "$": {
    "cat": {
      "some": "cat $1"
    },
    "lint": {
      "js": [
        // single line bash comments are allowed too
        "# !production is needed to avoid issue in CI",
        "!production eslint index.js"
      ]
    },
    "bash": {
      "ls": "ls"
    },
    "complex": [
      // each entry is joined as &&
      "export TEST=123",
      "echo $TEST",
      // arrays per line are joined via space
      [
        "ls $TEST;",
        "cat $TEST"
      ]
    ]
  }
}

This is how you'd use those scripts

# regular execution
npm run $ cat.some file.js

# or passing along all arguments
npm run $ -- bash.ls -la

# or skipping production
npm --production run $ lint

When either --production, --prod, or --only=production and --only=prod npm flags are used, any command that start with either !prod or !production (read as not production) would simply be ignored.

The End.

Windows users

As long as there is a bash environment you should be good to go (WLS, Git for Windows, others).

If not, consider installing chocolatey and then do choco install git to be able to use bash with, or without, the git shell.