practicode 0.1.0 → 0.1.1

package/Cargo.lock

@@ -357,7 +357,7 @@ checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a"
 
 [[package]]
 name = "practicode"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "anyhow",
  "crossterm 0.29.0",

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "practicode"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2024"
 description = "Local-first coding-test practice in a Rust terminal UI with optional AI help."
 readme = "README.md"

package/README.md

@@ -11,70 +11,55 @@
 Personal coding practice, right in your terminal.
 
 `practicode` is a small Rust TUI for stdin/stdout practice: problem on the left, code on the right, judge loop in the same terminal.
-No browser tab shuffle, no paste dance, just solve and run.
 
-## Why It Exists
+## Start
 
-- Fast local judging for Python, TypeScript, Java, and Rust
-- Gradual problem flow with local history
-- AI-powered `/next <request>` when you want a custom problem
-- Personal problem-generation notes
-- Small stack: Rust, Ratatui, Crossterm, and plain process execution
+### Prerequisites
 
-## Quick Start
+- Node.js 18+ for npm installation.
+- Rust and Cargo. The npm package builds the Rust binary during install, and also on first run if needed.
+- A runtime for the language you practice in: Python, Node.js for TypeScript, JDK for Java, or Rust.
 
-```bash
-git clone https://github.com/baba9811/practicode.git
-cd practicode
-cargo run --
-```
-
-Want a local binary?
+### npm
 
 ```bash
-cargo install practicode
+npm install -g practicode
 practicode
 ```
 
-Prefer npm from GitHub?
+### Cargo
 
 ```bash
-npm install -g github:baba9811/practicode
-practicode
-```
-
-Working from a local checkout?
-
-```bash
-cargo install --path .
+cargo install practicode
 practicode
 ```
 
-Or with npm:
+### Local checkout
 
 ```bash
-npm install -g .
-practicode
+git clone https://github.com/baba9811/practicode.git
+cd practicode
+npm install
+npm start
 ```
 
-The npm wrapper builds the Rust binary with Cargo, so Rust/Cargo is still required.
-
 ## Daily Loop
 
 The code editor starts focused.
 
 ```text
 write code
-Esc, then /run
-Esc, then /next easy string problem
+Esc, then /
+choose /run
+choose /next when it passes
 ```
 
+Typing `/` outside the editor opens the command palette. Use `up/down` to move, `Enter` to run or complete the selected command, and `Esc` to cancel.
+
 Submissions are saved as you type under `submissions/<problem-id>/solution.<ext>`.
 
 ## Commands
 
-Press `Esc`, then `/`, to focus the command bar.
-
 | Command | Action |
 | --- | --- |
 | `/run` | Judge the current submission |
@@ -86,21 +71,20 @@ Press `Esc`, then `/`, to focus the command bar.
 | `/giveup` | Show the reference answer |
 | `/ai hint` | Ask the selected AI about the current problem and submission |
 | `/provider codex` | Set AI provider: `codex` or `claude` |
-| `/model sonnet` | Set the model for `/ai` and AI-backed `/next`; use `auto` for the CLI default |
+| `/model auto` | Set the model for `/ai` and AI-backed `/next` |
 | `/note prefer hashmap practice` | Append a standing note for future problem generation |
 | `/notes` | Show your local next-problem notes |
-| `/lang python` | Set language: `python`, `ts`, `java`, `rust` |
-| `/ui ko` | Set UI language: `ko`, `en` |
-| `/theme` | Toggle dark/light theme |
+| `/lang python` | Set code language: `python`, `ts`, `java`, `rust` |
+| `/ui en` | Set UI language: `en`, `ko`, `ja`, `zh`, `es` |
+| `/theme dark` | Set theme: `dark` or `light` |
 | `/source ai` | Prefer AI for next-problem generation |
 | `/exit` | Quit |
 
-The editor owns normal typing keys.
-Press `Esc`, then `/`, when you want the command bar.
+The default UI language is English. Switch it any time with `/ui ko`, `/ui ja`, `/ui zh`, or `/ui es`.
 
