Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
21 changes: 10 additions & 11 deletions .github/release-please/config.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
{
"packages": {
".": {
"include-component-in-tag": false,
"release-type": "node",
"changelog-sections": [
{ "type": "feat", "section": "Features", "hidden": false },
{ "type": "fix", "section": "Bug Fixes", "hidden": false },
{ "type": "chore", "section": "Chores", "hidden": false }
]
}
"packages": {
".": {
"include-component-in-tag": false,
"release-type": "node",
"changelog-sections": [
{ "type": "feat", "section": "Features", "hidden": false },
{ "type": "fix", "section": "Bug Fixes", "hidden": false },
{ "type": "chore", "section": "Chores", "hidden": false }
]
}
}
}

2 changes: 1 addition & 1 deletion .github/release-please/manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.2.3"
".": "0.2.3"
}
4 changes: 2 additions & 2 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ jobs:
- uses: actions/setup-node@v6.3.0
if: ${{ steps.release.outputs.release_created }}
with:
node-version: '24'
registry-url: 'https://registry.npmjs.org'
node-version: "24"
registry-url: "https://registry.npmjs.org"

- run: npm install -g npm@latest
if: ${{ steps.release.outputs.release_created }}
Expand Down
43 changes: 36 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ci
name: Node.js CI

on:
pull_request:
Expand All @@ -18,26 +18,55 @@ jobs:
strategy:
matrix:
os:
- macos-15
- macos-26
- macos-26-intel
- ubuntu-24.04
- ubuntu-24.04-arm
- windows-2025
- windows-11-arm
include:
- os: macos-26
display: MacOS 26 ARM
- os: macos-26-intel
display: MacOS 26 Intel
- os: ubuntu-24.04
display: Ubuntu 24.04 Intel
- os: ubuntu-24.04-arm
display: Ubuntu 24.04 ARM
- os: windows-2025
display: Windows 11 Intel
- os: windows-11-arm
display: Windows 11 (ARM)
fail-fast: false

name: ${{ matrix.display }}

runs-on: ${{ matrix.os }}

steps:
- name: Checkout repository
uses: actions/checkout@v6.0.2
uses: actions/checkout@v7.0.1

- name: Setup Volta
uses: volta-cli/action@v4.2.1
- name: Setup Node
uses: actions/setup-node@v7.0.0
with:
node-version: 26

- name: Install dependencies
- name: Install third party dependencies
run: npm ci

- name: Check for third party vulnerabilities
run: npm audit

- name: Check for formatting errors
run: npm run format

- name: Check for linting errors
run: npm run lint

- name: Check for type errors
run: npm run type

- name: Run tests with coverage
id: coverage
shell: bash
Expand Down Expand Up @@ -77,7 +106,7 @@ jobs:
echo "EOF" >> $GITHUB_OUTPUT

- name: Comment on PR
uses: marocchino/sticky-pull-request-comment@v2
uses: marocchino/sticky-pull-request-comment@v3
with:
key: coverage-${{ matrix.os }}
header: "Coverage Report – ${{ matrix.os }}"
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ node_modules

#package
cache
types
81 changes: 32 additions & 49 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,122 +2,105 @@

## [0.2.3](https://github.com/nwutils/runner/compare/v0.2.2...v0.2.3) (2026-03-26)


### Bug Fixes

