# run-script-os

> run-script-os is a tool that will let you use generic npm script commands that will pass through to os specific commands.

Latest version **1.1.6** (published 2021-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install run-script-os
pnpm add run-script-os
yarn add run-script-os
bun add run-script-os
```

Provides the commands `run-os`, `run-script-os`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2021-03-24 |
| First published | 2017-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 205 |
| Author | Charlie Guse |
| Maintainers | charlesguse |

## Links

- npm: https://www.npmjs.com/package/run-script-os
- Repository: https://github.com/charlesguse/run-script-os
- Homepage: https://github.com/charlesguse/run-script-os#readme
- Issues: https://github.com/charlesguse/run-script-os/issues
- npm.io page: https://npm.io/package/run-script-os

## Recent versions

- 1.1.6 (latest) — 2021-03-24
- 1.1.5 — 2021-01-16
- 1.1.4 — 2020-12-27
- 1.1.3 — 2020-10-22
- 1.1.2 — 2020-10-22
- 1.1.1 — 2020-03-03
- 1.1.0 — 2020-03-02
- 1.0.7 — 2019-06-19
- 1.0.6 — 2019-06-19
- 1.0.5 — 2018-12-04
- 1.0.3 — 2018-01-22
- 1.0.2 — 2017-05-21
- 1.0.1 — 2017-05-21
- 1.0.0 — 2017-05-15

## README

# run-script-os

You will be able to use OS specific operations in npm scripts.

## Who would want this?
If you have experienced the pain of trying to make npm scripts usable across different operating system, this package is for you! Looking at you `rm` and `del`!

## Installation
`npm install --save-dev run-script-os`

## Usage

Set `run-script-os` (or `run-os`) as the value of the npm script field that you want different functionality per OS. In the example below, we set `test`, but it can be any npm script. It also uses `pre` and `post` commands (explained more below).

Then create OS specific scripts. In the example below, you can see:

* `test:win32`
* `test:linux:darwin`
* `test:default`

Those can have OS specific logic.

`package.json`
```
{
  ...
  "scripts": {
    ...
    "test": "run-script-os",
    "test:win32": "echo 'del whatever you want in Windows 32/64'",
    "test:darwin:linux": "echo 'You can combine OS tags and rm all the things!'",
    "test:default": "echo 'This will run on any platform that does not have its own script'"
    ...
  },
  ...
}
```

**Windows Output:**
```
> npm test
del whatever you want in Windows 32/64
```

**macOS and Linux Output:**
```
> npm test
You can combine OS tags and rm all the things!
```

### Aliases

You can use the following aliases:

* `:windows` - Alias for win32
* `:macos` - Alias for darwin
* `:nix` - This will run on anything considered to be a *nix OS (aix, darwin, freebsd, linux, openbsd, sunos, android)
* `:default` - This will run if no platform-specific scripts are found

### Override detection settings for linux-based shells on Windows

By default, run-script-os will detect cygwin/git bash as Windows. If you would rather your platform be detected as Linux under these environments:

Set environment variable:

```
RUN_OS_WINBASH_IS_LINUX=true
```

### NPM Scripts Order
When you call a script like `npm test`, npm will first call `pretest` if it exists. It will then call `test`, which, if you are using `run-script-os`, it will then call `npm run test:YOUR OS`, which in turn will call `pretest:YOUR OS` before actually running `test:YOUR OS`. Then `posttest:YOUR OS` will run, and then after that `posttest` will finally execute.

There is an example showing `pre` and `post` commands found in the [`package.json` of this repository](https://github.com/charlesguse/run-script-os/blob/master/package.json).

OS Options: `darwin`, `freebsd`, `linux`, `sunos`, `win32`

More information can be found in [Node's `process.platform`](https://nodejs.org/api/process.html#process_process_platform) and [Node's `os.platform()`](https://nodejs.org/api/os.html#os_os_platform).

---
_Source: https://npm.io/package/run-script-os · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._