docs: v1.2.0 — sync docs and templates, changelog; bump to 1.2.0

Docs had drifted since 1.0.0: README missed the 1.1.0 features and
showed an Android step that overwrites the committed Gradle project;
ROADMAP, PACKAGING, ARCHITECTURE and TECH-SPEC still described 1.0.0;
CONTRIBUTING and the PR template listed half the gates; SECURITY named
1.0.x; CLAUDE.md's structure and gate list were out of date.
webapp/TAURI.md (Node 25, no .rpm) is folded into PACKAGING and removed.

Also: purpose-word validation documented in ARCHITECTURE, two stale code
comments (about.ts, vietnamese-banks.ts), .gitignore for the
maintainer's local note files, and the CHANGELOG entry.

Six manifests bumped 1.1.0 -> 1.2.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
poli0981andClaude Opus 5.5 committed 2026-10-12 22:10:58 +07:00
1 parent f2e6e21555
commit bc27ce95d5
25 files changed
+166 -138

No files matched your search

+2 -2
View File
@@ -12,8 +12,8 @@ body:
id: version
attributes:
label: App version
description: From the About page. Example `v1.0.0`.
placeholder: v1.0.0
description: From the About page. Example `v1.2.0`.
placeholder: v1.2.0
validations:
required: true
- type: dropdown
@@ -31,11 +31,18 @@ body:
options:
- Editor
- Output / preview
- Batch
- Social captions
- Playlist
- History
- Profiles / presets
- Templates (description, title, tags)
- Backup & restore
- i18n / locales
- Settings
- Web app (ytgenerator.stream)
- Desktop (Tauri)
- Android
- Documentation
validations:
required: true
+5 -2
View File
@@ -20,9 +20,12 @@
- [ ] `npm run typecheck` and `npm run typecheck:all` pass
- [ ] `npm run lint` and `npm run format:check` pass
- [ ] `npm run validate:locales` passes — new strings are in all 8 locales (en, vi, ja, es, ko, zh, pt-BR, id)
- [ ] `npm run test:run` passes, with tests for the change
- [ ] `npm run test:coverage` passes, with tests for the change
- [ ] `npm run knip` passes — no unused files, exports or dependencies
- [ ] `npm run check:version`, `check:tauri`, `check:licenses` and `check:copyright` pass
- [ ] `npm run build && npm run check:bundle` stay within budget
- [ ] Touched `src-tauri/`: `cargo fmt --check`, `cargo clippy -- -D warnings`, `cargo test`
- [ ] Touched `worker/` or `wrangler.jsonc`: `npm run cf:check`
- [ ] Touched `src-tauri/`: `cargo fmt --check`, `cargo clippy --all-targets --locked -- -D warnings`, `cargo test`
- [ ] No secrets, credentials, or PII committed
- [ ] No new runtime dependencies without prior discussion in an issue
- [ ] Commit messages follow `type(scope): message`
+5
View File
@@ -28,3 +28,8 @@ src-tauri/gen/android/app/build/
.dev.vars
.dev.vars.*
!.dev.vars.example
# Maintainer's local notes and Python caches — never committed (CLAUDE.md)
note.txt
warning.txt
__pycache__/
+35
View File
@@ -2,6 +2,41 @@
All notable changes to YTDescGen ship as tagged releases on `main`.
## v1.2.0 — 2026-10-12
Say when a game is **made with AI**: a new group of content warnings for AI-generated game content, three more disclosures, and the docs, notices and wiki brought back in line with the app. Web, desktop and Android all ship as 1.2.0.
### Added
- **AI-generated content** — a new content-warning group, the thirteenth, for games that are made or run with generative AI (a story _about_ AI is still "AI / artificial intelligence themes"):
- AI-generated content (general) · AI art / visuals · AI / synthetic voices · AI music / sound · AI-written text / dialogue
- **Generated live by AI while playing** — the game makes content as you play, so a viewer's own run may differ
- **AI use disclosed by the developer** — the store page says so (Steam shows an "AI Generated Content Disclosure"), so viewers know you aren't guessing
The split follows Steam's AI disclosure: content made with AI during development and shipped, and content an AI generates while the game runs. Machine translation stays a playthrough note (**Language patch → Machine translation**). YouTube doesn't ask for gameplay footage to be labelled as altered or synthetic — these lines are for viewers. Bilingual in every output language, like every warning.
- **Simulated gambling** (Mature / Sensitive) and **In-game purchases** (Internet / Digital life, next to loot boxes) — the two ESRB / PEGI descriptors that had no warning.
- **Tech note: Upscaling / frame-gen artifacts** (Video quality) — "Possible upscaling / frame-generation artifacts (DLSS, FSR, XeSS)". Which upscaler and frame generation were on is already the 🖥 Video settings line; the note only warns about what they do to the footage.
257 content warnings in 13 groups, 25 tech notes — all listed in [docs/CONTENT-INVENTORY.md](docs/CONTENT-INVENTORY.md).
### Changed
- **Third-party notices** said the app uses the operating system's fonts; it bundles **Inter** and **JetBrains Mono** (OFL-1.1), and now says so. The Rust table lists every direct crate — `serde` was missing — and a crate with no known license stops the generator ([scripts/lib/third-party.ts](scripts/lib/third-party.ts)).
- **REUSE**: the Gradle wrapper under `src-tauri/gen/android/` is credited to Gradle's authors, not to the project.
- **Privacy Policy** (Effective 2026-10-12) lists the one `sessionStorage` flag, `ytdescgen-chunk-reload`, next to the `localStorage` keys. Not a material change: nobody is asked to accept the terms again.
- **Security policy**: 1.2.x is the supported version.
- **Docs**: README (contact emails by purpose, themes and scrollbars, installer sizes, the Android build step), ROADMAP (1.1.0 and 1.2.0; finished items checked off), PACKAGING (the installers' copyright, the yearly `update:copyright`, v1.1.0 sizes, `tauri info`), ARCHITECTURE and TECH-SPEC (purpose-word validation, versions, test count), FEATURES, I18N, CONTENT-INVENTORY + Vietnamese (now with the tech notes), CONTRIBUTING and the PR template (the full gate list), the issue templates, DISCLAIMER + Vietnamese, CLAUDE.md. `webapp/TAURI.md` (Node 25, no `.rpm`) is folded into PACKAGING and removed.
- **Wiki**: Home (1.2.0, what's new in 1.1 and 1.2), Field Reference (warnings and tech notes, the copyright / DMCA line and purpose words, Hide scrollbars), FAQ ("How do I say a game uses AI-generated content?"), Release Process (copyright years, the wiki step, the rust-toolchain pin).
### Under the hood
- No store version bump: the warning and tech-note lists only grow. The backup whitelist checks ids against them, so a 1.2.0 backup restores on 1.1.0 without the new ids.
- **A test fails when a content warning or tech note has no editor label or description line** in `_schema.json` — and so, through `validate:locales`, in any locale. Until now a missing key showed the raw key in the editor and silently dropped the line from the description. Tech notes also get the group-parity test content warnings already had.
- New strings in all eight locales (1,264 UI + 584 template keys each).
- typecheck, typecheck:all, lint, format:check, validate:locales, knip, check:version, check:tauri, check:licenses, check:copyright, **984 tests** and build all pass; initial load 275.2 of 280 KB gzip. Verified live in the browser: the new group and its search, pick order in the description, the bilingual English · Vietnamese lines and the tech note.
- `.gitignore` covers the maintainer's local `note.txt`, `warning.txt` and `__pycache__/`.
- Six manifests bumped 1.1.0 → 1.2.0.
## v1.1.0 — 2026-10-03
A small release: a **copyright email** and **purpose words** for the split contact block, an option to **hide scrollbars**, and copyright years that keep themselves current. Web, desktop and Android all ship as 1.1.0.
+24 -12
View File
@@ -12,7 +12,7 @@
## Tech Stack
| Layer | Technology |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| UI | React 19, TypeScript (strict), Radix primitives (`radix-ui`), Motion (LazyMotion), cmdk, sonner, lucide-react + simple-icons |
| Build | Vite 8 (Rolldown); config imports need `.ts` extensions |
| Styling | Tailwind CSS 4, CSS-first `@theme` tokens in `src/styles/globals.css` |
@@ -22,7 +22,7 @@
| Desktop / Android | Tauri 2 (Rust) — see `src-tauri/` |
| Web hosting | Cloudflare Workers (`worker/`, `wrangler.jsonc`), Turnstile, Web Analytics |
| Tests | Vitest (node environment; Worker tests included) |
| Quality | ESLint, Prettier, knip, coverage thresholds, bundle budget, licence allow-list, REUSE, actionlint/zizmor, cargo fmt/clippy/deny |
| Quality | ESLint, Prettier, knip, coverage thresholds, bundle budget, licence allow-list, copyright years, REUSE, actionlint/zizmor, cargo fmt/clippy/deny |
## Project Structure
@@ -37,16 +37,20 @@ src/
tag-generator.ts # tag pools, YouTube's tag length count, trimming
timeline-parser.ts # timestamps → chapters, YouTube's chapter rules
channel-phrase.ts # drops "on {{channel}}" when there is no channel name
rig-block.ts, limits.ts, social-post-builder.ts, pinned-comment-builder.ts, playlist-builder.ts, types.ts
types.ts # GeneratorInput, CONTENT_WARNINGS, TECH_NOTES, option lists
rig-block.ts, limits.ts, social-post-builder.ts, pinned-comment-builder.ts, playlist-builder.ts,
endings-format.ts, graphics-vendor.ts
config/ # static data: video types, genres, platforms (stores),
# social fields/platforms, GPU catalog, rig fields,
# content-warning-groups / tech-note-groups (editor groups),
# library-fields (profile/preset/per-video field lists),
# contact-emails (purpose words), brand (copyright years),
# legal, about, field limits, Vietnamese banks, …
store/ # Zustand stores; each exports its version + migrate fn
editor-store.ts # the draft (EditorData, migrateEditorState, editorDataOf)
profile-store.ts, preset-store.ts, template-store.ts, history-store.ts
settings-store.ts + settings-heal.ts # settings; healed on every load
log-store.ts
log-store.ts, pending-invalid-store.ts # typed-but-invalid values, for Strict Mode
utils/
backup/ # backup format v2, detect, sanitize, restore (+undo),
# collect, desktop auto-backups, start-up recovery
@@ -61,11 +65,16 @@ build-plugins/ # legal pages at build time; web-only extras
src-tauri/src/ # lib.rs (plugins, tray), storage.rs (name-only file
# commands), file_dialog.rs (native Save/Open)
migration-page/ # moving notice for the old GitHub Pages address (until 2026-11-29)
tests/ # engine, store, utils, worker, build, i18n, config
scripts/ # locale validation, version sync, bundle budget,
# licences/third-party notices, brand assets
tests/ # engine, store, utils, worker, build, i18n, config, hooks, scripts
scripts/ # locale validation + generator, version sync, Tauri versions,
# bundle budget, licences/third-party notices, copyright
# years, brand assets
docs/ # DEVELOPMENT, HOSTING, ARCHITECTURE, FEATURES, ROADMAP,
# TECH-SPEC, I18N, PACKAGING, CONTENT-INVENTORY (+ vi/)
# TECH-SPEC, I18N, PACKAGING, CONTENT-INVENTORY
i18n/vi/ # Vietnamese: DEVELOPMENT, CONTENT-INVENTORY, DISCLAIMER
assets/brand/ # logo sources: every icon and the link-preview card come from them
public/ # static web files (_headers, icons, manifest, 404, robots, sitemap)
LICENSES/ # license texts for REUSE
```
## Coding Conventions
@@ -130,7 +139,7 @@ npm run lint && npm run format:check
npm run knip # unused files/exports/dependencies
npm run validate:locales
npm run check:bundle # after build: initial load / chunk budget
npm run check:licenses # licence allow-list + THIRD_PARTY_NOTICES in sync
npm run check:licenses # licence allow-list + THIRD_PARTY_NOTICES in sync (generate:third-party fixes)
npm run check:copyright # NOTICE, REUSE.toml, installer copyright = HEAD's year (update:copyright fixes)
npm run check:version # the six version fields agree
npm run check:tauri # @tauri-apps/* and tauri crates on the same major.minor
@@ -138,13 +147,15 @@ npm run cf:dev # wrangler dev (copy .dev.vars.example to .dev.vars
npm run cf:check # wrangler deploy --dry-run
npm run tauri:dev # desktop app against the dev server
npm run tauri:build # desktop installers
# src-tauri/: cargo fmt --check · cargo clippy --all-targets -- -D warnings · cargo test
npm run generate:locale # scaffold a new locale folder from en (-- --lang xx)
npm run generate:brand # favicon, PWA icons, link-preview card from assets/brand/
# src-tauri/: cargo fmt --check · cargo clippy --all-targets --locked -- -D warnings · cargo test
```
## Git Workflow
- `main` only: feature branches (`feat/…`, `fix/…`, `docs/…`, `chore/…`) → PR → `main`. Every merge to `main` deploys the web app.
- Commit and PR-title format: `type(scope): message` (`feat`, `fix`, `refactor`, `docs`, `test`, `ci`, `chore`) — CI checks PR titles.
- Commit and PR-title format: `type(scope): message` (`feat`, `fix`, `refactor`, `docs`, `test`, `ci`, `chore`) — CI checks PR titles, and the message must start with a lower-case letter (`feat(editor): warnings for AI…`, not `feat(editor): AI…`).
- Commits and release tags are GPG-signed; never bypass signing or hooks.
- Required checks: `check`, `dependency-review`, `workflow-lint`, `reuse`, `pr-title`.
@@ -155,11 +166,12 @@ npm run tauri:build # desktop installers
## Important Notes for Claude Code
- Run the gates before committing: `typecheck`, `typecheck:all`, `lint`, `format:check`, `test:run`, `knip`, `validate:locales`, `build` + `check:bundle`; `cargo fmt/clippy/test` when `src-tauri/` changes. In the first commit of a new year, `npm run update:copyright` (CI's `check:copyright` fails until then).
- Run the gates before committing: `typecheck`, `typecheck:all`, `lint`, `format:check`, `test:run`, `knip`, `validate:locales`, `check:version`, `check:tauri`, `check:licenses`, `check:copyright`, `build` + `check:bundle`; `cargo fmt/clippy/test` when `src-tauri/` changes. In the first commit of a new year, `npm run update:copyright` (CI's `check:copyright` fails until then). A dependency change can make `check:licenses` fail: `npm run generate:third-party` rewrites the notices, and a new direct crate in `src-tauri/Cargo.toml` that isn't Tauri's needs its license in `OTHER_CRATES` (`scripts/lib/third-party.ts`).
- New contact-email purpose words: `src/config/contact-emails.ts` (lower-case; a test keeps every locale's example address valid).
- New language: follow `docs/I18N.md` (register it, both namespaces, tag pools, `channel-phrase.ts` patterns, browser detection).
- New genre: `src/config/genres.ts` + its tag pool in `src/engine/tag-generator.ts` (a test keeps them in sync).
- New video type: `src/config/video-types.ts` + every `templates.json` (titles, intros, pinned-comment greetings).
- New content warning / tech note: the id in `CONTENT_WARNINGS` / `TECH_NOTES` (`src/engine/types.ts`), a group in `src/config/content-warning-groups.ts` / `tech-note-groups.ts`, the editor label (`ui.json`) and description line (`templates.json`) in all 8 locales and `_schema.json` — tests fail on any gap — and the row in `docs/CONTENT-INVENTORY.md` (+ vi). Don't repeat a fact that has its own field (language patch, game version, difficulty, the Video settings upscaler).
- New store platform: `src/config/platforms.ts` (URL pattern, `tagName`), optionally a name extractor in `src/utils/url-extractors.ts`.
- Never commit `note.txt`, `warning.txt` or `__pycache__/`; never put real secrets in files (`.dev.vars` holds Cloudflare's public Turnstile test keys only).
- The Cloudflare dashboard, publishing releases and repository settings are the maintainer's; ask before touching them.
+9 -5
View File
@@ -16,11 +16,14 @@ Participation is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md). By con
npm run typecheck && npm run typecheck:all
npm run lint && npm run format:check
npm run validate:locales
npm run test:run
npm run test:coverage
npm run knip
npm run check:version && npm run check:tauri && npm run check:licenses
npm run check:copyright
npm run build && npm run check:bundle
npm run cf:check
```
Touched `src-tauri/`? Also `cargo fmt --check`, `cargo clippy --all-targets -- -D warnings` and `cargo test` in `src-tauri/`. Touched `worker/` or `wrangler.jsonc`? `npm run cf:check` dry-runs the Cloudflare deploy.
`check:licenses` fails when `THIRD_PARTY_NOTICES.md` is stale — `npm run generate:third-party` rewrites it. `check:copyright` fails in the first commit of a new year — `npm run update:copyright` fixes it. Touched `src-tauri/`? Also `cargo fmt --check`, `cargo clippy --all-targets --locked -- -D warnings` and `cargo test` in `src-tauri/` (after `npm run build` — see the [Development Guide](./docs/DEVELOPMENT.md#rust-checks)).
## How to Contribute
@@ -35,7 +38,8 @@ Use the templates in `.github/ISSUE_TEMPLATE/`:
- Branch from `main` (`feat/…`, `fix/…`, `docs/…`) and open the PR against `main`. Every merge to `main` deploys the web app, so `main` stays releasable.
- Commit format and **PR title**: `type(scope): message` — e.g. `feat(engine): add Spanish template support`. Types: `feat`, `fix`, `refactor`, `docs`, `test`, `ci`, `chore`. CI checks the PR title.
- Required checks: `check`, `dependency-review`, `workflow-lint`, `reuse`, `pr-title` (plus `lint-and-test` and `cargo-deny` when `src-tauri/` changes). Commits on `main` are signed.
- Required checks: `check`, `dependency-review`, `workflow-lint`, `reuse`, `pr-title`. When `src-tauri/` changes, the Rust workflow's `lint-and-test` and `cargo-deny` run too, and GitHub's CodeQL code scanning runs on every PR. Commits on `main` are signed.
- PR titles start with a lower-case letter after the colon (`feat(editor): add …`, not `feat(editor): Add …`).
- One logical change per PR. Don't bundle unrelated refactors.
- All locale files must stay in lock-step — see the i18n section below.
- AI-assisted contributions are welcome but **must be disclosed** in the PR description.
@@ -59,7 +63,7 @@ The following are closed without review and may result in a contributor ban —
- **Behavior or language violating** [GitHub's Acceptable Use Policies](https://docs.github.com/en/site-policy/acceptable-use-policies).
- **Off-topic / rambling reports** that don't get to the point. Example of what gets ignored: _"Good morning, today is a beautiful day, I was just wondering if maybe…"_ — get straight to the problem.
- **PRs that touch hundreds of files for a one-line fix** (typical sign of an auto-formatter run on unrelated files).
- **Tests deleted, or `--no-verify` used to bypass pre-commit hooks.**
- **Tests deleted or skipped to make CI pass.**
- **"AI rewrote my entire codebase in a different style" PRs.** AI-assisted edits are welcome (disclosed); whole-repo rewrites are not.
- **Spam, drive-by typo fixes** that don't address a real issue, and karma-farming PRs.
@@ -67,7 +71,7 @@ The following are closed without review and may result in a contributor ban —
- Bug fixes with a reproduction case and a regression test.
- Locale corrections from native speakers.
- New content-warning IDs with all 8 translations and a clear rationale (especially horror-genre vocabulary).
- New content-warning or tech-note IDs with all 8 translations and a clear rationale (especially horror-genre vocabulary) — the checks fail until every locale has its label and description line.
- New video types or genres that fit the gameplay no-commentary use case.
- Accessibility and mobile-responsive improvements.
- Performance fixes with a `before/after` measurement.
+1 -1
View File
@@ -4,7 +4,7 @@
YTDescGen is a personal project built by a single maintainer (`@poli0981`) for use with the [`@SkullMute`](https://www.youtube.com/@SkullMute) YouTube channel and shared publicly as open source. It is **not a commercial product** and there is no support obligation.
Code, documentation, locale translations, and design decisions in this repository were **co-authored with the assistance of Anthropic's Claude Code (Claude Opus models; v1.0.0 with Claude Opus 5.5)**. All commits, releases, and architectural decisions are reviewed and approved by the maintainer before merging.
Code, documentation, locale translations, and design decisions in this repository were **co-authored with the assistance of Anthropic's Claude Code (Claude Opus models; v1.0.0 through v1.2.0 with Claude Opus 5.5)**. All commits, releases, and architectural decisions are reviewed and approved by the maintainer before merging.
This disclosure applies to:
+5 -4
View File
@@ -2,7 +2,7 @@
**YouTube Gameplay Description Generator** — a template engine for Gameplay No Commentary YouTube channels.
**Use it at [ytgenerator.stream](https://ytgenerator.stream)**, or install the desktop app (Windows / macOS / Linux, 2–5 MB installers) or the Android app from [Releases](https://github.com/poli0981/youtube-generator/releases). One codebase: React + Tauri 2.
**Use it at [ytgenerator.stream](https://ytgenerator.stream)**, or install the desktop app (Windows / macOS / Linux, 3–6 MB installers) or the Android app from [Releases](https://github.com/poli0981/youtube-generator/releases). One codebase: React + Tauri 2.
Generate YouTube titles, descriptions and tags in eight languages. Save your channel as a profile and each game as a preset, and every new video is a few clicks.
@@ -37,7 +37,9 @@ Built for the gameplay no-commentary niche — especially horror / scary games
- **Batch mode** — every part of a series in one pass, in several languages.
- **Cross-post captions** — TikTok, YouTube Shorts, Instagram Reels, Facebook Reels, X, Threads and Bluesky, each within its own limit.
- **Command palette** (Ctrl/⌘ + K) and keyboard shortcuts.
- **Contact emails by purpose** — one contact line, or separate lines for contact, advertising, game keys & playtest and copyright / DMCA, each purpose address checked for a word that says what it is for (`sponsor@…`, `keys@…`, `dmca@…`).
- **Guardrails** — length caps on every field and an opt-in **Strict Mode** that blocks copy and export while a field has an error.
- **Dark and light themes**, larger controls on touch screens, and an option to hide every scrollbar.
- **Desktop app** — Windows, macOS & Linux via Tauri; **Android app** — Android 11+, sideloaded from [Releases](https://github.com/poli0981/youtube-generator/releases).
## Quick Start
@@ -63,8 +65,7 @@ npm run tauri:build
Android build (`.apk`) — requires the Android SDK + NDK + a JDK:
```bash
cargo tauri android init # one-time; generates src-tauri/gen/android
cargo tauri android build --apk
cargo tauri android build --apk # the Gradle project in src-tauri/gen/android is committed — don't re-run `init`
# Output: src-tauri/gen/android/app/build/outputs/apk/universal/release/
```
@@ -101,7 +102,7 @@ Architecture overview: [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md).
| [Hosting](./docs/HOSTING.md) | How ytgenerator.stream is built, deployed and protected. |
| [Architecture](./docs/ARCHITECTURE.md) | Layer model, data flow, engine design. |
| [Features](./docs/FEATURES.md) | Full feature matrix. |
| [Content Inventory](./docs/CONTENT-INVENTORY.md) | Every video type, genre and content warning the editor surfaces. _(Also: [Vietnamese](./docs/i18n/vi/CONTENT-INVENTORY.md).)_ |
| [Content Inventory](./docs/CONTENT-INVENTORY.md) | Every video type, genre, content warning and tech note the editor surfaces. _(Also: [Vietnamese](./docs/i18n/vi/CONTENT-INVENTORY.md).)_ |
| [Roadmap](./docs/ROADMAP.md) | What shipped and what's next. |
| [Tech Spec](./docs/TECH-SPEC.md) | Implementation details and configs. |
| [i18n Guide](./docs/I18N.md) | Adding new locales. |
+2 -2
View File
@@ -6,8 +6,8 @@ Only the latest released version of YTDescGen receives security updates, and the
| Version | Supported |
| ------- | --------- |
| 1.0.x | ✅ |
| < 1.0 | ❌ |
| 1.2.x | ✅ |
| < 1.2 | ❌ |
## Reporting a Vulnerability
+3 -1
View File
@@ -2,7 +2,7 @@
## YTDescGen — Technical Architecture
Reflects **v1.0.0**. Implementation details (configs, interfaces, file formats, CI) are in [TECH-SPEC.md](TECH-SPEC.md); desktop and Android builds in [PACKAGING.md](PACKAGING.md); running the web deployment in [HOSTING.md](HOSTING.md).
Reflects **v1.2.0**. Implementation details (configs, interfaces, file formats, CI) are in [TECH-SPEC.md](TECH-SPEC.md); desktop and Android builds in [PACKAGING.md](PACKAGING.md); running the web deployment in [HOSTING.md](HOSTING.md).
---
@@ -325,6 +325,8 @@ Two sources, unioned by `useStrictBlock`, because neither alone is sufficient:
Both are filtered through `isRelevantIssueId`, so a field that isn't currently shown (`adEmail` / `gameKeyEmail` / `copyrightEmail` with split-email off, `zaloGroupLink` outside Vietnamese output) can never block on a value with no visible input to fix it. Strict Mode is opt-in; with it off, no gate blocks.
The three purpose emails (v1.1.0) go through one validator in both places: `validatePurposeEmails` (`src/utils/validation.ts`) is `validateEmails` plus a rule that the part before `@` of every address contains one of the field's words from `PURPOSE_EMAIL_KEYWORDS` (`src/config/contact-emails.ts`). `ContactEmailEditor` uses it to refuse the value and lists the words in each field's help text; `collectEditorIssues` uses it on saved values, so an older address without a word shows up for Strict Mode rather than being rewritten.
The first implementation registered issues from the inputs themselves and cleared on unmount. It typechecked and had passing tests, and did nothing: the fields live on the Editor page while the gates live on Batch / Social / Output, so navigating away cleared every issue. Deriving from state removes the mount coupling entirely.
## 4. i18n Architecture
+1 -2
View File
@@ -1,6 +1,6 @@
# Complete Feature List
## YTDescGen — All Features (v1.0.0 + Planned)
## YTDescGen — All Features (v1.2.0 + Planned)
---
@@ -523,4 +523,3 @@ See [ROADMAP.md](./ROADMAP.md) for the post-1.0 backlog.
| Template Marketplace | Share/import community templates | Medium |
| AI Tag Suggestions | Use game name to suggest trending tags | Medium |
| Thumbnail Text | Generate text overlay suggestions for thumbnails | Low |
| Multi-channel | Support multiple YouTube channels per profile | Low |
+6 -6
View File
@@ -341,15 +341,15 @@ npm run typecheck && npm run typecheck:all
## Locale Validation Script
The `scripts/validate-locales.ts` script checks every locale folder against
`_schema.json`. At v1.1.0 (1,253 UI + 574 template keys per locale):
`_schema.json`. At v1.2.0 (1,264 UI + 584 template keys per locale):
```
✓ en/ui.json — 1253/1253 keys
✓ en/templates.json — 574/574 keys
✓ es/ui.json — 1253/1253 keys
✓ es/templates.json — 574/574 keys
✓ en/ui.json — 1264/1264 keys
✓ en/templates.json — 584/584 keys
✓ es/ui.json — 1264/1264 keys
✓ es/templates.json — 584/584 keys
…
✓ zh/templates.json — 574/574 keys
✓ zh/templates.json — 584/584 keys
All locale files are complete!
```
+16 -10
View File
@@ -2,7 +2,7 @@
## YTDescGen — Tauri 2 Desktop and Android Apps
Reflects **v1.0.0**: Windows, macOS (Apple silicon) and Linux desktop apps plus an Android APK, all built from the same Tauri 2 project in `src-tauri/`. The web app is deployed separately — see [HOSTING.md](HOSTING.md).
Reflects **v1.2.0**: Windows, macOS (Apple silicon) and Linux desktop apps plus an Android APK, all built from the same Tauri 2 project in `src-tauri/`. The web app is deployed separately — see [HOSTING.md](HOSTING.md).
---
@@ -10,7 +10,7 @@ Reflects **v1.0.0**: Windows, macOS (Apple silicon) and Linux desktop apps plus
| Feature | Tauri 2 | Electron |
| ---------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| Download size | 3–6 MB installers (v0.38.0: MSI 4.6 MB, NSIS 3.2 MB, `.deb` 5.9 MB); the AppImage, which bundles its libraries, 80 MB | ~150 MB |
| Download size | 3–6 MB installers (v1.1.0: MSI 4.1 MB, NSIS 3.1 MB, `.deb` 5.3 MB); the AppImage, which bundles its libraries, 80 MB | ~150 MB |
| Memory usage | Lower — no second browser engine | Higher — bundled Chromium + Node.js |
| Bundled runtime | System WebView | Chromium |
| Backend language | Rust | Node.js |
@@ -30,6 +30,8 @@ The maintainer already knew Rust from the Tauri / build-tooling ecosystem; the s
- Linux: `libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev patchelf` (what CI installs).
- **Android**: see [Android (.apk) Packaging](#android-apk-packaging).
`npm run tauri info` prints the Rust toolchain, WebView, Node and bundler versions it finds, and the bundle targets — run it first when a build fails; most "Tauri won't build" problems are a version mismatch.
`npm run check:tauri` fails when the `@tauri-apps/*` npm packages and the `tauri` crates differ in major.minor — `tauri build` refuses to run in that state, and no workflow runs `tauri build` before a release tag does.
## Project Setup
@@ -60,7 +62,7 @@ The icons come from the one brand logo: `npx tauri icon assets/brand/logo.svg` r
{
"$schema": "https://raw.githubusercontent.com/tauri-apps/tauri/dev/crates/tauri-cli/schema.json",
"productName": "YTDescGen",
"version": "1.0.0",
"version": "1.2.0",
"identifier": "com.skullmute.ytdescgen",
"build": {
"beforeBuildCommand": "npm run build",
@@ -88,6 +90,7 @@ The icons come from the one brand logo: `npx tauri icon assets/brand/logo.svg` r
},
"bundle": {
"active": true,
"copyright": "Copyright 2026 poli0981 (SkullMute)",
"licenseFile": "installer-license.txt",
"icon": [
"icons/32x32.png",
@@ -116,6 +119,7 @@ Notes:
- There is **no `trayIcon` entry**: the tray icon is built in code (`lib.rs`), with the app icon — a `trayIcon` entry would add a second one.
- There is **no `updater` configuration** — see [Updates](#updates).
- `targets: "all"` builds every bundle the platform supports (MSI + NSIS on Windows, `.app` + `.dmg` on macOS, `.deb` + `.rpm` + AppImage on Linux); the release workflow narrows macOS to `.app`.
- `bundle.copyright` (v1.1.0) is the installers' copyright string — the Windows file properties, the macOS `Info.plist` and the Linux packages. `npm run check:copyright` (in CI) holds its year to the year of the newest commit, together with NOTICE and REUSE.toml, and `npm run update:copyright` rewrites all three: the first commit of a new year needs it.
> **Installer license page (v0.28).** The real `src-tauri/tauri.conf.json`
> sets `bundle.licenseFile: "installer-license.txt"` (path relative to
@@ -265,6 +269,8 @@ A release bumps the version in **six places**, and `npm run check:version` (in C
`npm version --no-git-tag-version <version>` covers the first three; the Rust / Tauri files are edited by hand (cargo also rewrites the `Cargo.lock` entry on the next non-`--locked` build or check in `src-tauri/`). Add the `CHANGELOG.md` entry in the same change.
The copyright year is not part of the version, but the first release of a new year needs `npm run update:copyright` first — `check:copyright` fails until then (see the `bundle.copyright` note above).
## Build & Release
### Development
@@ -289,17 +295,17 @@ npm run tauri:build
The Tauri CLI runs `npm run build` first (`beforeBuildCommand`) with `TAURI_ENV_PLATFORM` set, which switches Vite to the Tauri build: `es2020` target, the Legal Center content only, and no static legal pages, `security.txt` or analytics beacon.
Output file names, with the v0.38.0 release sizes:
Output file names, with the v1.1.0 release sizes:
| Platform | Bundle | File | Size |
| --------------------- | -------------------------------- | ---------------------------------------- | ------ |
| Windows | MSI | `YTDescGen_<version>_x64_en-US.msi` | 4.6 MB |
| Windows | NSIS | `YTDescGen_<version>_x64-setup.exe` | 3.2 MB |
| macOS (Apple silicon) | `.app`, archived by tauri-action | `YTDescGen_<version>_aarch64.app.tar.gz` | 4.4 MB |
| Linux | Debian | `YTDescGen_<version>_amd64.deb` | 5.9 MB |
| Linux | RPM | `YTDescGen-<version>-1.x86_64.rpm` | 5.9 MB |
| Windows | MSI | `YTDescGen_<version>_x64_en-US.msi` | 4.1 MB |
| Windows | NSIS | `YTDescGen_<version>_x64-setup.exe` | 3.1 MB |
| macOS (Apple silicon) | `.app`, archived by tauri-action | `YTDescGen_<version>_aarch64.app.tar.gz` | 4.1 MB |
| Linux | Debian | `YTDescGen_<version>_amd64.deb` | 5.3 MB |
| Linux | RPM | `YTDescGen-<version>-1.x86_64.rpm` | 5.3 MB |
| Linux | AppImage | `YTDescGen_<version>_amd64.AppImage` | 80 MB |
| Android | Universal APK | `app-universal-release.apk` | 57 MB |
| Android | Universal APK | `app-universal-release.apk` | 44 MB |
### GitHub Actions Release
+26 -5
View File
@@ -2,7 +2,7 @@
## YTDescGen — Phased Development Plan
> **Status (2026-09-30): v1.0.0 has shipped.** Phases 1–4 are the original
> **Status (2026-10-12): v1.2.0 is the current release.** Phases 1–4 are the original
> plan, kept as a record; notes added beside or under an item say what has
> changed since. Every release is listed in [CHANGELOG.md](../CHANGELOG.md).
> What's next: Phase 5 and the backlog at the end of this page.
@@ -69,7 +69,8 @@
1.8 Testing
- [x] Vitest config
- [x] Engine unit tests (title, description, tags) — 42 tests
- [ ] Smoke tests for main pages (deferred to Phase 3)
- [ ] Smoke tests for main pages (deferred to Phase 3; still open — the
suite runs in Node without a DOM, see the backlog)
1.9 CI/CD
- [x] GitHub Actions: lint + typecheck + test
@@ -260,7 +261,8 @@
### Definition of Done
- [x] Windows installer < 15MB (4.1MB MSI), installs and runs
- [ ] macOS .app < 15MB (CI-only, not locally testable)
- [x] macOS .app < 15MB (CI-only, not locally testable; 4.1 MB `.app.tar.gz`
in v1.1.0)
- [ ] Auto-update from GitHub Releases (deferred — needs signing)
- [x] All web features work identically in desktop
- [x] Offline mode fully functional
@@ -305,6 +307,22 @@ and Android all ship as 1.0.0 — the full list is in
---
## v1.1.0 — Contacts ✅ SHIPPED 2026-10-03
A copyright / DMCA email and purpose words for the split contact block, an
option to hide scrollbars, and copyright years checked in CI —
[CHANGELOG.md](../CHANGELOG.md#v110--2026-10-03).
## v1.2.0 — AI disclosure ✅ SHIPPED 2026-10-12
Content warnings for games made with generative AI (a new group of seven),
simulated gambling, in-game purchases and a tech note for upscaling /
frame-generation artifacts; a test that every warning and tech note is
translated; third-party notices, REUSE and the docs brought in line with the
code — [CHANGELOG.md](../CHANGELOG.md#v120--2026-10-12).
---
## Phase 5 — Extensions & Ecosystem (Priority: P2-P3)
**Goal**: IDE extension, CLI, community features.
@@ -345,7 +363,8 @@ and Android all ship as 1.0.0 — the full list is in
5.5 Quality of life
- [ ] YouTube API integration (auto-apply description)
- [ ] Tag trend analysis (what's trending for the genre)
- [ ] Multi-channel profile support
- [x] Multi-channel profile support — one profile per channel, as many
as you like; Quick start picks one per video (v1.0.0)
```
---
@@ -362,6 +381,8 @@ Ideas carried over from the v1.0.0 planning — not scheduled.
- [ ] PWA offline for the web — conflicts with the Turnstile gate in front of
the app
- [ ] PGP signature for security.txt
- [ ] Smoke tests for the main pages — needs a DOM test environment (the
suite runs in Node)
```
---
@@ -377,4 +398,4 @@ Ideas carried over from the v1.0.0 planning — not scheduled.
| Phase 5 | Extensions | Ongoing | — |
**MVP usable after Phase 1** (~3-4 days). Full-featured after Phase 3 (~7-10 days).
**v1.0.0 shipped on 2026-09-30.**
**v1.0.0 shipped on 2026-09-30; the current release is v1.2.0 (2026-10-12).**
+6 -4
View File
@@ -2,7 +2,7 @@
## YTDescGen — Implementation Details
Reflects **v1.0.0**. The module map and data flow are in [ARCHITECTURE.md](ARCHITECTURE.md), the desktop and Android builds in [PACKAGING.md](PACKAGING.md), and running the web deployment (Cloudflare Worker, Turnstile, secrets, rollback) in [HOSTING.md](HOSTING.md).
Reflects **v1.2.0**. The module map and data flow are in [ARCHITECTURE.md](ARCHITECTURE.md), the desktop and Android builds in [PACKAGING.md](PACKAGING.md), and running the web deployment (Cloudflare Worker, Turnstile, secrets, rollback) in [HOSTING.md](HOSTING.md).
---
@@ -13,7 +13,7 @@ Reflects **v1.0.0**. The module map and data flow are in [ARCHITECTURE.md](ARCHI
```json
{
"name": "yt-desc-gen",
"version": "1.0.0",
"version": "1.2.0",
"private": true,
"license": "Apache-2.0",
"type": "module",
@@ -495,6 +495,8 @@ v1.0.0 migration steps: editor v19, profiles v3 and templates v2 move the GPU to
v1.1.0: editor v20 back-fills `copyrightEmail` (the fourth split contact line) with `""`. `Profile.copyrightEmail` is optional, like the v1.0.0 additions, so the profile store stays at v3. The settings gain `hideScrollbars` without a version bump: `healSettings` back-fills and coerces it on every load, and the unchanged version keeps a 1.1.0 settings backup restorable on 1.0.0.
v1.2.0: nine content-warning ids and one tech note, and no version bump anywhere — the lists only widen. The backup whitelist (`choiceList` in `src/utils/backup/sanitize.ts`) checks against `CONTENT_WARNINGS` / `TECH_NOTES`, so a 1.1.0 build restoring a 1.2.0 backup keeps everything except the ids it doesn't know.
Rules:
- **localStorage is the only store**, on the web, desktop and Android. The desktop "mirror" file of earlier versions (`storage-adapter.ts`, `saveSettings`, `checkDataFileHealth`) was removed in v1.0.0; it was written next to the data folder and never read back. [PACKAGING.md](PACKAGING.md) covers how the leftover file is recovered.
@@ -609,7 +611,7 @@ The `check` job, in order:
## 6. Testing Strategy
Vitest runs `tests/**/*.test.{ts,tsx}` and `src/**/*.test.{ts,tsx}` in the **node** environment, with `globals: true`: 930 tests in 48 files at v1.0.0. Directories: `tests/engine`, `store`, `utils` (backup detect / sanitize / restore, quick entry, validation, the migration page), `worker` (router, cookie, Turnstile verdicts, headers, gate language), `build` (legal pages, web-only plugins), `config`, `hooks`, `i18n`, `scripts`. No test renders components: React Testing Library is installed but jsdom is not, so a rendering test would need both jsdom and a `// @vitest-environment jsdom` docblock.
Vitest runs `tests/**/*.test.{ts,tsx}` and `src/**/*.test.{ts,tsx}` in the **node** environment, with `globals: true`: 984 tests in 51 files at v1.2.0. Directories: `tests/engine`, `store`, `utils` (backup detect / sanitize / restore, quick entry, validation, the migration page), `worker` (router, cookie, Turnstile verdicts, headers, gate language), `build` (legal pages, web-only plugins), `config`, `hooks`, `i18n`, `scripts`. No test renders components: React Testing Library is installed but jsdom is not, so a rendering test would need both jsdom and a `// @vitest-environment jsdom` docblock.
Engine tests build a full `GeneratorInput` and pass a mock translator (`tests/helpers/mock-t.ts`) that reads the real `templates.json` files (en, vi, ja):
@@ -658,7 +660,7 @@ describe("buildTitle", () => {
| `src/engine/**` | 88 % | 85 % | 60 % | 88 % |
| `worker/**` (excluding `worker/index.ts`) | 95 % | 85 % | 95 % | 95 % |
Guard tests worth knowing: `tests/hooks/render-options-parity.test.ts` (settings → engine options), `tests/hooks/generator-input-mapping.test.ts` (editor → engine input), `tests/i18n/locale-registration.test.ts` (language registration in both directions), the genre/tag-pool sync in `tests/engine/tag-generator.test.ts`, and `tests/worker/headers.test.ts` (keeps the Worker's baseline headers in step with `public/_headers`). The Rust side has its own `cargo test` suite (name validation, path rejection, pruning, legacy recovery, dialog filters).
Guard tests worth knowing: `tests/hooks/render-options-parity.test.ts` (settings → engine options), `tests/hooks/generator-input-mapping.test.ts` (editor → engine input), `tests/i18n/locale-registration.test.ts` (language registration in both directions), `tests/config/content-warning-groups.test.ts` and `tech-note-groups.test.ts` (every id in exactly one group, with an editor label and a description line in `_schema.json` — v1.2.0), the genre/tag-pool sync in `tests/engine/tag-generator.test.ts`, and `tests/worker/headers.test.ts` (keeps the Worker's baseline headers in step with `public/_headers`). The Rust side has its own `cargo test` suite (name validation, path rejection, pruning, legacy recovery, dialog filters).
## 7. YouTube Character Limits Reference
+1 -1
View File
@@ -6,7 +6,7 @@
YTDescGen là dự án cá nhân do một người duy trì (`@poli0981`) để dùng cho kênh YouTube [`@SkullMute`](https://www.youtube.com/@SkullMute), và chia sẻ công khai dưới dạng mã nguồn mở. Đây **không phải sản phẩm thương mại** và không có nghĩa vụ hỗ trợ.
Mã nguồn, tài liệu, bản dịch locale, và các quyết định thiết kế trong repo này được **đồng tác giả với sự hỗ trợ của Anthropic's Claude Code (các model Claude Opus; bản v1.0.0 dùng Claude Opus 5.5)**. Tất cả commit, release, và quyết định kiến trúc được người duy trì xem xét và phê duyệt trước khi merge.
Mã nguồn, tài liệu, bản dịch locale, và các quyết định thiết kế trong repo này được **đồng tác giả với sự hỗ trợ của Anthropic's Claude Code (các model Claude Opus; từ bản v1.0.0 đến v1.2.0 dùng Claude Opus 5.5)**. Tất cả commit, release, và quyết định kiến trúc được người duy trì xem xét và phê duyệt trước khi merge.
Tuyên bố này áp dụng cho:
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "yt-desc-gen",
"version": "1.1.0",
"version": "1.2.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "yt-desc-gen",
"version": "1.1.0",
"version": "1.2.0",
"license": "Apache-2.0",
"dependencies": {
"@fontsource-variable/inter": "^5.3.0",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "yt-desc-gen",
"version": "1.1.0",
"version": "1.2.0",
"private": true,
"license": "Apache-2.0",
"type": "module",
+1 -1
View File
@@ -5024,7 +5024,7 @@ dependencies = [
[[package]]
name = "yt-desc-gen"
version = "1.1.0"
version = "1.2.0"
dependencies = [
"serde",
"tauri",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "yt-desc-gen"
version = "1.1.0"
version = "1.2.0"
description = "YouTube Gameplay Description Generator"
authors = ["poli0981"]
edition = "2021"
+1 -1
View File
@@ -1,7 +1,7 @@
{
"$schema": "https://raw.githubusercontent.com/tauri-apps/tauri/dev/crates/tauri-cli/schema.json",
"productName": "YTDescGen",
"version": "1.1.0",
"version": "1.2.0",
"identifier": "com.skullmute.ytdescgen",
"build": {
"beforeBuildCommand": "npm run build",
+3 -2
View File
@@ -28,8 +28,9 @@ export const ABOUT = {
},
/**
* One address per purpose, so a message lands with whoever handles it.
* Keep in sync with SECURITY.md, PRIVACY.md, TERMS.md, NOTICE and
* public/.well-known/security.txt.
* Keep in sync with SECURITY.md, PRIVACY.md, TERMS.md, NOTICE and the
* `/.well-known/security.txt` that `renderSecurityTxt` in
* build-plugins/web-only.ts writes at build time.
*/
contacts: {
general: "contact@poli0981.dev",
+3 -3
View File
@@ -2,9 +2,9 @@
* Vietnamese banks dropdown options for the donate / Vietnam-specific
* bank field. Sourced from the State Bank of Vietnam's published list
* (sbv.gov.vn) of operating credit institutions as of 2026: Big 4
* state-owned commercial banks, top 22 joint-stock commercial banks
* (TMCP) by retail presence, and the four most-recognised 100%
* foreign-owned banks operating in Vietnam.
* state-owned commercial banks, 24 joint-stock commercial banks (TMCP)
* by retail presence, five renamed in 2025 or digital-first, and the four
* most-recognised 100% foreign-owned banks operating in Vietnam.
*
* Order is intentional, not alphabetical: Big 4 first (highest brand
* recognition for retail transfers), then the dominant private TMCP
-70
View File
@@ -1,70 +0,0 @@
# Tauri 2 desktop build prerequisites
YTDescGen ships a Tauri 2 desktop shell alongside the web build. This file
covers the per-platform native dependencies you need before
`npm run tauri:dev` or `npm run tauri:build` will succeed.
The hardware reference and toolchain versions are documented in
[`../docs/DEVELOPMENT.md`](../docs/DEVELOPMENT.md)
(Vietnamese mirror: [`../docs/i18n/vi/DEVELOPMENT.md`](../docs/i18n/vi/DEVELOPMENT.md)).
## All platforms
- **Rust stable** via `rustup`. Tauri 2 currently tracks the latest stable.
- **Node.js ≥ 25.8.1**. Tauri-action in CI uses Node 22; locally we use ≥ 25
so the JetBrains and VS Code dev tools have a single shared LTS.
```bash
rustup update stable
rustup target add x86_64-pc-windows-msvc # Windows
rustup target add aarch64-apple-darwin # Apple Silicon
rustup target add x86_64-unknown-linux-gnu # Linux
```
## Windows
- **MSVC build tools** — install via "Desktop development with C++" workload in
Visual Studio Installer, or `winget install Microsoft.VisualStudio.2022.BuildTools`.
- **WebView2 Runtime** — ships with Windows 11; on Windows 10 you may need
to install the Evergreen Bootstrapper from Microsoft.
- Default bundles produced: MSI installer + NSIS `.exe`.
## macOS
- **Xcode Command Line Tools** — `xcode-select --install`.
- **Apple Silicon only** for hosted CI; Intel is not in the matrix anymore.
- Bundling DMG on hosted runners has historically flaked inside
`bundle_dmg.sh`. The release matrix builds the `.app` bundle and tar-gzips
it (`--bundles app`). Users expand and drag-drop into `/Applications`.
## Linux
Hosted Ubuntu runners need these apt packages:
```bash
sudo apt-get update
sudo apt-get install -y \
libwebkit2gtk-4.1-dev \
libgtk-3-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
patchelf
```
Default bundles produced: AppImage + `.deb`.
## Verifying the toolchain
```bash
npm run tauri info
```
`tauri info` prints versions of Rust, the WebView, the Node runtime, and the
detected bundle targets. Use this before opening a bug — most "Tauri won't
build" reports are version mismatches.
## CI reference
Release builds run on tagged pushes via
[`.github/workflows/release-desktop.yml`](../.github/workflows/release-desktop.yml).
That file is the source of truth for what versions actually shipped.