https://github.com/webreflection/npm-dollar

A package.json scripts helper.
https://github.com/webreflection/npm-dollar

Last synced: 4 months ago
JSON representation

A package.json scripts helper.

• Host: GitHub
• URL: https://github.com/webreflection/npm-dollar
• Owner: WebReflection
• License: isc
• Created: 2018-06-06T09:16:05.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-21T17:45:11.000Z (over 2 years ago)
• Last Synced: 2024-10-16T20:03:20.411Z (almost 2 years ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 22
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

```js

// 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

```sh

# 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](https://chocolatey.org/install) and then do `choco install git` to be able to use `bash` with, or without, the git shell.