* **types:** point to correct path ([3c71472](https://github.com/nwutils/runner/commit/3c7147273923f69e1f84cddcf831b0024fab054d))
- **types:** point to correct path ([3c71472](https://github.com/nwutils/runner/commit/3c7147273923f69e1f84cddcf831b0024fab054d))

## [0.2.2](https://github.com/nwutils/runner/compare/v0.2.1...v0.2.2) (2026-03-26)


### Bug Fixes

* **deps:** upgrade flatted ([dc9014b](https://github.com/nwutils/runner/commit/dc9014bfa343fbced4ca69a460dc1bfd6fc8a276))
* export types ([d2bc8bd](https://github.com/nwutils/runner/commit/d2bc8bd03784af17ebe4ebf762ff3502ea609712))
* export types ([6ecd02f](https://github.com/nwutils/runner/commit/6ecd02f8a2e4d927c24ae0483bcf8743dc885b09))
- **deps:** upgrade flatted ([dc9014b](https://github.com/nwutils/runner/commit/dc9014bfa343fbced4ca69a460dc1bfd6fc8a276))
- export types ([d2bc8bd](https://github.com/nwutils/runner/commit/d2bc8bd03784af17ebe4ebf762ff3502ea609712))
- export types ([6ecd02f](https://github.com/nwutils/runner/commit/6ecd02f8a2e4d927c24ae0483bcf8743dc885b09))

## [0.2.1](https://github.com/nwutils/runner/compare/v0.2.0...v0.2.1) (2026-03-04)


### Chores

* **deps:** remove unused packages ([fcd0ed6](https://github.com/nwutils/runner/commit/fcd0ed610d445549e7b32e12b7b320377aac6e15))
- **deps:** remove unused packages ([fcd0ed6](https://github.com/nwutils/runner/commit/fcd0ed610d445549e7b32e12b7b320377aac6e15))

## [0.2.0](https://github.com/nwutils/runner/compare/v0.1.0...v0.2.0) (2026-03-04)


### Features

* publish to npm ([f80a64d](https://github.com/nwutils/runner/commit/f80a64db3daf26f9265945b75d34f0d59149f992))

- publish to npm ([f80a64d](https://github.com/nwutils/runner/commit/f80a64db3daf26f9265945b75d34f0d59149f992))

### Chores

* add README ([e4e252b](https://github.com/nwutils/runner/commit/e4e252b2b12c084fff80fda7c76e79b1894a0d05))
* **deps:** bump the gha group in /.github/workflows with 2 updates ([#3](https://github.com/nwutils/runner/issues/3)) ([9c51be9](https://github.com/nwutils/runner/commit/9c51be936a360b5091e0e9cc0e3ef1f7290a512d))
* **deps:** bump the npm group with 5 updates ([#4](https://github.com/nwutils/runner/issues/4)) ([31e0c4d](https://github.com/nwutils/runner/commit/31e0c4d85cc8838c46f5ec45a19d7844b248eed6))
* initial cut ([#1](https://github.com/nwutils/runner/issues/1)) ([ec40d49](https://github.com/nwutils/runner/commit/ec40d49c5daa066499913dfe4cf33c6becf7c7dc))
- add README ([e4e252b](https://github.com/nwutils/runner/commit/e4e252b2b12c084fff80fda7c76e79b1894a0d05))
- **deps:** bump the gha group in /.github/workflows with 2 updates ([#3](https://github.com/nwutils/runner/issues/3)) ([9c51be9](https://github.com/nwutils/runner/commit/9c51be936a360b5091e0e9cc0e3ef1f7290a512d))
- **deps:** bump the npm group with 5 updates ([#4](https://github.com/nwutils/runner/issues/4)) ([31e0c4d](https://github.com/nwutils/runner/commit/31e0c4d85cc8838c46f5ec45a19d7844b248eed6))
- initial cut ([#1](https://github.com/nwutils/runner/issues/1)) ([ec40d49](https://github.com/nwutils/runner/commit/ec40d49c5daa066499913dfe4cf33c6becf7c7dc))

## [0.2.0](https://github.com/nwutils/getter/compare/v0.1.6...v0.2.0) (2026-01-18)


### Features

* support file protocol for options.manifestUrl ([#14](https://github.com/nwutils/getter/issues/14)) ([76b00d4](https://github.com/nwutils/getter/commit/76b00d4379f38644329c81ef264d5e67ce427425))

- support file protocol for options.manifestUrl ([#14](https://github.com/nwutils/getter/issues/14)) ([76b00d4](https://github.com/nwutils/getter/commit/76b00d4379f38644329c81ef264d5e67ce427425))

### Bug Fixes

* **deps:** security update for node-tar ([#12](https://github.com/nwutils/getter/issues/12)) ([28f991f](https://github.com/nwutils/getter/commit/28f991f89b51ffc98ab1d0fcc82298ac9496b322))

- **deps:** security update for node-tar ([#12](https://github.com/nwutils/getter/issues/12)) ([28f991f](https://github.com/nwutils/getter/commit/28f991f89b51ffc98ab1d0fcc82298ac9496b322))

### Chores

* lint jsdoc comments ([96d71c2](https://github.com/nwutils/getter/commit/96d71c2fcb9da06bd616b71c5b5d97d62550c888))
- lint jsdoc comments ([96d71c2](https://github.com/nwutils/getter/commit/96d71c2fcb9da06bd616b71c5b5d97d62550c888))

## [0.1.6](https://github.com/nwutils/getter/compare/v0.1.5...v0.1.6) (2026-01-17)


### Bug Fixes

* return NW.js file path ([#9](https://github.com/nwutils/getter/issues/9)) ([3589c17](https://github.com/nwutils/getter/commit/3589c173df07b49698c7ef2899608920f5b37771))

- return NW.js file path ([#9](https://github.com/nwutils/getter/issues/9)) ([3589c17](https://github.com/nwutils/getter/commit/3589c173df07b49698c7ef2899608920f5b37771))

### Chores

* **dependabot:** daily -> monthly ([97deb87](https://github.com/nwutils/getter/commit/97deb8756dc1733dcba43f4830a5a9b1c2f337ab))
* **test:** cover http request logic ([#11](https://github.com/nwutils/getter/issues/11)) ([97674b1](https://github.com/nwutils/getter/commit/97674b1243d26e44c151cc259a1375d44d3d677f))
- **dependabot:** daily -> monthly ([97deb87](https://github.com/nwutils/getter/commit/97deb8756dc1733dcba43f4830a5a9b1c2f337ab))
- **test:** cover http request logic ([#11](https://github.com/nwutils/getter/issues/11)) ([97674b1](https://github.com/nwutils/getter/commit/97674b1243d26e44c151cc259a1375d44d3d677f))

## [0.1.5](https://github.com/nwutils/getter/compare/v0.1.4...v0.1.5) (2025-11-30)


### Chores

* enable OIDC ([a8aa7df](https://github.com/nwutils/getter/commit/a8aa7dfbafff961f9b5f3f95d6592e207f039739))
- enable OIDC ([a8aa7df](https://github.com/nwutils/getter/commit/a8aa7dfbafff961f9b5f3f95d6592e207f039739))

## [0.1.4](https://github.com/nwutils/getter/compare/v0.1.3...v0.1.4) (2025-11-30)


### Chores

* **ci:** update npm to latest before publishing ([81eaad3](https://github.com/nwutils/getter/commit/81eaad34a778b2d6fdb6df241d6329ec9a953d98))
- **ci:** update npm to latest before publishing ([81eaad3](https://github.com/nwutils/getter/commit/81eaad34a778b2d6fdb6df241d6329ec9a953d98))

## [0.1.3](https://github.com/nwutils/getter/compare/v0.1.2...v0.1.3) (2025-11-30)


### Chores

* **ci:** add id: release ([c7d9c1c](https://github.com/nwutils/getter/commit/c7d9c1c1182682ee547cda1e3a3da729193b1904))
- **ci:** add id: release ([c7d9c1c](https://github.com/nwutils/getter/commit/c7d9c1c1182682ee547cda1e3a3da729193b1904))

## [0.1.2](https://github.com/nwutils/getter/compare/v0.1.1...v0.1.2) (2025-11-30)


### Bug Fixes

* adopt inversion of control ([#2](https://github.com/nwutils/getter/issues/2)) ([8f87b29](https://github.com/nwutils/getter/commit/8f87b2955e9b939274d2bf0ad8f9f6e25164ae7f))

- adopt inversion of control ([#2](https://github.com/nwutils/getter/issues/2)) ([8f87b29](https://github.com/nwutils/getter/commit/8f87b2955e9b939274d2bf0ad8f9f6e25164ae7f))

### Chores

* **ci:** merge publish into release ([de9dc94](https://github.com/nwutils/getter/commit/de9dc94bb13b3dc061db8b9909ad80650fba307f))
* **ci:** set fetch-depth to 0 ([9aa6690](https://github.com/nwutils/getter/commit/9aa66909fe30fa22abe6a5c69bddf1515f17b7c1))
* **ci:** trigger publish job on release event ([a90974e](https://github.com/nwutils/getter/commit/a90974eecc9fa8aad4b1d083d6b0b0746bd53762))
* **ci:** try trigger npm publish on release.types == published event ([d427207](https://github.com/nwutils/getter/commit/d42720747f47659e84f31762487512efc767ecca))
* **deps:** configure Dependabot ([0e0a0bf](https://github.com/nwutils/getter/commit/0e0a0bf838e9f9078c1749cb012cfd0142d75de8))
* **main:** release 0.1.1 ([#4](https://github.com/nwutils/getter/issues/4)) ([fa46f38](https://github.com/nwutils/getter/commit/fa46f38f00aff479e1e6138f6c9b89153ccd1225))
* migrate from nw-builder ([f78b3d9](https://github.com/nwutils/getter/commit/f78b3d9aa075c740197cbe1f832a8a4b5eb9d8eb))
* **release-please:** remove last-release-sha ([b7cdf68](https://github.com/nwutils/getter/commit/b7cdf68639251504e719f4cdd4a9a2a2f04e1ae2))
- **ci:** merge publish into release ([de9dc94](https://github.com/nwutils/getter/commit/de9dc94bb13b3dc061db8b9909ad80650fba307f))
- **ci:** set fetch-depth to 0 ([9aa6690](https://github.com/nwutils/getter/commit/9aa66909fe30fa22abe6a5c69bddf1515f17b7c1))
- **ci:** trigger publish job on release event ([a90974e](https://github.com/nwutils/getter/commit/a90974eecc9fa8aad4b1d083d6b0b0746bd53762))
- **ci:** try trigger npm publish on release.types == published event ([d427207](https://github.com/nwutils/getter/commit/d42720747f47659e84f31762487512efc767ecca))
- **deps:** configure Dependabot ([0e0a0bf](https://github.com/nwutils/getter/commit/0e0a0bf838e9f9078c1749cb012cfd0142d75de8))
- **main:** release 0.1.1 ([#4](https://github.com/nwutils/getter/issues/4)) ([fa46f38](https://github.com/nwutils/getter/commit/fa46f38f00aff479e1e6138f6c9b89153ccd1225))
- migrate from nw-builder ([f78b3d9](https://github.com/nwutils/getter/commit/f78b3d9aa075c740197cbe1f832a8a4b5eb9d8eb))
- **release-please:** remove last-release-sha ([b7cdf68](https://github.com/nwutils/getter/commit/b7cdf68639251504e719f4cdd4a9a2a2f04e1ae2))

## [0.1.1](https://github.com/nwutils/getter/compare/v0.1.0...v0.1.1) (2025-11-30)


### Bug Fixes

* adopt inversion of control ([#2](https://github.com/nwutils/getter/issues/2)) ([8f87b29](https://github.com/nwutils/getter/commit/8f87b2955e9b939274d2bf0ad8f9f6e25164ae7f))

- adopt inversion of control ([#2](https://github.com/nwutils/getter/issues/2)) ([8f87b29](https://github.com/nwutils/getter/commit/8f87b2955e9b939274d2bf0ad8f9f6e25164ae7f))

### Chores

* **ci:** trigger publish job on release event ([a90974e](https://github.com/nwutils/getter/commit/a90974eecc9fa8aad4b1d083d6b0b0746bd53762))
* **deps:** configure Dependabot ([0e0a0bf](https://github.com/nwutils/getter/commit/0e0a0bf838e9f9078c1749cb012cfd0142d75de8))
* migrate from nw-builder ([f78b3d9](https://github.com/nwutils/getter/commit/f78b3d9aa075c740197cbe1f832a8a4b5eb9d8eb))
- **ci:** trigger publish job on release event ([a90974e](https://github.com/nwutils/getter/commit/a90974eecc9fa8aad4b1d083d6b0b0746bd53762))
- **deps:** configure Dependabot ([0e0a0bf](https://github.com/nwutils/getter/commit/0e0a0bf838e9f9078c1749cb012cfd0142d75de8))
- migrate from nw-builder ([f78b3d9](https://github.com/nwutils/getter/commit/f78b3d9aa075c740197cbe1f832a8a4b5eb9d8eb))
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @ayushmanchhabra
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Run NW.js on Linux, MacOS and Windows hosts.
import run from "@nwutils/runner";

const nwProcess = await run({
version: "latest",
flavor: "normal",
platform: "linux",
arch: "x64",
srcDir: "./src",
cacheDir: "./cache",
argv: [],
version: "latest",
flavor: "normal",
platform: "linux",
arch: "x64",
srcDir: "./src",
cacheDir: "./cache",
argv: [],
});

nwProcess.kill();
Expand All @@ -31,14 +31,14 @@ nwProcess.kill();

Options

| Name | Type | Description |
| ---- | ---- | ----------- |
| version | `string` | Runtime version |
| flavor | `"normal" \| "sdk"` | Runtime flavor |
| platform | `"linux" \| "osx" \| "win"` | Host platform |
| arch | `"ia32" \| "x64" \| "arm64"` | Host architecture |
| cacheDir | `string` | Directory to cache NW binaries |
| argv | `string[]` | List of CLI arguments to be passed to NW.js. |
| Name | Type | Description |
| -------- | ---------------------------- | -------------------------------------------- |
| version | `string` | Runtime version |
| flavor | `"normal" \| "sdk"` | Runtime flavor |
| platform | `"linux" \| "osx" \| "win"` | Host platform |
| arch | `"ia32" \| "x64" \| "arm64"` | Host architecture |
| cacheDir | `string` | Directory to cache NW binaries |
| argv | `string[]` | List of CLI arguments to be passed to NW.js. |

## Contributing

Expand Down
2 changes: 2 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import js from "@eslint/js";
import { defineConfig } from "eslint/config";
import jsdoc from "eslint-plugin-jsdoc";
import simpleImportSort from "eslint-plugin-simple-import-sort";
import globals from "globals";

export default defineConfig([
{
files: ["**/*.{js,mjs,cjs}"],
plugins: {
jsdoc,
"simple-import-sort": simpleImportSort,
},
languageOptions: {
globals: globals.node,
Expand Down
Loading
Loading