trackparse 0.3.1 → 0.3.3

package/README.md

@@ -7,6 +7,8 @@ Parse music track names into structured metadata: artists, featured artists, rem
 [![js](https://img.shields.io/github/actions/workflow/status/4matic/trackparse/js.yml?branch=main&label=js)](https://github.com/4matic/trackparse/actions/workflows/js.yml)
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/4matic/trackparse/blob/main/LICENSE)
 
+**[Documentation](https://4matic.github.io/trackparse/)** · **[Playground](https://4matic.github.io/trackparse/playground/)**
+
 This is the JavaScript/TypeScript reference implementation of the
 [trackparse spec](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md). It passes all
 12,965 shared fixtures. Zero dependencies, ESM and CommonJS, TypeScript types included, never
@@ -27,6 +29,8 @@ Node 18 or later. No Node-specific APIs are used, so it also runs in browsers an
 
 ## Quick start
 
+**Docs:** [Getting started](https://4matic.github.io/trackparse/start/getting-started/)
+
 ```js
 import { parse } from "trackparse";
 // const { parse } = require("trackparse");
@@ -49,12 +53,16 @@ track.mode;                        // 'youtube' (auto-detected from the junk gro
 
 ## API
 
+**Docs:** [parse and ParsedTrack](https://4matic.github.io/trackparse/reference/parse/) · [Other functions](https://4matic.github.io/trackparse/reference/functions/)
+
 ### `parse(input, options?) → ParsedTrack`
 
 Parses one track string. Every key of the result is always present.
 
 ### `parseArtists(input, options?) → Artist[]`
 
+**Docs:** [parseArtists](https://4matic.github.io/trackparse/reference/functions/#parseartistsinput-options)
+
 Splits an artist string (no title) into credits.
 
 ```js
@@ -69,6 +77,8 @@ parseArtists("Sub Focus, Wilkinson & Dimension feat. Kojo");
 
 ### `format(track, options?) → string`
 
+**Docs:** [format](https://4matic.github.io/trackparse/reference/functions/#formattrack-options) · [Formatting](https://4matic.github.io/trackparse/guides/formatting/)
+
 Renders a `ParsedTrack` back to `Artists - Title (versions) (prod. ...)`.
 
 ```js
@@ -90,6 +100,8 @@ format(t, { feat: "omit", versions: "none" });      // 'Wilkinson - Afterglow'
 
 ### `normalize(input) → string`
 
+**Docs:** [normalize](https://4matic.github.io/trackparse/reference/functions/#normalizeinput)
+
 The Unicode cleanup applied before parsing: NFC, zero-width spaces, BOM and soft hyphens removed, fullwidth
 brackets, smart quotes and dash variants mapped to ASCII, whitespace collapsed. Idempotent.
 
@@ -100,6 +112,8 @@ normalize("  Artist​ — Title （Remix）  “Quoted”  ");
 
 ### `allArtists(track) → Artist[]`
 
+**Docs:** [allArtists](https://4matic.github.io/trackparse/reference/functions/#allartiststrack)
+
 Track credits plus every version's remixers, deduplicated.
 
 ```js
@@ -110,6 +124,8 @@ allArtists(parse("Camo & Krooked - Kallisto (Noisia Remix)", { knownArtists: ["C
 
 ### `createParser(options) → { parse, parseArtists }`
 
+**Docs:** [createParser](https://4matic.github.io/trackparse/reference/functions/#createparseroptions)
+
 Compiles options, including extra vocabulary, once. Per-call options are merged over the base.
 
 ```js
@@ -131,6 +147,8 @@ The spec version this build implements, e.g. `"0.3.0"`. Always equal to the pack
 
 ## Options
 
+**Docs:** [Options](https://4matic.github.io/trackparse/reference/options/)
+
 | Option | Default | Effect |
 |---|---|---|
 | `mode` | `"auto"` | `"clean"` (tags, store metadata), `"youtube"` (video titles), `"filename"`, `"tracklist"` (one line of a tracklist), or `"auto"` to detect. |
@@ -197,12 +215,16 @@ interface Version {
   `bySplit`, `quotedTitleSplit`, `ambiguousMixCredit`, `unbalancedBrackets`.
 
 The full field reference, a gallery of examples and the comparison with other libraries are in the
-[main README](https://github.com/4matic/trackparse#readme). Exact behaviour is defined by the
+[documentation](https://4matic.github.io/trackparse/): [`parse` and ParsedTrack](https://4matic.github.io/trackparse/reference/parse/),
+[options](https://4matic.github.io/trackparse/reference/options/), [warnings](https://4matic.github.io/trackparse/reference/warnings/),
+[what it understands](https://4matic.github.io/trackparse/guides/what-it-understands/). Exact behaviour is defined by the
 [spec](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md) and its
 [fixtures](https://github.com/4matic/trackparse/tree/main/spec/fixtures).
 
 ## Tracklists
 
+**Docs:** [Tracklists](https://4matic.github.io/trackparse/guides/tracklists/) · [Editing tracklists](https://4matic.github.io/trackparse/guides/editing-tracklists/)
+
 `trackparse/tracklist` parses a whole tracklist: one entry per line with its kind, start time and
 a full `ParsedTrack`, plus checks with line numbers. Joining `raw + eol` over the entries gives the
 input back byte for byte, whatever the line endings. It's a separate entry point (about 7.6 KiB
@@ -279,11 +301,13 @@ parse("Electrosoul System - Liquid Metal").title;                         // 'El
 parse("Electrosoul System - Liquid Metal", { mode: "tracklist" }).title;  // 'Liquid Metal'
 ```
 
-Field tables and the full list of rules: [main README](https://github.com/4matic/trackparse#tracklists)
-and [SPEC R13](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md#r13-tracklists).
+Field tables and the full list of rules: the [tracklists guide](https://4matic.github.io/trackparse/guides/tracklists/), the
+[Tracklist API](https://4matic.github.io/trackparse/reference/tracklist/) and [SPEC R13](https://github.com/4matic/trackparse/blob/main/spec/SPEC.md#r13-tracklists).
 
 ## Limitations
 
+**Docs:** [Limitations and roadmap](https://4matic.github.io/trackparse/project/roadmap/)
+
 One track string per `parse()` call; tracklists go through `trackparse/tracklist`, which reads
 start times only (no durations, trailing times or ranges). No label/catalog, key or BPM fields, and
 no built-in artist database: pass `knownArtists` for names that contain a joiner.

package/dist/{chunk-3TS4DITR.js → chunk-TOZBVIQ2.js}

@@ -1,5 +1,5 @@
 // src/data.generated.ts
-var SPEC_VERSION = "0.3.1";
+var SPEC_VERSION = "0.3.3";
 var descriptorsData = {
   "descriptors": [
     "radio",

package/dist/index.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 // src/data.generated.ts
-var SPEC_VERSION = "0.3.1";
+var SPEC_VERSION = "0.3.3";
 var descriptorsData = {
   "descriptors": [
     "radio",

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { P as ParsedTrack, A as Artist, F as FormatOptions, a as ParseOptions } from './types-DqJSn18b.cjs';
 export { b as ArtistRole, c as ArtistSource, d as Flags, J as Junk, e as JunkKind, K as KeywordOptions, M as Mode, f as ModeOption, g as Position, T as Timestamp, V as Version, h as VersionDelimiter, i as VersionType, W as Warning } from './types-DqJSn18b.cjs';
 
-declare const SPEC_VERSION = "0.3.1";
+declare const SPEC_VERSION = "0.3.3";
 
 declare function format(track: ParsedTrack, options?: FormatOptions): string;
 /** All credited names: track artists plus every version's remixers, deduped by R0.4 key. */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { P as ParsedTrack, A as Artist, F as FormatOptions, a as ParseOptions } from './types-DqJSn18b.js';
 export { b as ArtistRole, c as ArtistSource, d as Flags, J as Junk, e as JunkKind, K as KeywordOptions, M as Mode, f as ModeOption, g as Position, T as Timestamp, V as Version, h as VersionDelimiter, i as VersionType, W as Warning } from './types-DqJSn18b.js';
 
-declare const SPEC_VERSION = "0.3.1";
+declare const SPEC_VERSION = "0.3.3";
 
 declare function format(track: ParsedTrack, options?: FormatOptions): string;
 /** All credited names: track artists plus every version's remixers, deduped by R0.4 key. */

package/dist/index.js

@@ -1,5 +1,5 @@
-import { getDefaultTables, renderVersion, dedupKey, wordMatches } from './chunk-3TS4DITR.js';
-export { SPEC_VERSION, createParser, normalize, parse, parseArtists } from './chunk-3TS4DITR.js';
+import { getDefaultTables, renderVersion, dedupKey, wordMatches } from './chunk-TOZBVIQ2.js';
+export { SPEC_VERSION, createParser, normalize, parse, parseArtists } from './chunk-TOZBVIQ2.js';
 
 // src/format.ts
 function resolve(o) {

package/dist/tracklist.cjs

@@ -642,7 +642,7 @@ function applyEdits(text, edits, options) {
 }
 
 // src/data.generated.ts
-var SPEC_VERSION = "0.3.1";
+var SPEC_VERSION = "0.3.3";
 var descriptorsData = {
   "descriptors": [
     "radio",

package/dist/tracklist.js

@@ -1,4 +1,4 @@
-import { headerWordsData, createListParser, SPEC_VERSION, stringList, PhraseTable, markerWordsData, digitRun, isWhitespace, asciiLower, splitWords, inVocab, isDigit } from './chunk-3TS4DITR.js';
+import { headerWordsData, createListParser, SPEC_VERSION, stringList, PhraseTable, markerWordsData, digitRun, isWhitespace, asciiLower, splitWords, inVocab, isDigit } from './chunk-TOZBVIQ2.js';
 
 // src/tracklist/split.ts
 function splitLines(text) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trackparse",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Spec-driven parser for music track strings: artists, feat credits, remixes/versions, junk and more from single track strings (store titles, YouTube titles, filenames) and multi-line tracklists.",
   "license": "MIT",
   "author": "Maksim Maksimov",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/4matic/trackparse.git",
     "directory": "js"
   },
-  "homepage": "https://github.com/4matic/trackparse#readme",
+  "homepage": "https://4matic.github.io/trackparse/",
   "bugs": "https://github.com/4matic/trackparse/issues",
   "keywords": [
     "music",