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
17 changes: 12 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,27 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 10.33.0
run_install: false

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache: pnpm
cache-dependency-path: pnpm-lock.yaml

- name: Install dependencies
run: npm ci
run: pnpm install --frozen-lockfile

- name: Run lint
run: npm run lint
run: pnpm lint

- name: Run unit tests
run: npm run test:run
run: pnpm test:run

- name: Build
run: npm run build
run: pnpm build
17 changes: 12 additions & 5 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,30 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 10.33.0
run_install: false

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache: pnpm
cache-dependency-path: pnpm-lock.yaml

- name: Install dependencies
run: npm ci
run: pnpm install --frozen-lockfile

- name: Run lint
run: npm run lint
run: pnpm lint

- name: Run unit tests
run: npm run test:run
run: pnpm test:run

- name: Build
run: npm run build
run: pnpm build

- name: Add SPA fallback
run: cp dist/index.html dist/404.html
Expand Down
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ lerna-debug.log*
node_modules
dist
dist-ssr
benchmark-results
playwright-report
test-results
dataset/private/
*.local

# Editor directories and files
Expand All @@ -22,4 +26,4 @@ dist-ssr
*.njsproj
*.sln
*.sw?
Puzzlink_Assistance.js
Puzzlink_Assistance.js
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,35 @@ Execution order is centrally managed in `src/domain/rules/slither/rules.ts`: det

### 2.1 Requirements

- Node.js 18+ (latest LTS recommended)
- npm 9+
- Node.js 20 (see `.nvmrc`)
- Corepack with pnpm 10.33.0

### 2.2 Install and Start

```bash
npm install
npm run dev
corepack enable
pnpm install
pnpm dev
```

This starts the local Vite development server.

![](https://cdn.jsdelivr.net/gh/SmilingWayne/picsrepo/20260427202121944.png)
![](https://cdn.jsdelivr.net/gh/SmilingWayne/picsrepo/20260514010419047.png)

### 2.3 Common Commands

```bash
npm run lint # ESLint
npm run test:run # Vitest unit tests
npm run build # TypeScript + Vite production build
npm run test:e2e # Playwright end-to-end tests
pnpm lint # ESLint
pnpm test:run # Vitest unit tests
pnpm build # TypeScript + Vite production build
pnpm test:e2e # Playwright end-to-end tests
```

### 2.4 Release and Deployment

GitHub Pages deployment is handled by GitHub Actions. Push a `v*` tag to run
linting, unit tests, and the production build, then publish `dist/` to Pages.

---

## 3) Features Implemented So Far
Expand Down Expand Up @@ -138,4 +144,3 @@ The long-term direction is to build a puzzle reasoning tool that is:
This repo is inspired by the browser plugin [Puzzlink_Assistance](https://github.com/LeavingLeaves/Puzzlink_Assistance), which helps with trivial inference for puzz.link-style puzzles.

The detailed inference techniques can be found in [How slitherlink should be solved](https://jonathanolson.net/slitherlink/).

Loading
Loading