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
12 changes: 6 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v6.0.2
- name: Setup Volta
uses: volta-cli/action@v4.2.1
- name: Node.js version
run: node -v
- name: npm version
run: npm -v
- name: Setup Node.js
uses: actions/setup-node@v6.3.0
with:
node-version: "25.6.1"
- name: Install dependencies
run: npm ci
- name: Check for linting errors
run: npm run lint
- name: Check for type errors
run: npm run type
- name: Run tests
run: npm run test
1 change: 0 additions & 1 deletion .npmrc

This file was deleted.

30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,27 @@ Command line interface for building NW.js apps

## Getting Started

1. Install [Volta](https://volta.sh/)
1. Install package: `npm i -D @nwutils/cli`
1. Install package: `npm i -g @nwutils/cli`

## Usage
## CLI

### create

Create a Vanilla JavaScript project.

```shell
nw create MyApp
```

Choose your template (defaults to `vanilla-js`) and out directory (defaults to `.`).

```shell
nw create --template=react-js --outDir=/path/to/project/dir MyApp
```

> Note: If you find a template is missing, feel free to open an issue or pull request.

## API

Apply NW.js specific polyfills to your NW.js application.

Expand All @@ -20,7 +37,6 @@ pollyfill();

## Roadmap

* [ ] Add tests for nw.Window.isDevToolsOpen
* [ ] Setup Vitest Code Coverage Action
* [ ] Setup License Check Action
* [ ] Setup eslint
* [ ] Add react-js template
* [ ] Package custom node test coverage action.
* [ ] Properly deal with the types problem. This will be a major pain point for developers using TypeScript.
7 changes: 7 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import js from "@eslint/js";
import globals from "globals";
import { defineConfig } from "eslint/config";

export default defineConfig([
{ files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: { ...globals.node, ...globals.browser, chrome: "readonly", nw: "readonly" } } },
]);
Loading
Loading