sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-03-30 06:12:06 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
6ae3888b530a04e1e3ca9faa27e28fabc61933b3
SubMiner/docs-site/changelog.md
sudacode 35adf8299c Refactor startup, queries, and workflow into focused modules (#36) 
* chore(backlog): add mining workflow milestone and tasks

* refactor: split character dictionary runtime modules

* refactor: split shared type entrypoints

* refactor: use bun serve for stats server

* feat: add repo-local subminer workflow plugin

* fix: add stats server node fallback

* refactor: split immersion tracker query modules

* chore: update backlog task records

* refactor: migrate shared type imports

* refactor: compose startup and setup window wiring

* Add backlog tasks and launcher time helper tests

- Track follow-up cleanup work in Backlog.md
- Replace Date.now usage with shared nowMs helper
- Add launcher args/parser and core regression tests

* test: increase launcher test timeout for CI stability

* fix: address CodeRabbit review feedback

* refactor(main): extract remaining inline runtime logic from main

* chore(backlog): update task notes and changelog fragment

* refactor: split main boot phases

* test: stabilize bun coverage reporting

* Switch plausible endpoint and harden coverage lane parsing

- update docs-site tracking to use the Plausible capture endpoint
- tighten coverage lane argument and LCOV parsing checks
- make script entrypoint use CommonJS main guard

* Restrict docs analytics and build coverage input

- limit Plausible init to docs.subminer.moe
- build Yomitan before src coverage lane

* fix(ci): normalize Windows shortcut paths for cross-platform tests

* Fix verification and immersion-tracker grouping

- isolate verifier artifacts and lease handling
- switch weekly/monthly tracker cutoffs to calendar boundaries
- tighten boot lifecycle and zip writer tests

* fix: resolve CI type failures in boot and immersion query tests

* fix: remove strict spread usage in Date mocks

* fix: use explicit super args for MockDate constructors

* Factor out mock date helper in tracker tests

- reuse a shared `withMockDate` helper for date-sensitive query tests
- make monthly rollup assertions key off `videoId` instead of row order

* fix: use variadic array type for MockDate constructor args

TS2367: fixed-length tuple made args.length === 0 unreachable.

* refactor: remove unused createMainBootRuntimes/Handlers aggregate functions

These functions were never called by production code — main.ts imports
the individual composeBoot* re-exports directly.

* refactor: remove boot re-export alias layer

main.ts now imports directly from the runtime/composers and runtime/domains
modules, eliminating the intermediate boot/ indirection.

* refactor: consolidate 3 near-identical setup window factories

Extract shared createSetupWindowHandler with a config parameter.
Public API unchanged.

* refactor: parameterize duplicated getAffected*Ids query helpers

Four structurally identical functions collapsed into two parameterized
helpers while preserving the existing public API.

* refactor: inline identity composers (stats-startup, overlay-window)

composeStatsStartupRuntime was a no-op that returned its input.
composeOverlayWindowHandlers was a 1-line delegation.
Both removed in favor of direct usage.

* chore: remove unused token/queue file path constants from main.ts

* fix: replace any types in boot services with proper signatures

* refactor: deduplicate ensureDir into shared/fs-utils

5 copies of mkdir-p-if-not-exists consolidated into one shared module
with ensureDir (directory path) and ensureDirForFile (file path) variants.

* fix: tighten type safety in boot services

- Add AppLifecycleShape and OverlayModalInputStateShape constraints
  so TAppLifecycleApp and TOverlayModalInputState generics are bounded
- Remove unsafe `as { handleModalInputStateChange? }` cast — now
  directly callable via the constraint
- Use `satisfies AppLifecycleShape` for structural validation on the
  appLifecycleApp object literal
- Document Electron App.on incompatibility with simple signatures

* refactor: inline subtitle-prefetch-runtime-composer

The composer was a pure pass-through that destructured an object and
reassembled it with the same fields. Inlined at the call site.

* chore: consolidate duplicate import paths in main.ts

* test: extract mpv composer test fixture factory to reduce duplication

* test: add behavioral assertions to composer tests

Upgrade 8 composer test files from shape-only typeof checks to behavioral
assertions that invoke returned handlers and verify injected dependencies are
actually called, following the mpv-runtime-composer pattern.

* refactor: normalize import extensions in query modules

* refactor: consolidate toDbMs into query-shared.ts

* refactor: remove Node.js fallback from stats-server, use Bun only

* Fix monthly rollup test expectations

- Preserve multi-arg Date construction in mock helper
- Align rollup assertions with the correct videoId

* fix: address PR 36 CodeRabbit follow-ups

* fix: harden coverage lane cleanup

* fix(stats): fallback to node server when Bun.serve unavailable

* fix(ci): restore coverage lane compatibility

* chore(backlog): close TASK-242

* fix: address latest CodeRabbit review round

* fix: guard disabled immersion retention windows

* fix: migrate discord rpc wrapper

* fix(ci): add changelog fragment for PR 36

* fix: stabilize macOS visible overlay toggle

* fix: pin installed mpv plugin to current binary

* fix: strip inline subtitle markup from sidebar cues

* fix(renderer): restore subtitle sidebar mpv passthrough

* feat(discord): add configurable presence style presets

Replace the hardcoded "Mining and crafting (Anki cards)" meme message
with a preset system. New `discordPresence.presenceStyle` option
supports four presets: "default" (clean bilingual), "meme" (the OG
Minecraft joke), "japanese" (fully JP), and "minimal". The default
preset shows "Sentence Mining" with 日本語学習中 as the small image
tooltip. Existing users can set presenceStyle to "meme" to keep the
old behavior.

* fix: finalize v0.10.0 release prep

* docs: add subtitle sidebar guide and release note

* chore(backlog): mark docs task done

* fix: lazily resolve youtube playback socket path

* chore(release): build v0.10.0 changelog

* Revert "chore(release): build v0.10.0 changelog"

This reverts commit 9741c0f020.
2026-03-29 16:16:29 -07:00

12 KiB
Raw Blame History

Changelog

v0.10.0 (2026-03-29)

  • Fixed stats startup so the immersion tracker can run when Bun.serve is unavailable.
  • Added a Node http fallback for Electron/runtime paths that do not expose Bun, so stats keeps working there too.
  • Updated Discord Rich Presence to the maintained @xhayper/discord-rpc wrapper.
  • Fixed the macOS visible-overlay toggle path so manual hides stay hidden and the plugin uses the explicit visible-overlay toggle command.
  • Restored macOS mpv passthrough while the overlay subtitle sidebar is open so clicks outside the sidebar can refocus mpv and keep native keybindings working.

v0.9.3 (2026-03-25)

  • Moved YouTube primary subtitle language defaults to youtube.primarySubLanguages.
  • Removed the placeholder YouTube subtitle retime step; downloaded primary subtitle tracks are now used directly.
  • Removed the old internal YouTube retime helper and its tests.
  • Clarified optional alass / ffsubsync subtitle-sync setup and fallback behavior in the docs.
  • Removed the legacy youtubeSubgen.primarySubLanguages config path from generated config and docs.

v0.9.2 (2026-03-25)

  • Fixed overlay pointer tracking so Windows click-through toggles immediately when the cursor enters or leaves subtitle regions.
  • Fixed Windows overlay window tracking on scaled displays by converting native tracked window bounds to Electron DIP coordinates.
  • Fixed Windows direct --youtube-play startup so MPV boots reliably, stays paused until the app-owned subtitle flow is ready, and reuses an already-running SubMiner instance.
  • Fixed standalone Windows --youtube-play sessions so closing MPV fully exits SubMiner instead of leaving hidden overlay windows behind.
  • Fixed subminer <youtube-url> on Linux so the YouTube playback flow waits for Yomitan to load before creating the overlay window.

v0.9.1 (2026-03-24)

  • Reduced packaged release size by excluding duplicate extraResources payload and pruning docs, tests, sourcemaps, and other source-only files from Electron bundles.
  • Restored controller navigation and lookup/mining controls while the subtitle sidebar is open, while keeping true modal dialogs blocking controller actions.
  • Fixed subtitle annotation clearing so explanatory contrast endings like んですけど are excluded consistently across the shared tokenizer filter and annotation stage.

v0.9.0 (2026-03-23)

  • Added an app-owned YouTube subtitle flow with absPlayer-style timedtext parsing that auto-loads the default primary subtitle plus a best-effort secondary at startup and resumes once the primary is ready.
  • Added a manual YouTube subtitle picker on Ctrl+Alt+C so subtitle selection can be retried on demand during active YouTube playback.
  • Added yt-dlp metadata probing so YouTube playback and immersion tracking record canonical video title and channel metadata.
  • Disabled conflicting mpv native subtitle auto-selection for the app-owned flow so injected explicit tracks stay authoritative.
  • Added OSD status updates covering YouTube playback startup, subtitle acquisition, and subtitle loading.
  • Stopped forcing --ytdl-raw-options= before user-provided mpv options so existing YouTube cookie integrations are preserved.
  • Improved sidebar startup/resume behavior, scroll handling, and overlay/sidebar subtitle synchronization.
  • Stats Library tab now shows YouTube video title, channel name, and thumbnail for YouTube media entries.
  • Added a new WebSocket / Texthooker API integration guide covering payload formats, custom client patterns, and mpv plugin automation.
  • Fixed Anki media mining for mpv YouTube streams so audio and screenshot capture work correctly during YouTube playback sessions.
  • Fixed YouTube media path handling in immersion tracking so YouTube sessions record correct media references and AniList state transitions do not fire for YouTube media.
  • Reused existing authoritative YouTube subtitle tracks when present, fell back only for missing sides, and kept native mpv secondary subtitle rendering hidden so the overlay remains the visible secondary subtitle surface.

v0.8.0 (2026-03-22)

  • Added a configurable subtitle sidebar feature (subtitleSidebar) with overlay/embedded rendering, click-to-seek cue list, and hot-reloadable visibility and behavior controls.
  • Added a rendered sidebar modal with cue list display, click-to-seek, active-cue highlighting, and embedded layout support.
  • Added sidebar snapshot plumbing between main and renderer for overlay/sidebar synchronization.
  • Added sidebar configuration options for visibility and behavior (enabled, layout, toggle key, autoOpen, pauseOnHover, autoScroll) plus typography and sizing controls.
  • Documented subtitleSidebar configuration and behavior in user-facing docs (configuration.md, shortcuts.md, config.example.jsonc).
  • Updated subtitle prefetch/rendering flow to keep overlay and sidebar state in sync through media transitions.
  • Kept sidebar cue tracking stable across playback transitions and timing edge cases.
  • Fixed sidebar startup/resume positioning to jump directly to the first resolved active cue.
  • Prevented stale subtitle refreshes from regressing active-cue state.

v0.7.0 (2026-03-19)

  • Added a full local immersion dashboard release line with Overview, Library, Trends, Vocabulary, and Sessions drill-down views backed by SQLite tracking data.
  • Added browser-first stats workflows: subminer stats, background stats daemon controls (-b / -s), stats cleanup, and dashboard-side mining actions with media enrichment.
  • Improved stats accuracy and scale handling with Yomitan token counts, full session timelines, known-word timeline fixes, cross-media vocabulary fixes, and clearer session charts.
  • Improved overlay/runtime stability with quieter macOS fullscreen recovery, reduced repeated loading OSD popups, and better frequency/noise handling for subtitle annotations.
  • Added launcher mpv-args passthrough plus Linux plugin wrapper-name fallback for packaged installs.
  • Added a hover-revealed ↗ button on Sessions tab rows to navigate directly to the anime media-detail view, with correct "Back to Sessions" back-navigation.
  • Excluded auxiliary-stem そうだ grammar tails (MeCab POS3 助動詞語幹) from subtitle annotation metadata so frequency, JLPT, and N+1 styling no longer bleed onto grammar-tail tokens.

v0.6.5 (2026-03-15)

  • Seeded the AUR checkout with the repo .SRCINFO template before rewriting metadata so tagged releases do not depend on prior AUR state.

v0.6.4 (2026-03-15)

  • Reworked AUR metadata generation to update .SRCINFO directly instead of depending on runner makepkg, fixing tagged release publishing for subminer-bin.

v0.6.3 (2026-03-15)

  • Expanded Alt+C into an inline controller config/remap flow with preferred-controller saving and per-action learn mode for buttons, triggers, and stick directions.
  • Automated subminer-bin AUR package updates from the tagged release workflow.

v0.6.2 (2026-03-12)

  • Added yomitan.externalProfilePath so SubMiner can reuse another Electron app's Yomitan profile in read-only mode.
  • Reused external Yomitan dictionaries/settings without writing back to that profile.
  • Let launcher-managed playback honor external Yomitan config instead of forcing first-run setup.
  • Seeded config.jsonc even when the default config directory already exists.
  • Let first-run setup complete without internal dictionaries while external Yomitan is configured, then require an internal dictionary again only if that external profile is later removed.

v0.6.1 (2026-03-12)

  • Added Chrome Gamepad API controller support for keyboard-only overlay mode.
  • Added configurable controller bindings for lookup, mining, popup navigation, Yomitan audio, mpv pause, and d-pad fallback navigation.
  • Added smooth, slower popup scrolling for controller navigation.
  • Expanded Alt+C into a controller config/remap modal with preferred-controller saving, inline learn mode, and kept Alt+Shift+C for raw input debugging.
  • Added a transient in-overlay controller-detected indicator when a controller is first found.
  • Fixed cleanup of stale keyboard-only token highlights when keyboard-only mode is disabled or when the Yomitan popup closes.
  • Added an enforced verify:config-example gate so checked-in example config artifacts cannot drift silently.

v0.5.6 (2026-03-10)

  • Persisted merged character-dictionary MRU state as soon as a new retained set is built so revisits do not get dropped if later Yomitan import work fails.
  • Fixed early Electron startup writing config and user data under a lowercase ~/.config/subminer path instead of canonical ~/.config/SubMiner.
  • Kept JLPT underline colors stable during Yomitan hover and selection states, even when tokens also use known, N+1, name-match, or frequency styling.

v0.5.1 (2026-03-09)

  • Removed the old YouTube subtitle-generation mode switch; YouTube playback now resolves subtitles before mpv starts.
  • Hardened YouTube AI subtitle fixing so fenced/text-only responses keep original cue timing.
  • Skipped AniSkip during URL/YouTube playback where anime metadata cannot be resolved reliably.
  • Kept the background SubMiner process warm across launcher-managed mpv exits so reconnects do not repeat startup pause/warmup work.
  • Fixed Windows single-instance reuse so overlay and video launches reuse the running background app instead of booting a second full app.
  • Hardened the Windows signing/release workflow with SignPath retry handling for signed .exe and .zip artifacts.

v0.5.0 (2026-03-08)

  • Added the initial packaged Windows release.
  • Added Windows-native mpv window tracking, launcher/runtime plumbing, and packaged helper assets.
  • Improved close behavior so ending playback hides the visible overlay while the background app stays running.
  • Limited the native overlay outline/debug frame to debug mode on Windows.

v0.3.0 (2026-03-05)

  • Added keyboard-driven Yomitan navigation and popup controls, including optional auto-pause.
  • Added subtitle/jump keyboard handling fixes for smoother subtitle playback control.
  • Improved Anki/Yomitan reliability with stronger Yomitan proxy syncing and safer extension refresh logic.
  • Added Subsync replace option and deterministic retime naming for subtitle workflows.
  • Moved aniskip resolution to launcher-script options for better control.
  • Tuned tokenizer frequency highlighting filters for improved term visibility.
  • Added release build quality-of-life for CLI publish (gh-based clobber upload).
  • Removed docs Plausible integration and cleaned associated tracker settings.

v0.2.3 (2026-03-02)

  • Added performance and tokenization optimizations (faster warmup, persistent MeCab usage, reduced enrichment lookups).
  • Added subtitle controls for no-jump delay shifts.
  • Improved subtitle highlight logic with priority and reliability fixes.
  • Fixed plugin loading behavior to keep OSD visible during startup.
  • Fixed Jellyfin remote resume behavior and improved autoplay/tokenization interaction.
  • Updated startup flow to load dictionaries asynchronously and unblock first tokenization sooner.

v0.2.2 (2026-03-01)

  • Improved subtitle highlighting reliability for frequency modes.
  • Fixed Jellyfin misc info formatting cleanup.
  • Version bump maintenance for 0.2.2.

v0.2.1 (2026-03-01)

  • Delivered Jellyfin and Subsync fixes from release patch cycle.
  • Version bump maintenance for 0.2.1.

v0.2.0 (2026-03-01)

  • Added task-related release work for the overlay 2.0 cycle.
  • Introduced Overlay 2.0.
  • Improved release automation reliability.

v0.1.2 (2026-02-24)

  • Added encrypted AniList token handling and default GNOME keyring support.
  • Added launcher passthrough for password-store flows (Jellyfin path).
  • Updated docs for auth and integration behavior.
  • Version bump maintenance for 0.1.2.

v0.1.1 (2026-02-23)

  • Fixed overlay modal focus handling (grab input) behavior.
  • Version bump maintenance for 0.1.1.

v0.1.0 (2026-02-23)

  • Bootstrapped Electron runtime, services, and composition model.
  • Added runtime asset packaging and dependency vendoring.
  • Added project docs baseline, setup guides, architecture notes, and submodule/runtime assets.
  • Added CI release job dependency ordering fixes before launcher build.
Reference in New Issue View Git Blame Copy Permalink