Skip to content

OpenLyricSync v0.1.0

Latest
Latest

Choose a tag to compare

View all tags
@TCeramic TCeramic released this 02 Aug 12:14
· 3 commits to main since this release
v0.1.0
d29ca60
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

OpenLyricSync 0.1.0 release notes

  • Date: 2026-08-02
  • Status: GitHub source release

These notes define the 0.1.0 GitHub source release. The release contains the
buildable workspace and public package metadata; it does not claim that either
package has also been published to the npm registry.

Canonical repository: https://github.com/TCeramic/OpenLyricSync
Release page: https://github.com/TCeramic/OpenLyricSync/releases/tag/v0.1.0

Highlights

  • A provider-neutral TypeScript core for timed-lyric workflows.
  • A local-only Node.js CLI with JSON output suitable for scripts.
  • Explicit clean-room, provider, security, privacy, and compatibility
    boundaries.
  • Automated tests and a non-publishing CI verification workflow.

Public core surface

  • parseLrc
  • getCurrentLyricLine
  • alignLyricTimelines
  • matchTrack
  • resolvePlaybackState
  • Public input, option, and result types associated with those functions

See API reference for the exact signatures.

CLI surface

  • openlyricsync parse <lyrics.lrc>
  • openlyricsync current <lyrics.lrc> <time-ms>
  • openlyricsync align <original.lrc> <other.lrc>
  • openlyricsync match <wanted.json> <found.json>
  • openlyricsync --help
  • openlyricsync --version

Data commands write JSON to stdout. Expected input/processing failures return a
non-zero exit code and a concise stderr diagnostic.

Runtime and compatibility

  • Node.js 22.13 or later
  • Native ESM
  • UTF-8 LRC and JSON files in the CLI
  • Millisecond numeric time values

The source is intended to remain portable across Node.js-supported desktop and
server platforms. The handoff does not claim an installed-package test across
every supported operating system or Node.js release.

Provider and privacy boundary

No core or CLI code authenticates with, requests data from, or stores credentials
for a music provider. Consumers must implement authorized provider adapters,
normalize their data into the public types, and keep secrets out of repository
files and diagnostics.

Verification

The repository gate is:

pnpm verify

Focused CLI verification is:

pnpm --filter @openlyricsync/cli lint
pnpm --filter @openlyricsync/cli typecheck
pnpm --filter @openlyricsync/cli test
pnpm --filter @openlyricsync/cli build

The included tests cover CLI help/version, real temporary UTF-8 file parsing,
current-line lookup, alignment, canonical track matching, malformed input, and
error exit codes. During the 2026-08-02 source handoff, CLI lint, typecheck, 10
tests, and build passed with bundled Node.js 24.14.0 on Windows; the focused
core suite also passed 9 tests. The compiled CLI entry was smoke-tested with
help and local LRC parsing. A local pnpm pack inspection confirmed that the
CLI archive contains its README, license, declarations, source maps, executable
entry, and an exact @openlyricsync/core 0.1.0 dependency. The checked-in CI
workflow defines clean Node.js 22.13/24 verification; GitHub Actions is the source
of truth for the release commit's remote result.

Not included in 0.1.0

  • Provider authentication, catalog search, scraping, or lyric downloads
  • Token, cookie, or account storage
  • Enhanced word-level or provider-encrypted lyric formats
  • Audio fingerprinting or content recognition
  • Browser, Electron, or mobile application UI
  • npm registry publication

Upgrade notes

This is the first public source contract in the repository, so there is no prior
OpenLyricSync version to migrate. Consumers should depend on canonical exported
types rather than provider response aliases.

Assets 6
Loading