@seethruhead/cra-payroll 0.1.3 → 0.2.0

package/README.md

@@ -1,36 +1,15 @@
-# cra-payroll
+# @seethruhead/cra-payroll
 
 Calculate Canadian payroll deductions using CRA's [Payroll Deductions Online Calculator (PDOC)](https://apps.cra-arc.gc.ca/ebci/rhpd/beta/entry).
 
-Automates the CRA wizard via Playwright and returns your net pay, taxes, CPP, EI, and RRSP breakdown — per paycheck, monthly, or annually.
-
-## Download
-
-Grab the latest binary for your platform from [**Releases**](https://github.com/SeeThruHead/cra-payroll/releases):
-
-| Platform | File |
-|----------|------|
-| macOS (Apple Silicon) | `cra-payroll-darwin-arm64` |
-| macOS (Intel) | `cra-payroll-darwin-x64` |
-| Linux (x64) | `cra-payroll-linux-x64` |
-
-```bash
-# Example: macOS Apple Silicon
-curl -L -o cra-payroll https://github.com/SeeThruHead/cra-payroll/releases/latest/download/cra-payroll-darwin-arm64
-chmod +x cra-payroll
-
-# Remove macOS quarantine flag (unsigned binary)
-xattr -d com.apple.quarantine cra-payroll
-
-sudo mv cra-payroll /usr/local/bin/
-```
+Automates the CRA wizard via Puppeteer and returns your net pay, taxes, CPP, EI, and RRSP breakdown — per paycheck, monthly, or annually.
 
 > **Requires Google Chrome** — uses your system Chrome, no extra browser install needed.
 
-Or use the one-liner:
+## Install
 
 ```bash
-curl -fsSL https://raw.githubusercontent.com/SeeThruHead/cra-payroll/main/install.sh | bash
+npm install -g @seethruhead/cra-payroll
 ```
 
 ## Usage
@@ -53,21 +32,12 @@ cra-payroll --salary 100000 --monthly
 
 # Combine them
 cra-payroll --salary 263000 --table --annual --monthly
-
-# Verbose logging
-cra-payroll -v --salary 100000
-
-# Check version
-cra-payroll --version
-
-# Self-update to latest release
-cra-payroll --update
 ```
 
 ### Example output (`--table`)
 
 ```
-📊 Per-Paycheck Table (2026)
+Per-Paycheck Table (2026)
 ══════════════════════════════════════════════════════════════════════════════════════════════
   #  │     Gross │   Fed Tax │  Prov Tax │       CPP │        EI │   Net Pay │ Cum CPP/EI
 ──────────────────────────────────────────────────────────────────────────────────────────────
@@ -81,30 +51,28 @@ cra-payroll --update
 
 ## Config
 
-Config is loaded from the first file found:
-1. `--config <path>`
-2. `./config.json`
-3. `~/.config/cra-payroll.json`
-4. `~/.cra-payroll.json`
-
-CLI args override config file values. Missing values are prompted interactively.
+Create `~/.config/cra-payroll.json`:
 
 ```json
 {
   "province": "Ontario",
   "annualSalary": 100000,
   "payPeriod": "Semi-monthly (24 pay periods a year)",
+  "year": 2026,
   "rrspEmployeePercent": 4,
   "rrspEmployerPercent": 4
 }
 ```
 
+CLI args override config file values. Missing values are prompted interactively.
+
 ### Options
 
 | Option | CLI flag | Config key | Default |
 |--------|----------|------------|---------|
 | Province | `-p`, `--province` | `province` | `Ontario` |
 | Annual salary | `-s`, `--salary` | `annualSalary` | _(prompted)_ |
+| Tax year | `-y`, `--year` | `year` | current year |
 | Pay period | `--pay-period` | `payPeriod` | `Semi-monthly (24)` |
 | Employee RRSP % | `--rrsp-employee` | `rrspEmployeePercent` | `4` |
 | Employer RRSP % | `--rrsp-employer` | `rrspEmployerPercent` | `4` |
@@ -114,69 +82,20 @@ CLI args override config file values. Missing values are prompted interactively.
 | Annual totals | `-a`, `--annual` | — | `false` |
 | Monthly averages | `-m`, `--monthly` | — | `false` |
 | Verbose | `-v`, `--verbose` | — | `false` |
-| Self-update | `--update` | — | — |
-| Show version | `--version` | — | — |
 | Headless | `--headless` | — | `false` |
 | Config path | `-c`, `--config` | — | — |
 
-### 2026 CPP/EI Maximums (used for `--table`)
-
-| | Amount |
-|---|---|
-| CPP max contribution | $4,230.45 |
-| CPP2 max (additional) | $416.00 |
-| EI max premium | $1,123.07 |
-
-## Run from source
-
-If you'd rather not download a binary, you can clone and run directly. You'll need [Google Chrome](https://www.google.com/chrome/) installed.
-
-### With Bun
-
-```bash
-git clone https://github.com/SeeThruHead/cra-payroll.git
-cd cra-payroll
-bun install
-bun run dev -- --salary 100000
-bun run dev -- --salary 263000 --table
-```
-
-### With Node
-
-```bash
-git clone https://github.com/SeeThruHead/cra-payroll.git
-cd cra-payroll
-npm install
-npx tsx src/cli.ts --salary 100000
-npx tsx src/cli.ts --salary 263000 --table
-```
-
-## Development
-
-```bash
-# Run directly
-bun run dev -- --salary 100000
-
-# Build standalone binary
-bun run build
-
-# Unit tests (fast, no browser)
-bun test
-
-# Integration tests (hits CRA, needs Chrome, may be flaky)
-bun run test:integration
-
-# All tests
-bun run test:all
-```
-
 ## How it works
 
 1. Launches your system Chrome via Puppeteer (headed by default — CRA blocks headless)
 2. Fills out the PDOC wizard: province, pay period, salary, RRSP contributions
 3. Sets CPP/EI status and hits Calculate
 4. Scrapes the results page for taxes, deductions, and net pay
-5. For `--table` mode: runs twice (with/without CPP/EI) and simulates each paycheck using the 2026 maximums
+5. For `--table` mode: runs twice (with/without CPP/EI) and simulates each paycheck using the annual maximums
+
+## Standalone binary
+
+If you prefer a standalone binary without Node.js, see the [GitHub releases](https://github.com/SeeThruHead/cra-payroll/releases).
 
 ## License
 

package/README.md.bak

@@ -0,0 +1,183 @@
+# cra-payroll
+
+Calculate Canadian payroll deductions using CRA's [Payroll Deductions Online Calculator (PDOC)](https://apps.cra-arc.gc.ca/ebci/rhpd/beta/entry).
+
+Automates the CRA wizard via Playwright and returns your net pay, taxes, CPP, EI, and RRSP breakdown — per paycheck, monthly, or annually.
+
+## Download
+
+Grab the latest binary for your platform from [**Releases**](https://github.com/SeeThruHead/cra-payroll/releases):
+
+| Platform | File |
+|----------|------|
+| macOS (Apple Silicon) | `cra-payroll-darwin-arm64` |
+| macOS (Intel) | `cra-payroll-darwin-x64` |
+| Linux (x64) | `cra-payroll-linux-x64` |
+
+```bash
+# Example: macOS Apple Silicon
+curl -L -o cra-payroll https://github.com/SeeThruHead/cra-payroll/releases/latest/download/cra-payroll-darwin-arm64
+chmod +x cra-payroll
+
+# Remove macOS quarantine flag (unsigned binary)
+xattr -d com.apple.quarantine cra-payroll
+
+sudo mv cra-payroll /usr/local/bin/
+```
+
+> **Requires Google Chrome** — uses your system Chrome, no extra browser install needed.
+
+Or use the one-liner:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/SeeThruHead/cra-payroll/main/install.sh | bash
+```
+
+## Usage
+
+```bash
+# Interactive — prompts for missing values
+cra-payroll
+
+# CLI args
+cra-payroll --salary 120000 --province "British Columbia"
+
+# Per-paycheck table for the year (tracks CPP/EI maxout)
+cra-payroll --salary 263000 --table
+
+# Annual totals
+cra-payroll --salary 100000 --annual
+
+# Monthly averages
+cra-payroll --salary 100000 --monthly
+
+# Combine them
+cra-payroll --salary 263000 --table --annual --monthly
+
+# Verbose logging
+cra-payroll -v --salary 100000
+
+# Check version
+cra-payroll --version
+
+# Self-update to latest release
+cra-payroll --update
+```
+
+### Example output (`--table`)
+
+```
+📊 Per-Paycheck Table (2026)
+══════════════════════════════════════════════════════════════════════════════════════════════
+  #  │     Gross │   Fed Tax │  Prov Tax │       CPP │        EI │   Net Pay │ Cum CPP/EI
+──────────────────────────────────────────────────────────────────────────────────────────────
+  1  │ 10,958.33 │  2,232.82 │  1,431.13 │    669.42 │    178.62 │  6,446.34 │    848.04
+  2  │ 10,958.33 │  2,232.82 │  1,431.13 │    669.42 │    178.62 │  6,446.34 │  1,696.08
+ ... │       ... │       ... │       ... │       ... │       ... │       ... │       ...
+  7  │ 10,958.33 │  2,232.82 │  1,431.13 │    213.93 │     51.35 │  7,029.10 │  5,353.52 ← partial
+  8  │ 10,958.33 │  2,232.82 │  1,431.13 │      0.00 │      0.00 │  7,294.38 │  5,353.52 ✓ maxed
+ ... │       ... │       ... │       ... │       ... │       ... │       ... │       ...
+```
+
+## Config
+
+Config is loaded from the first file found:
+1. `--config <path>`
+2. `./config.json`
+3. `~/.config/cra-payroll.json`
+4. `~/.cra-payroll.json`
+
+CLI args override config file values. Missing values are prompted interactively.
+
+```json
+{
+  "province": "Ontario",
+  "annualSalary": 100000,
+  "payPeriod": "Semi-monthly (24 pay periods a year)",
+  "rrspEmployeePercent": 4,
+  "rrspEmployerPercent": 4
+}
+```
+
+### Options
+
+| Option | CLI flag | Config key | Default |
+|--------|----------|------------|---------|
+| Province | `-p`, `--province` | `province` | `Ontario` |
+| Annual salary | `-s`, `--salary` | `annualSalary` | _(prompted)_ |
+| Pay period | `--pay-period` | `payPeriod` | `Semi-monthly (24)` |
+| Employee RRSP % | `--rrsp-employee` | `rrspEmployeePercent` | `4` |
+| Employer RRSP % | `--rrsp-employer` | `rrspEmployerPercent` | `4` |
+| CPP maxed | `--cpp-maxed` | `cppMaxedOut` | `false` |
+| EI maxed | `--ei-maxed` | `eiMaxedOut` | `false` |
+| Yearly table | `-t`, `--table` | — | `false` |
+| Annual totals | `-a`, `--annual` | — | `false` |
+| Monthly averages | `-m`, `--monthly` | — | `false` |
+| Verbose | `-v`, `--verbose` | — | `false` |
+| Self-update | `--update` | — | — |
+| Show version | `--version` | — | — |
+| Headless | `--headless` | — | `false` |
+| Config path | `-c`, `--config` | — | — |
+
+### 2026 CPP/EI Maximums (used for `--table`)
+
+| | Amount |
+|---|---|
+| CPP max contribution | $4,230.45 |
+| CPP2 max (additional) | $416.00 |
+| EI max premium | $1,123.07 |
+
+## Run from source
+
+If you'd rather not download a binary, you can clone and run directly. You'll need [Google Chrome](https://www.google.com/chrome/) installed.
+
+### With Bun
+
+```bash
+git clone https://github.com/SeeThruHead/cra-payroll.git
+cd cra-payroll
+bun install
+bun run dev -- --salary 100000
+bun run dev -- --salary 263000 --table
+```
+
+### With Node
+
+```bash
+git clone https://github.com/SeeThruHead/cra-payroll.git
+cd cra-payroll
+npm install
+npx tsx src/cli.ts --salary 100000
+npx tsx src/cli.ts --salary 263000 --table
+```
+
+## Development
+
+```bash
+# Run directly
+bun run dev -- --salary 100000
+
+# Build standalone binary
+bun run build
+
+# Unit tests (fast, no browser)
+bun test
+
+# Integration tests (hits CRA, needs Chrome, may be flaky)
+bun run test:integration
+
+# All tests
+bun run test:all
+```
+
+## How it works
+
+1. Launches your system Chrome via Puppeteer (headed by default — CRA blocks headless)
+2. Fills out the PDOC wizard: province, pay period, salary, RRSP contributions
+3. Sets CPP/EI status and hits Calculate
+4. Scrapes the results page for taxes, deductions, and net pay
+5. For `--table` mode: runs twice (with/without CPP/EI) and simulates each paycheck using the 2026 maximums
+
+## License
+
+MIT

package/dist/cra-payroll.js

@@ -79561,7 +79561,7 @@ var calculateYearly = async (service, config2, headless = false) => {
 import { execSync as execSync2 } from "child_process";
 import { existsSync as existsSync3, renameSync, unlinkSync, chmodSync } from "fs";
 var REPO = "SeeThruHead/cra-payroll";
-var VERSION = "0.1.3";
+var VERSION = "0.2.0";
 var currentVersion = () => VERSION;
 var getTarget = () => {
   const os9 = process.platform;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seethruhead/cra-payroll",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Calculate Canadian payroll deductions using CRA's Payroll Deductions Online Calculator",
   "type": "module",
   "bin": {
@@ -13,7 +13,8 @@
     "dev": "bun run src/cli.ts",
     "build": "bun build --compile src/cli.ts --outfile cra-payroll --external electron",
     "build:npm": "bun build src/cli.ts --outfile dist/cra-payroll.js --target=node",
-    "prepublishOnly": "bun run build:npm",
+    "prepublishOnly": "bun run build:npm && cp README.md README.md.bak && cp npm-README.md README.md",
+    "postpublish": "mv README.md.bak README.md",
     "test": "bun test src/unit.test.ts",
     "test:integration": "bun test src/integration.test.ts --timeout 120000 --max-concurrency 1",
     "test:all": "bun test --timeout 120000 --max-concurrency 1"