New Features

• Add #![deny(missing_docs)] attribute to enable missing documentation checks and add comprehensive documentation for all public items

New Features (BREAKING)

• Add support for super/subscript without html
  Superscript and subscript can be presented in markdown as:
  ^superscript^ and subscript respectively. This is not always turned on,
  and many people prefer the HTML tag form, however in order to round-trip
  markdown which uses the symbolic form we need an option to enable that.

  This feature is enabled via a new field in the Options struct.

Commit Statistics

• 7 commits contributed to the release.
• 43 days passed between releases.
• 2 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

New Features

• Improve CommonMark conformance testing output
  This is a major improvement to the rendering of the failing
  CommonMark conformance test output, that should make it easier
  to read and understand when pulldown-cmark-to-cmark is producing
  erroneous output.

  Additionally, this introduces a way to force the printing of the
  CommonMark failure report from the command line:

  $ FULL_CMARK_RESULTS=true cargo test
  

  and documents in CONTRIBUTING.md that new contributors may want
  to start with trying to improve conformance.

  This removes #[should_panic] from the main CommonMark test. Instead,
  we now hard-code in how many of the CommonMark tests are known to pass.

  If the number that actually passes increases or decreases, this test
  will fail, informing the user either that they have introduced a bug
  (decrease), or that they've successfully improved conformance (increase).

  Previously, if a change accidentally reduce the conformance, there was
  no easy way to know, since that information was not stored/tracked
  in any way.

Other

• Drop comment headers

Refactor

• Add Repeated utility to simplify writing repeated content

• Move and group related code
  My impression reading through the code in this project is that
  top-level statements have gotten a bit intertangled over time;
  this tries to reorder things to have a clearer flow and
  structure, grouping related things together.

  For example, this moves the recently added Error enum up above
  all of the API functions, instead of leaving it somewhat
  arbitrarily nestled between cmark_resume_with_options() and
  cmark_resume_one_event().

  No code changes were made to the body of functions or types.
  This also does not change any of the public APIs, only where
  code is located.

  • Group padded newline logic at top of text_modifications.rs

  • Rename padding_of() to list_item_padding_of()

  • Add 'Public API Functions' header in lib.rs

  • Consolidate public enum and struct types at the
    top of lib.rs, instead of leaving them scattered
    amongst the cmark*() public functions.

  • Consolidate the two impl State<'_> statements

  • Move cmark_resume(), cmark() and cmark_with_options()
    from the bottom of lib.rs up to the top, before the ~600
    implementation of cmark_resume_one_event() that makes up
    the bulk of lib.rs

• Add State::set_minimum_newlines_before_start()
  This should help with readability. As an example, I didn't realize
  initially that all of the if statements updated in this PR
  were actually modifying the same field.

  But once I started doing the more generic refactoring of adding
  a set_option_minimum() method, I looked at every line and
  realized they were all the same.

  Factoring this to a method should clarify to future readers that
  updating newlines_before_start specifically is a recurring operation.

• Use write_padded_string() in a couple additional places
  Additionally, while in the neighhborhood, add pub(crate) to the other
  text_modifications.rs private helpers

  These being marked as pub is misleading since the text_modifications
  module is not actually externally public, and these functions
  are never re-exported publicly.

Commit Statistics

• 12 commits contributed to the release.
• 264 days passed between releases.
• 6 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

The breaking release is to avoid side-effects with different pulldown-cmark versions.
This crate now comes with version 13.

Other

• Adjust wording + typos

Refactor

• Add helper to factor out newline + padding pattern
  When writing a newline into the generated Markdown content
  to start a new line of output, it is (almost) always necessary
  to output the "padding" characters used to indent the content
  at the current location in the document, based on the hierarchy
  of block-level elements the output cursor is "inside" of.

  Since writing a newline and writing the current padding are
  always paired, factoring them out into a function should help
  with readability and consistency in performing this minor
  two-step dance correctly.

Commit Statistics

• 8 commits contributed to the release.
• 6 days passed between releases.
• 2 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

Bug Fixes

• definition list block indentation now works correctly.

Commit Statistics

• 7 commits contributed to the release.
• 58 days passed between releases.
• 1 commit was understood as conventional.
• 1 unique issue was worked on: #97

Thanks Clippy

Clippy helped 1 time to make code idiomatic.

Commit Details

Bug Fixes (BREAKING)

• Add structured error handling for cmark(), cmark_resume() etc
  When cmark_resume_with_options(), which serves as basis for the other
  cmark* functions, finds an inconsistent event stream (for example, two
  consecutive heading start tags), it panics.

  Introduce a custom error type Error in the crate and change the return
  type of all public functions from fmt::Result<_> to Result<_, Error>.

  The next commit adds an integration test.

Commit Statistics

• 4 commits contributed to the release.
• 4 days passed between releases.
• 1 commit was understood as conventional.
• 1 unique issue was worked on: #91

Commit Details

Bug Fixes

• harden again manufactured input which could previously trigger assertion failures.

Commit Statistics

• 3 commits contributed to the release.
• 19 days passed between releases.
• 1 commit was understood as conventional.
• 1 unique issue was worked on: #91

Commit Details

New Features (BREAKING)

• Make State struct non-exhaustive
  That way, future additions to the rather internal state won't be a reason for breaking changes anymore.

Bug Fixes (BREAKING)

• drasticly improve escaping !, #, and |
  Raises spec tests from 578 to 580. It handles cases that look like these

  Link, not image: \![a](b)
  
  This header ends with hashes, not an ATX trailer ###
  ====================================================
  
  | a \| b | a \| c |
  |--------|--------|
  

Commit Statistics

• 11 commits contributed to the release.
• 2 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

Chore

• use TextMergeStream for round-trip tests
  This increases the amount of passing tests to 578.
  It doesn't strictly improve the quality of implementation,
  but since separate text events aren't supposed to be semantic,
  these failures seem spurrious.

New Features

• angle brackets if link paren is unbalanced
  Increases passing spec tests from 473 to 477.

Bug Fixes

• write block quote kind only once

New Features (BREAKING)

• correctly round-trip code blocks with no trailing newline
• round-trip indented code blocks
  This raises the number of passing spec tests from 459 to 473.

Commit Statistics

• 10 commits contributed to the release.
• 40 days passed between releases.
• 5 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

New Features (BREAKING)

• retain more details on reference links
  This raises the number of passing spec tests from 436 to 459.

Bug Fixes (BREAKING)

• spurrious code blocks when char escapes start text

Commit Statistics

• 5 commits contributed to the release.
• 14 days passed between releases.
• 2 commits were understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details

Other

• Lower MSRV to 1.71.1
  This project builds successfully with the MSRV of pulldown-cmark. Therefore we can lower rust-version to 1.71.1.

  Add documentation for the current MSRV and that this project follows MSRV policy of pulldown-cmark.

  Use cargo hack for MSRV CI job, to automatically install rustc according to rust-version and then execute cargo check.

Commit Statistics

• 15 commits contributed to the release over the course of 2 calendar days.
• 2 days passed between releases.
• 1 commit was understood as conventional.
• 0 issues like '(#ID)' were seen in commit messages

Commit Details