Skip to content

Releases: phongndo/syntaxmate

v0.2.1

Choose a tag to compare

@github-actions github-actions released this 30 Sep 23:18
  • Escape captured dynamic end/while delimiters like TextMate, including spaces,
    #, and hyphens. This fixes extended-mode delimiters being interpreted as
    regex syntax and captured hyphens becoming character-class ranges.
  • Preserve vertical tabs and non-ASCII whitespace as literals in extended-mode
    regexes, matching Oniguruma's separator rules.
  • Report degraded highlighting when a captured dynamic delimiter exceeds the
    existing substitution limit, including cached and incremental results.
  • Release the source style table after C token-buffer conversion, reducing
    memory retained by C and C++ results.
  • Add oracle-backed Unicode, mixed-line-ending, and truncated-input recovery
    checks for every B/C promotion-group language, covering bundled, cached, and
    uncached incremental tokenization.
  • Match TextMate's literal injection-selector semantics for asterisks, fixing
    missing invalid-angle-bracket scopes in Angular HTML attributes.
  • Include dependencies reached through rule-local repositories in generated
    bundles, restoring embedded Python highlighting in Wikitext syntaxhighlight
    blocks and retaining those dependencies in subset bundles. Loading the
    previously omitted grammars increases bundled Wikitext construction plus
    tokenization from 2.62 to 4.82 ms on the catalog fixture (median of five
    alternating runs, 30 iterations each).
  • Reject incomplete tokenization in the cold-throughput benchmark.
  • Reduce cached-line overhead by avoiding unused source-text/state clones and
    regex scratch initialization on cache hits. Across the 160 B/C languages,
    five alternating process-cold sweeps of 30 iterations using source-asset
    closures measured 36.27 → 36.85 MB/s aggregate (+1.6%), with unchanged
    benchmark scope digests.
  • Reduce uncached regex work by reusing captures already computed during
    candidate selection, skipping duplicate candidate guards, and compiling
    optional groups as ordered choices instead of counted loops. Preserve
    capture rollback, lazy and possessive matching, and Unicode scope ranges.
    Seven alternating steady-state samples on a Ryzen 9 9950X measured 1.5–2.9%
    higher HTML throughput on the Markdown, TypeScript, C++, Rust, and C stress
    fixtures, with line caching disabled and unchanged scope/HTML digests.

v0.2.0

Choose a tag to compare

