git-bash-shell

git-bash-shell

Use Git Bash as cross-platform shell for Windows

Why

• Use Git Bash as cross-platform shell for child process or npm run scripts.
• Support POSIX file path.
• Support Shebang
• Support PATHEXT
• Support Shell script

Install

npm install --save git-bash-shell

Usage

In your package.json file, you can add script prefix to compatible with Widnows: env, bash, sh, dash or $SHELL.

"scripts": {
	"git:ls-files": "git ls-files > /tmp/git-files",
	"lint:eslint": "eslint `grep \\.js$ /tmp/git-files`",
	"lint:eclint": "eclint check `cat /tmp/git-files`",
	"lint-flow": "env npm-run-all --parallel git:ls-files lint",
}

just run npm run lint-flow, and all npm scripts will work under Windows

Node API:

require('git-bash-shell')();
const spawnSync = require('cross-spawn').sync;
spawnSync('echo `git --version`', {
	shell: true,
	stdio: 'inherit',
});

Environment Variables

SHELL

• Default: /usr/bin/bash
• Type: path

POSIX specific implementations of shell path.

ComSpec

• Default: %ProgramFiles%\Git\usr\bin\bash.exe
• Type: path

The shell to use for scripts run with the npm run command. If you want to turn off SHELL feature, assign assign environment variable to cmd.exe

PATHEXT

• Default: %PATHEXT%
• Type: path list

';'-separated list of suffix to executable file search. If you want to turn off PATHEXT feature, just empty this environment variable

HOME

• Default: %USERPROFILE%
• Type: path

Directory path of ~/