Installations

npm install run-script-os-fixed

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

15.11.0

NPM Version

7.6.0 Pull Requests

Open

2

Total

18

Closed

4

Merged

12

Issues

Open

8

Total

36

Closed

28

Releases

Unable to fetch releases

Contributors

9

Unable to fetch Contributors

View all 9 contributors

Languages

3

JavaScript

PowerShell

Shell

JavaScript (72.37%)

PowerShell (14.87%)

Shell (12.77%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

charlesguse

Download Statistics

Total Downloads

2,909

Last Day

2

Last Week

8

Last Month

25

Last Year

263

GitHub Statistics

195 Stars

127 Commits

30 Forks

2 Watching

1 Branches

9 Contributors

Maintainers

1

Package Meta Information

Latest Version

1.1.5

Package Id

run-script-os-fixed@1.1.5

Unpacked Size

9.38 kB

Size

4.00 kB

File Count

7

NPM Version

7.6.0

Node Version

15.11.0

Total Downloads

Cumulative downloads

Total Downloads

2,909

Last day

-33.3%

2

Compared to previous day

Last week

-27.3%

8

Compared to previous week

Last month

92.3%

25

Compared to previous month

Last year

-65.3%

263

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

Versions

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.

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

More information can be found in Node's process.platform and Node's os.platform().

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More