-## Custom Problem Generation
+## AI Problems
 
-`/next <request>` passes your request into the selected AI problem generator. Examples:
+`/next <request>` passes your request into the selected AI problem generator.
 
 ```text
 /next a slightly harder string problem
@@ -108,19 +92,7 @@ Press `Esc`, then `/`, when you want the command bar.
 /next sorting problem, no graph yet
 ```
 
-AI generation reads [docs/problem-authoring-notes.md](docs/problem-authoring-notes.md) every time it creates a problem. Add personal preferences from inside the TUI:
-
-```text
-/note Prefer concise statements.
-/note I want more string and hashmap practice.
-/note Avoid DP until I ask for it.
-```
-
-Those notes are stored in `.practicode/problem_notes.md`, so they stay local.
-
-## AI Providers
-
-Codex is the default:
+Codex is the default provider:
 
 ```text
 /provider codex
@@ -135,10 +107,7 @@ Claude Code is also supported:
 /source ai
 ```
 
-`/ai <prompt>` uses the current provider for coaching. AI-backed `/next` uses the same provider and model.
-If you want a custom daemon or wrapper script, set `/ai-next-command <shell command>`; practicode passes `PRACTICODE_NEXT_REQUEST`, `PRACTICODE_AI_PROVIDER`, and `PRACTICODE_AI_MODEL`.
-
-Generated problem banks stay local:
+Generated problem banks and submissions stay local:
 
 | Path | Purpose |
 | --- | --- |
@@ -150,51 +119,21 @@ Generated problem banks stay local:
 
 Those paths are ignored by git, so your practice history stays yours.
 
-## Safety
-
-`/run` executes your local submission as a normal process. practicode runs it from `.practicode/build/<problem-id>/run`, but this is not an OS sandbox. Only run code you trust.
-
-## Debug Prints
+## Update
 
-`/run` shows raw stdout when a case fails. If you want debug output without changing the judged answer, print to stderr:
+```bash
+npm update -g practicode
+cargo install --force practicode
+```
 
-```python
-import sys
+## Safety
 
-print("debug", value, file=sys.stderr)
-```
+`/run` executes your local submission as a normal process. practicode runs it from `.practicode/build/<problem-id>/run`, but this is not an OS sandbox. Only run code you trust.
 
-## Development
+## Contributors
 
-```bash
-cargo test
-cargo run -- --smoke
-cargo run --
-```
+Development, release, problem-authoring, and design references live in [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md).
 
-The source is split by boring responsibility:
+## License
 
-| Path | Role |
-| --- | --- |
-| `src/core.rs` | Problem bank, state, rendering, judging |
-| `src/tui.rs` | Ratatui app, editor, command parser |
-| `src/ai.rs` | Codex/Claude command integration and notes |
-| `src/text.rs` | UTF-8 cursor math and Hangul composition |
-| `src/process.rs` | Process execution helpers |
-| `tests/` | Integration tests split by module |
-
-## Discovery Notes
-
-Recommended GitHub topics for this repo:
-`coding-practice`, `competitive-programming`, `algorithms`, `ratatui`, `tui`, `rust`, `codex`, `claude-code`, `local-first`.
-
-## References
-
-- Ratatui terminal UI library: https://ratatui.rs/
-- Crossterm terminal backend/events: https://github.com/crossterm-rs/crossterm
-- Codex CLI open-source repo: https://github.com/openai/codex
-- Claude Code CLI reference: https://docs.anthropic.com/en/docs/claude-code/cli-reference
-- Kattis problem package format: https://www.kattis.com/problem-package-format/
-- ICPC judging guidelines: https://icpc.global/regionals/regional-contest-cookbook-judging-guidelines
-- GitHub README image guidance: https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
-- GitHub repository topics: https://docs.github.com/articles/classifying-your-repository-with-topics
+practicode is MIT licensed. Third-party dependency license notes are in [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md).

package/THIRD_PARTY_LICENSES.md