@github-actions github-actions released this 27 Sep 19:41
  • Replace string-only grammar, theme, bundle, render, and diagnostic errors with
    structured payloads and matchable kinds. Preserve JSON and writer source
    chains, and retain Clone, PartialEq, and Eq. Add opt-in
    GrammarRegistry::validate_regexes() for pattern/position diagnostics without
    changing permissive loading or tokenization.

  • Add validated custom/subset catalogs, borrowed language metadata, and bounded
    filename/first-line detection. syntaxmate-bundle --languages emits selected
    public languages, their dependency closures, and included licenses.

  • Make Highlighter cheaply cloneable and Send + Sync, with &self operations,
    shared prepared languages, and configurable bounded idle-tokenizer retention.
    Sessions reuse preparation; custom catalogs work without default features.

  • Expose incremental scope-stack IDs, comparable across calls and resets on the
    same tokenizer/session (separate from document-local IDs).

  • Prepare the breaking 0.2 API: unify document and incremental token/line types,
    expose allocation-free Scopes views, and consolidate theme construction and
    resolution on Theme. Document output now reports completion per line.

  • Hide scope storage and cache instrumentation, remove redundant aliases and
    catalog free functions, and require rustdoc for every public item.

  • Implement PartialEq, Eq, and Hash for TokenizerState, allowing editors
    to stop incremental re-highlighting when continuation states converge. Keep
    embedded base-grammar context distinct when reusing static frame identities.

  • Borrow uncompressed bundle string and scope tables to reduce cold-start latency
    and retained heap, trading a larger bundle for no metadata decompression.
    The bundle decoder (including miniz_oxide) is available without bundled assets.

  • Reduce HTML output by inheriting default colors from the wrapper and merging
    equal adjacent runs. Keep full colors when rendering without a wrapper.
    ANSI output now omits the theme default background unless
    AnsiOptions::include_default_background is set.

  • Add theme-independent scope classes through HtmlOptions::class_prefix and
    html_stylesheet: render HTML once and switch themes by replacing CSS.
    Nested scopes preserve parent selectors; unsupported selectors are skipped.
    Add render_html_to and render_ansi_to for fmt::Write sinks. Option struct
    literals should use ..Default::default() or supply the new fields.

  • Restore allocation guardrails for prepared tokenizers and bundled construction
    by dropping construction-only rule templates and borrowing embedded repository
    skeleton bytes.

  • Reduce first-use tokenization costs for complex and embedded grammars through
    lower-allocation regex parsing, deferred matcher construction, and reuse within
    each tokenizer. Refresh the catalog reference measurements.

  • Honor TokenizerOptions::line_cache_entries = 0 by disabling line-result
    caching completely.

  • Keep the verified MSRV at Rust 1.88 while using a newer development toolchain.

  • Slim the published crate by omitting raw grammar sources and checkout-only
    development targets; retain bundled assets and all license notices.

  • Document only user-facing features on docs.rs, with feature availability labels.

  • Refresh bundled grammars from @shikijs/langs 3.23.0 to 4.4.3. Highlighting
    changes for 52 upstream-updated grammars, including a rewritten C++ grammar
    whose declarations, calls, and attributes scope differently, and coq now
    uses the upstream source.rocq root scope. Seven new Shiki grammars (ahk,
    ahk2, chapel, nsis, org, rbs, smithy) are vendored as private
    assets pending promotion; the public catalog is unchanged at 264 languages.

  • Update the reference oracle to vscode-textmate 9.3.2, matching current
    VS Code; vscode-oniguruma stays at 1.7.0 because VS Code still ships it.

  • Support Oniguruma \p{XIDS}/\p{XIDC} (XID_Start/XID_Continue, with loose
    property-name matching), used by the updated Typst grammar.

  • Fix fallback regex search skipping matches of nullable patterns whose empty
    branch is guarded by a lookbehind, such as x|(?<=T). Patterns whose every
    branch starts with ^, \A, or \G (for example (^|\G)) are now tried
    only at those anchors, and each search reuses one matcher scratch.

  • Match vscode-textmate for captures outside a match: skip empty captures, stop
    at the first capture that starts after the match, and resume scanning at the
    match end instead of after lookahead captures. Captures past the match end
    now nest like captures inside it, including after an empty match such as
    (?=((a)b)).

  • Pop the enclosing rule after a match rule that does not advance, as
    vscode-textmate does. The bundled GraphQL grammar no longer stays inside a
    type block for the rest of the document.

  • Stop re-entering a begin rule that matched without advancing at the same
    position, and drop or format deeply nested tokenizer states without
    recursion. A self-including zero-width begin no longer overflows the
    stack.

  • Fold case for bracketed classes as Oniguruma does: under (?i) a character
    matches when one of its case variants is in the class, with intersections,
    nested classes, and properties evaluated first. (?i)[^a-{] now matches
    `, (?i)[A-Z&&a-z] no longer matches a, and (?i)[\p{Lu}] matches
    a, while (?i)\p{Lu} outside brackets still does not.

  • Fix several Oniguruma incompatibilities in the fallback matcher:

    • \k<name> and (?(<name>)…) consider every group sharing the name;
    • a{1,2}+ repeats the interval instead of being possessive;
    • recursive subroutine calls keep their caller's loop counts;
    • subroutine capture replay no longer panics after backtracking into a
      returned call, and recursion that never consumes input, such as
      (\g<1>)?, fails instead of overflowing the stack;
    • Unicode case-insensitive keyword sets containing characters such as θ,
      ϑ, and ϴ no longer miss matches.

Migrating from 0.1

This is a clean break for 0.2; removed names have no deprecated aliases.
Both document and incremental lines expose tokens(), and each token exposes
range() and scopes(). Styled tokens also expose style(). Scope iteration
borrows the token and allocates nothing; cloned tokens keep their scopes alive.
Line status() describes that line, while document status() covers the whole
operation (including any checkpoint replay).

Old API 0.2 replacement
Error::Grammar(String) GrammarError: scope_name() and kind(); include targets, regex positions, registry limit values, and foreign IDs are matchable
Error::Theme(String) ThemeError::kind() distinguishes JSON, color values, and rule failures
Error::Render(String) RenderError::kind() distinguishes SourceMismatch and Writer; writer failures chain to fmt::Error
Error::Bundle(String), bundled decode errors under Grammar BundleError::kind() and language()
Error::Diagnostic(String) DiagnosticError exposes kind, pattern, invalid byte offset, and executed steps
Parsing error display text for JSON locations JsonError::line() / column(); follow std::error::Error::source() to the original serde_json::Error
DocumentLine TokenizedLine
TokenSpan, ScopedToken Token
HighlightedSpan, IncrementalHighlightedSpan HighlightedToken
IncrementalHighlightedLine HighlightedLine
ResolvedSyntaxStyle Style
SyntaxModifiers FontModifiers
ScopeStackRef ScopeStackId
ScopeTable, HighlightScopeTable, ScopeAtomId Private storage; use token.scopes()
line.spans() line.tokens()
line.scope_names(token.scope_stack()), line.scope_table() token.scopes()
token.scope_stack() -> ScopeStackRef Option<ScopeStackId>; always Some; compare within one document or across incremental calls on one tokenizer/session, never between those namespaces
TextMateTheme Theme; from_json, from_rules, and bundled return crate Result / Error
Theme::resolve(table, stack) Theme::resolve(token.scopes()); standalone names use resolve_scope_names(&[&str])
TextMateTheme::resolve_style, resolve_with_match Theme::resolve_style(scopes), resolve_with_match(scopes), requiring diagnostics
ResolvedThemeStyle, ThemeMatch, ThemeSelectorScore Same names, available only with diagnostics
style_cache_stats, memory_bytes Private instrumentation; no public replacement
DEFAULT_LINE_CACHE_ENTRIES, DEFAULT_MAX_LINE_BYTES TokenizerOptions::default(); defaults are documented there
canonical_language(language) Catalog::bundled().canonical_language(language)
detect_language_from_path(path) Catalog::bundled().detect_path(path)
available_languages() Catalog::bundled().languages()
Catalog unit value, Copy, Default Catalog::bundled() (requires bundled-grammars), from_static, or from_bytes; use cheap clone()
Catalog language queries returning String / Vec<String> Borrowed &str / Vec<&str> tied to &Catalog; retain the handle or call to_owned()
Catalog::bundle_version() -> &'static str &str tied to the catalog
Highlighter methods taking &mut self &self; clone or share one highlighter across threads
Unbounded highlighter language cache / default tokenizer limits HighlighterOptions controls preparation and idle-tokenizer retention; see rustdoc for defaults

Theme also exposes default_style() and color(name). Theme selector
inspection is diagnostic output and remains outside the stable API contract.

v0.1.3

Choose a tag to compare

@github-actions github-actions released this 19 Sep 02:34
  • Reduce temporary bytecode-compilation allocations by borrowing subroutine AST
    definitions and exact literal inventories, without retaining AST references.
  • Preserve degraded status on line-cache replay and report regex-budget
    exhaustion inside capture retokenization and while conditions.
  • Fix case-insensitive lookbehind across different UTF-8 character widths in
    both bytecode and recursive matchers.
  • Preserve literal scope punctuation and space-separated empty scope atoms;
    strip leading dots only from interpolated capture text, matching TextMate.
  • Add generated custom-grammar oracle regressions and a profile-alloc --no-line-cache mode that separates warm execution from cached-token replay.
  • Public APIs and the Rust 1.88 MSRV are unchanged. Output changes correct
    previously non-oracle scope/capture behavior; cached budget failures now
    consistently report Degraded instead of incorrectly reporting Complete.
  • Cold-start gains are strongest for C++; this is not a general steady-state
    speedup. Correct Unicode lookbehind costs approximately 6% on the measured
    SDBL workload. See the measurements and known limitations.

v0.1.2

Choose a tag to compare

@github-actions github-actions released this 23 Aug 21:49
  • Add reproducible engine and end-to-end competitive benchmarks against current
    pinned vscode-textmate, Shiki, and Syntect releases.
  • Reduce tokenizer capture and scope-output allocations with deferred group-zero
    synthesis, direct compact-capture output, bounded buffer reuse, and compact
    candidate indexes; speed up HTML and ANSI color serialization.

v0.1.1

Choose a tag to compare

@phongndo phongndo released this 04 Aug 09:50
  • Fix participating capture ranges in the optimized Nix expression-end
    lookahead so they match vscode-oniguruma.
  • Expand scanner-execution parity from four fixtures to a balanced sample over
    all 31 core regression assets.
  • Speed up tokenizer construction with dense O(1) rule lookup, shared immutable
    repository walks, and copy-on-write grammar registry clones.
  • Reduce cold and incremental allocation pressure by directly decoding grammar
    unions, sharing interned scopes and capture specs, and compacting regex tries.
  • Store deterministic versioned compiled-grammar IR in the bundled asset,
    removing runtime JSON parsing and rule compilation for bundled languages.
  • Add caller-owned PreparedLanguage snapshots for constructing independent
    tokenizers while reusing count- and byte-bounded immutable grammar and regex
    preparation.
  • Add reusable incremental token/span buffers, callback sinks, and direct
    compact-token HTML/ANSI rendering paths while retaining the owned APIs.
  • Cache incremental theme resolution by private tokenizer scope-stack identity
    with a fixed 8,192-slot per-session bound.
  • Add resettable warm incremental profiling, peak live-byte and output-digest
    reporting, plus reviewed allocation and retention ceilings in CI.

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 02 Aug 07:11
31f91f5
  • Extract the Rust-native TextMate grammar, tokenizer, regex, catalog, and theme
    engines from Mark.
  • Add batteries-included whole-document and incremental highlighting APIs.
  • Bundle the validated 264-language catalog and four GitHub dark/light themes,
    including high-contrast variants; custom themes remain supported.
  • Add escaped HTML and terminal-safe 24-bit ANSI renderers.
  • Add feature-powerset, coverage, scheduled and differential fuzzing, static
    analysis, comparative benchmarks, secure OIDC release automation, dependency
    updates, and community templates.