Skip to content

v22.11.0

Compare
Choose a tag to compare
@github-actions github-actions released this 19 Nov 16:23
83ab69a

New

  • Apply unicode normalization while resolving notes. [Nick Groenen]

    The unicode standard allows for certain (visually) identical characters to
    be represented in different ways.

    For example the character ä may be represented as a single combined
    codepoint "Latin Small Letter A with Diaeresis" (U+00E4) or by the
    combination of "Latin Small Letter A" (U+0061) followed by "Combining
    Diaeresis" (U+0308).

    When encoded with UTF-8, these are represented as respectively the two
    bytes 0xC3 0xA4, and the three bytes 0x61 0xCC 0x88.

    A user linking to notes with these characters in their titles would
    expect these two variants to link to the same file, given they are
    visually identical and have the exact same semantic meaning.

    The unicode standard defines a method to deconstruct and normalize these
    forms, so that a byte comparison on the normalized forms of these
    variants ends up comparing the same thing. This is called Unicode
    Normalization, defined in Unicode® Standard Annex #15
    (http://www.unicode.org/reports/tr15/).

    The W3C Working Group has written an excellent explanation of the
    problems regarding string matching, and how unicode normalization helps
    with this process: https://www.w3.org/TR/charmod-norm/#unicodeNormalization

    With this change, obsidian-export will perform unicode normalization
    (specifically the C (or NFC) normalization form) on all note titles
    while looking up link references, ensuring visually identical links are
    treated as being similar, even if they were encoded as different
    variants.

    A special thanks to Hans Raaf (@oderwat) for reporting and helping track
    down this issue.

Breaking Changes (affects library API only)

  • Pass context and events as mutable references to postprocessors. [Nick Groenen]

    Instead of passing clones of context and the markdown tree to
    postprocessors, pass them a mutable reference which may be modified
    in-place.

    This is a breaking change to the postprocessor implementation, changing
    both the input arguments as well as the return value:

    -    dyn Fn(Context, MarkdownEvents) -> (Context, MarkdownEvents, PostprocessorResult) + Send + Sync;
    +    dyn Fn(&mut Context, &mut MarkdownEvents) -> PostprocessorResult + Send + Sync;

    With this change the postprocessor API becomes a little more ergonomic
    to use however, especially making the intent around return statements more clear.

Other

  • Use path.Join to construct hugo links (#92) [Chang-Yen Tseng]

    Use path.Join so that it will render correctly on Windows
    (path.Join will convert Windows backslash to forward slash)

  • Bump crossbeam-utils from 0.8.5 to 0.8.12. [dependabot[bot]]

    Bumps crossbeam-utils from 0.8.5 to 0.8.12.


    updated-dependencies:

    • dependency-name: crossbeam-utils
      dependency-type: indirect
      ...
  • Bump regex from 1.6.0 to 1.7.0. [dependabot[bot]]

    Bumps regex from 1.6.0 to 1.7.0.


    updated-dependencies:

    • dependency-name: regex
      dependency-type: direct:production
      update-type: version-update:semver-minor
      ...
  • Bump actions/checkout from 2 to 3. [dependabot[bot]]

    Bumps actions/checkout from 2 to 3.


    updated-dependencies:

    • dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-major
      ...
  • Bump actions/upload-artifact from 2 to 3. [dependabot[bot]]

    Bumps actions/upload-artifact from 2 to 3.


    updated-dependencies:

    • dependency-name: actions/upload-artifact
      dependency-type: direct:production
      update-type: version-update:semver-major
      ...
  • Bump thread_local from 1.1.3 to 1.1.4. [dependabot[bot]]

    Bumps thread_local from 1.1.3 to 1.1.4.


    updated-dependencies:

    • dependency-name: thread_local
      dependency-type: indirect
      ...
  • Remove needless borrows. [Nick Groenen]

  • Upgrade snafu to 0.7.x. [Nick Groenen]

  • Upgrade pulldown-cmark-to-cmark to 10.0.x. [Nick Groenen]

  • Upgrade serde_yaml to 0.9.x. [Nick Groenen]

  • Upgrade minor dependencies. [Nick Groenen]

  • Fix new clippy lints. [Nick Groenen]

  • Add a contributor guide. [Nick Groenen]

  • Simplify pre-commit setup. [Nick Groenen]

    No need to depend on a third-party hook repository when each of these
    checks is easily defined and run through system commands.

    This also allows us to actually run tests, which is current unsupported
    (doublify/pre-commit-rust#19)

  • Bump tempfile from 3.2.0 to 3.3.0. [dependabot[bot]]

    Bumps tempfile from 3.2.0 to 3.3.0.


    updated-dependencies:

    • dependency-name: tempfile
      dependency-type: direct:production
      update-type: version-update:semver-minor
      ...