@@ -0,0 +1,58 @@
+# Third-Party Licenses
+
+This file summarizes third-party dependency license metadata for practicode
+0.1.0, checked from Cargo.lock and Cargo metadata.
+
+This is not legal advice.
+
+## Project License
+
+practicode is licensed under MIT. The current dependency set is compatible with
+that choice: all Rust dependencies use permissive licenses, and the npm package
+has no npm dependencies.
+
+## npm Dependencies
+
+None.
+
+## Direct Rust Dependencies
+
+| Crate | Version | License |
+| --- | --- | --- |
+| anyhow | 1.0.103 | MIT OR Apache-2.0 |
+| crossterm | 0.29.0 | MIT |
+| ratatui | 0.29.0 | MIT |
+| serde | 1.0.228 | MIT OR Apache-2.0 |
+| serde_json | 1.0.150 | MIT OR Apache-2.0 |
+| unicode-width | 0.2.0 | MIT OR Apache-2.0 |
+| wait-timeout | 0.2.1 | MIT/Apache-2.0 |
+
+## Transitive Rust Dependency License Groups
+
+The locked Rust dependency graph contains 87 third-party packages.
+
+| License expression | Packages |
+| --- | ---: |
+| MIT OR Apache-2.0 | 50 |
+| MIT | 20 |
+| MIT/Apache-2.0 | 5 |
+| Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT | 5 |
+| Apache-2.0 OR MIT | 1 |
+| Apache-2.0/MIT | 1 |
+| MIT / Apache-2.0 | 1 |
+| Unlicense OR MIT | 1 |
+| Zlib | 1 |
+| Apache-2.0 OR BSL-1.0 | 1 |
+| (MIT OR Apache-2.0) AND Unicode-3.0 | 1 |
+
+No GPL, LGPL, AGPL, or MPL dependencies were detected in the locked Rust
+dependency graph.
+
+## Release Notes
+
+The crates.io and npm packages distribute practicode source, not vendored
+third-party source or prebuilt third-party binaries. The npm installer builds
+the Rust binary locally with Cargo.
+
+If practicode later ships prebuilt binaries, include full third-party notices
+and license texts with those binary artifacts.

