how to execute powershell ps1 scripts from package.json "scripts"?

Question

How can I execute PowerShell ps1 scripts from package.json "scripts"?

I know how to set up a basic script in package.json "scripts". For example with the following configuration, I can exec npm run test which will output "this is only a test" to the console:

"scripts": {
  "test": "echo \"this is only a test\""
}

However, I have a more advanced scenario where I'd like to execute a PowerShell script. Something like this:

"scripts": {
  "buildAngular": "buildAngular.ps1"
}

Can I exec a ps1 script like this via the scripts object? Is any special setup/config required? Are there any additional constraints?

score 73 · Accepted Answer · answered Sep 21 '17 at 22:40

73

Assuming powershell is in you PATH you can call it like this:

"scripts": {
    "test": "@powershell -NoProfile -ExecutionPolicy Unrestricted -Command ./test.ps1"
}

Tested on Windows 7 with Powershell v4.

Limitations are that you need Powershell installed and in your PATH. I didn't test it with Powershell for Linux, so not sure if this solution will be portable to other platform for now.

answered Sep 21 '17 at 22:40

barnski

1,642
14
18

3

It works on Linux / Mac OS X with Powershell Core if you replace `@powershell` with `pwsh` and `-Command` with `-File` (see [What's New in PowerShell Core 6.0](https://learn.microsoft.com/en-US/powershell/scripting/whats-new/what-s-new-in-powershell-core-60?view=powershell-6#renamed-powershellexe-to-pwshexe)). Do not use the the `@` symbol before `pwsh` because it's a batch syntax. The complete working example is: `"test": "pwsh ./Do-Stuff.ps1 -ExecutionPolicy Unrestricted -NoProfile"`. – axmrnv Jun 02 '19 at 18:54
1

great answer, works on my Windows 10 – Serhii Kushchenko Oct 30 '21 at 17:19
Personally, I favour calling a `.bat` script, passing the ps1 file to execute as an argument. Then inside the batch script, perform checks on whether PowerShell Core exists before falling back to 'native' PowerShell for Windows users. You can also put your `-NoProfile -ExecutionPolicy...` code in the batch script as well so it's a bit cleaner. – Dan Atkinson Nov 22 '22 at 14:32

score 7 · Answer 2 · answered May 09 '21 at 00:24

7

Prepend the PowerShell command with "powershell", e.g.,

"command": "powershell Remove-Item ..\\folder\\file; Copy-Item -Path folder\\* -Destination ..\\other-folder -Recurse",

"buildAngular": "powershell buildAngular.ps1"

answered May 09 '21 at 00:24

kas

857
1
15
21

JeffRSon · Answer 3 · 2020-02-27T09:53:27.697

5

You might set the script-shell config - either via npm config set script-shell "powershell" or environment variable $env:npm_config_script_shell="powershell"

Then you could use

"scripts": {
    "test": "Write-Host 'this is only a test'"
}

or

"scripts": {
    "buildAngular": ".\\buildAngular.ps1"
}

I'm not sure whether you can supply parameters like -NoProfile though.

edited Feb 27 '20 at 09:53

answered Feb 27 '20 at 09:41

JeffRSon

10,404
4
26
51

Dan Atkinson · Answer 4 · 2022-11-22T15:07:43.633

Personally, I favour calling a .bat script and passing the .ps1 filename to execute as an argument. Obviously this will only work in Windows, so YMMV.

Inside the batch script, you can perform checks on whether PowerShell Core exists before falling back to 'native' PowerShell. You can also put your -NoProfile -ExecutionPolicy code in the batch script as well so it's a bit cleaner in the package.json file.

Package.json:

"scripts": {
  "test": "build-scripts\RunBuildScript.bat test"
}

RunBuildScript.bat:

@ECHO OFF

REM Check the argument passed in. You could also check if the file actually exists.
SET "NpmBuildScriptName=%1"
IF ["%NpmBuildScriptName%"] == [""] (
    ECHO "Could not find the name of the script."
    GOTO :TidyUp
)

REM Perform some checks for PowerShell Core in the file system.
FOR %%s IN ("PowerShell\pwsh.exe" "\PowerShellCore\pwsh.exe") DO (
    IF EXIST %%s (
        ECHO "PowerShell found at %%s"
        SET "PowerShellPath=%%s"
        GOTO :ExecuteScript
    )
)

REM If you can't find PowerShell, use the default.
IF ["%PowerShellPath%"] == [""] (
    ECHO "PowerShell Core was not found. Defaulting to native PowerShell"
    SET "PowerShellPath=powershell"
    GOTO :ExecuteScript
)

:ExecuteScript
    %PowerShellPath% -NoProfile -ExecutionPolicy Unrestricted -Command "%NpmBuildScriptName%.ps1"
    GOTO :TidyUp

:TidyUp
    REM Wipe after using.
    SET "NpmBuildScriptName="

ECHO 0

test.ps1

Write-Host "this is only a test"

Obviously a lot of hoops to jump through just to output some text, but this approach makes it a bit more extensible.

how to execute powershell ps1 scripts from package.json "scripts"?

4 Answers4

Linked