package/docs/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing
+
+This repo is a Rust coding-practice workspace with a Ratatui terminal UI.
+
+## Prerequisites
+
+- Rust stable with Cargo, rustfmt, and clippy.
+- Node.js 18+ for the npm wrapper and package checks.
+- Optional local runtimes for judging: Python, Node.js, JDK, and Rust.
+
+## Development
+
+```bash
+cargo run --
+cargo run -- --smoke
+cargo test
+npm run smoke
+```
+
+Full local check:
+
+```bash
+make test
+```
+
+The source is split by boring responsibility:
+
+| Path | Role |
+| --- | --- |
+| `src/core.rs` | Problem bank, state, rendering, judging |
+| `src/tui.rs` | Ratatui app, editor, command parser |
+| `src/ai.rs` | Codex/Claude command integration and notes |
+| `src/text.rs` | UTF-8 cursor math and Hangul composition |
+| `src/process.rs` | Process execution helpers |
+| `tests/` | Integration tests split by module |
+
+## Problem Authoring
+
+AI generation reads [problem-authoring-notes.md](problem-authoring-notes.md) every time it creates a problem.
+
+Local generated data stays ignored by git:
+
+| Path | Purpose |
+| --- | --- |
+| `.practicode/problem_bank.json` | Local/custom/generated problem bank |
+| `.practicode/problem_notes.md` | Personal problem-generation notes |
+| `.practicode/problem-state.json` | Current problem, history, settings |
+| `problems/` | Generated problem markdown/index files |
+| `submissions/` | Local answer files |
+
+## Release
+
+`main` runs CI only. Releases are tag-based and publish to crates.io and npm through GitHub Actions.
+
+```bash
+make release VERSION=0.1.1
+```
+
+The release script checks versions, runs tests, creates the version commit and tag, and pushes `main` plus the tag. Do not print or commit tokens; GitHub Actions uses repository secrets.
+
+## Documentation
+
+Keep the root [README](../README.md) focused on users. Put contributor workflow, implementation notes, release notes, and design references here or in nearby `docs/` files.
+
+Use relative links for repo-local docs and assets. The terminal screenshot is stored at [assets/practicode-terminal.svg](../assets/practicode-terminal.svg).
+
+## UX And Documentation References
+
+- WAI-ARIA combobox keyboard interaction: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/
+- Command Line Interface Guidelines: https://clig.dev/
+- GitHub README guidance: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
+- GitHub relative links and images: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links
+- Ratatui terminal UI library: https://ratatui.rs/
+- Crossterm terminal backend/events: https://github.com/crossterm-rs/crossterm
+- Kattis problem package format: https://www.kattis.com/problem-package-format/
+- ICPC judging guidelines: https://icpc.global/regionals/regional-contest-cookbook-judging-guidelines

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "practicode",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Local-first coding-test practice in a Rust terminal UI with optional AI help.",
   "license": "MIT",
   "repository": {
@@ -12,6 +12,7 @@
     "practicode": "bin/practicode.js"
   },
   "scripts": {
+    "start": "node bin/practicode.js",
     "build": "cargo build --release --locked",
     "postinstall": "node scripts/npm-postinstall.js",
     "smoke": "node bin/practicode.js --smoke"
@@ -25,7 +26,8 @@
     "Cargo.lock",
     "Cargo.toml",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "THIRD_PARTY_LICENSES.md"
   ],
   "keywords": [
     "algorithms",

package/scripts/release.sh

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+current=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -1)
+npm_current=$(node -p "require('./package.json').version")
+
+if [[ "$current" != "$npm_current" ]]; then
+  echo "Cargo.toml version ($current) does not match package.json ($npm_current)" >&2
+  exit 1
+fi
+
+if [[ -n "$(git status --porcelain)" ]]; then
+  echo "working tree is dirty; commit or stash changes first" >&2
+  exit 1
+fi
+
+branch=$(git branch --show-current)
+if [[ "$branch" != "main" ]]; then
+  echo "release from main, not $branch" >&2
+  exit 1
+fi
+
+git fetch origin main --tags
+if [[ "$(git rev-parse HEAD)" != "$(git rev-parse origin/main)" ]]; then
+  echo "local main is not synced with origin/main" >&2
+  exit 1
+fi
+
+echo "Current version: $current"
+version="${1:-}"
+if [[ -z "$version" ]]; then
+  read -r -p "Next version: " version
+fi
+
+if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+  echo "version must look like 0.1.1" >&2
+  exit 2
+fi
+
+node -e '
+const [current, next] = process.argv.slice(1).map(v => v.split(".").map(Number));
+const ok = next[0] > current[0] ||
+  (next[0] === current[0] && (next[1] > current[1] ||
+  (next[1] === current[1] && next[2] > current[2])));
+process.exit(ok ? 0 : 1);
+' "$current" "$version" || {
+  echo "next version must be greater than $current" >&2
+  exit 2
+}
+
+if git rev-parse -q --verify "refs/tags/v$version" >/dev/null; then
+  echo "tag v$version already exists locally" >&2
+  exit 1
+fi
+if git ls-remote --exit-code --tags origin "v$version" >/dev/null 2>&1; then
+  echo "tag v$version already exists on origin" >&2
+  exit 1
+fi
+
+echo "Releasing v$version"
+VERSION="$version" perl -0pi -e 's/^version = ".*"/version = "$ENV{VERSION}"/m' Cargo.toml
+node -e "const fs=require('fs'); const p=require('./package.json'); p.version=process.env.VERSION; fs.writeFileSync('package.json', JSON.stringify(p, null, 2) + '\n')"
+cargo test
+npm pack --dry-run >/dev/null
+
+git add Cargo.toml Cargo.lock package.json
+git commit -m "Release v$version"
+git tag "v$version"
+git push origin main "v$version"