chore(pre-commit): update jackdewinter/pymarkdown to v0.9.26 - autoclosed

[renovate]

This PR contains the following updates:

Package	Type	Update	Change
jackdewinter/pymarkdown	repository	patch	0.9.16 -> v0.9.26

Note: The pre-commit manager in Renovate is not supported by the pre-commit maintainers or community. Please do not report any problems there, instead create a Discussion in the Renovate repository if you have any questions.

---

Release Notes

jackdewinter/pymarkdown (jackdewinter/pymarkdown)

v0.9.26: Version 0.9.26 - Date: 2024-12-09

Compare Source

Version 0.9.26 - Date: 2024-12-09

Progress continues on locating issues and addressing them, including four issues reported by users. As of this past weekend, (to the best of our knowledge) we have eliminated all fatal issues with Rule Md031 and its fix mode. While there are only three weeks left until the new year, we hope to make significant progress on Rule Md031's fix mode producing incorrect markdown. At the same time, we are starting to do research work into determining the best patterns for introducing new leaf elements in 2025. Our main goal is to provide thorough coverage without sacrificing proper testing. To that end, we will try and figure out and document the best approaches so we can use them for new leaf elements in 2025.

In addition to this work, make solid progress on addressing user issues as reported. And this might seem repetitive, but we continue to need our users to help us out. If you are scanning any Markdown documents and the results seem off, please file an issue. If you are starting to use our fix mode on your Markdown documents and there are issues, please file an issue. We appreciate any help that we can get to improve the project for everyone!

Added

• Issue 810
  • Added fix mode for Rule Md012
• Issue 1280
  • Added testing capability to save all single Markdown documents in a specified directory, then scanning them one at a time with PyMarkdown and each of the extensions enabled.

Fixed

• Issue 1259
  • Fixed asserts and bad parsing from cases where containers are added and then a "raw" blank line removes all containers.
• Issue 1263
  • Fixed issue where a new unordered list between two block quotes was not being recognized properly.
• Issue 1270
  • Fixed issue with Md027 not reporting line numbers properly within anything except the first paragraph.
• Issue 1272
  • Parsing of the FCB in certain cases was off, as was the text token containing the code block's text. Resulted in the columns being reported being indented less than expected.
• Issue 1274
  • Fixed remaining assert issues, leaving fixes that produce valid Markdown, but not the intended Markdown.
• Issue 1267
  • Fixed reported issue with task lists creating an error in Md018.
• Issue 1268
  • Fixed issue with Md022 and pragmas, similar to Issue 1208.

Changed

• Issue 1258
  • Moved twine package into dev section

v0.9.25: Version 0.9.25 - Date: 2024-11-07

Compare Source

Version 0.9.25 - Date: 2024-11-07

While it seems like we have been working on the fixing for Rule Md031 forever, that time is starting to come to an end. We have a solid list of what is left to test, and we are confident that we will finish it before the new year. (Hope we did not just jinx ourselves!) As with the last couple of releases, we are testing variations of containers, container starts, and container ends, all to ensure we have confidence that our test scenarios are thorough. At this point, we are very confident with any nesting of up to three containers, will our confidence for nesting scenarios of up to four containers at a high level as well. Following close behind that is our fix mode for Rule Md031 which is the stressor for the nested containers. We are not always happy that we started working on the fix mode for Rule Md031, but we are happy that it uncovered some issues in our parser that we could quickly fix.

But we continue to need our users to help us out. If you are scanning any Markdown documents and the results seem off, please file an issue. If you are starting to use our fix mode on your Markdown documents and there are issues, please file an issue. We appreciate any help that we can get to improve the project for everyone!

Added

• Issue 1233
• Issue 1234
• Issue 1235
  • Adding more comprehensive "drop X" tests where multiple levels of containers are involved, and then dropping one or more of those containers in a single line.

Fixed

• Issue 1208
  • Fixed issue with blank lines separated with pragmas not being understood properly.
• Issue 1233
• Issue 1234
• Issue 1235
  • Adding new "drop_x" tests and resolve any scan issues with them.
• Issue 1243
• Issue 1245
  • Handling leading spaces in __fix_spacing function now that data is present.
• Issue 1247
  • In 3+ drop cases with only lists and no block quotes, indent is not calculated properly on rehydrate. This in turn causes the fixed text to be wrong.
• Issue 1250
  • Batch of fixes for cases when Md031 is trying to properly space a fenced code block after dropping 2 containers.

Changed

• Issue 1231)
  • Moved triple nested container tests into their own test_nested_three_* files for better readability.

v0.9.24: Version 0.9.24 - Date: 2024-10-06

Compare Source

Version 0.9.24 - Date: 2024-10-06

This release continued our focus on enabling fixing for Rule Md031 and uncovering any issues with the more deeply nested container cases. This has meant introducing a new helper class to assist in the tracking of a given line to the container tokens used to provide container-based indenting for that line. This is very important for Rule Md031, and has already proveded to be useful in a partial rewrite of some of the logic for Md027.

While we find the odd parsing error, those issues are now rare to find in container nesting of three container or less, especially compared to finding issues with our new fix logic. Still, we continue to try different combinations of containers elements and leaf elements, verifying that PyMarkdown creates the correct HTML and correct Markdown from our parsed format.

That is where we still need our users to help us out. If you are scanning any Markdown documents and the results seem off, please file an issue. If you are starting to use our fix mode on your Markdown documents and there are issues, please file an issue. We appreciate any help that we can get to improve the project for everyone!

Added

• Issue 1212
  • added cases to Md031 for SetExt
  • added extra test cases and resolution to other cases

Fixed

• Issue 1169
• Issue 1170
• Issue 1173
• Issue 1175
• Issue 1176
  • fixed parser issue with extra leading space item being added
• Issue 1164
• Issue 1165
• Issue 1171
• Issue 1174
• Issue 1177
• Issue 1178
• Issue 1180
• Issue 1181
  • fixed rehydrator issue with extra leading space item being added
• Issue 1172
• Issue 1173
• Issue 1179
  • fixed rehydrator issue with reyhdrating after bqs with remove token being
    blank line
• Issue 1202
  • fixed rehydrator issue with paragraph continues
• Issue 1203
  • parser issue with fenced code block closing right away
• Issue 1204
  • rehydration/fix issue with blank lines causing off by one error
• Issue 1209
  • detection code for MD027 was not using the right container index
• Issue 1217
  • fixed issue with some list starts not being accounted for properly when
    grouped together on same line
• Issue 1166
• Issue 1167
• Issue 1168
  • fixed issue with more deeply nested containers

Changed

• Started to pull common code from MD031 for use in Md027

v0.9.23: Version 0.9.23 - Date: 2024-09-04

Compare Source

Version 0.9.23 - Date: 2024-09-04

This release continued our focus on enabling fixing for Rule Md031 and uncovering any issues with the more deeply nested container cases. And our luck held out, with the majority of the issues being related to the fixing algorithms. As mentioned in the last release, our detection rules rely on accurate parsing of the Markdown documents, with the only truthful way to verify that being to reconstitute the Markdown documents from our internal parsed format.

We continue to try different combinations of containers elements and leaf elements, verifying that PyMarkdown creates the correct HTML
and the correct Markdown from our parsed format. The good news is that the largest percentage of issues deal with how we represent and
reconstitute that whitespace. And we are diligently working to detect any issues with that process and to fix them.

That is where you, the users, come in. If you are scanning any Markdown documents and the results seem off, please file an issue. If you are starting to use our fix mode on your Markdown documents and there are issues, please file an issue. We appreciate any help that we can get to improve the project for everyone!

Added

• None

Fixed

• Issue 1141
  • fixed assert issue (test_extra_044mcv0)
• Issue 1142
  • fixed assert issue (test_extra_044lc)
• Issue 1143
  • fixed indent issue (test_extra_044ldb0)
• Issue 1144
  • fixed parsing issue (test_extra_044ldb1)
• Issue 1145
  • fixed indent issue (test_extra_044mx60)
• Issue 1146
  • fixed indent issue (test_extra_044lex1)
• Issue 1147
  • fixed indent issue (test_extra_044mcx)
• Issue 1148
  • fixed parsing issue (test_extra_044ldb1)
• Issue 1149
  • fixed parsing issue (test_extra_044mcz0)
• Issue 1150
  • fixed indent issue (test_extra_044lex3)
• Issue 1151
  • fixed assert issue with untested path (test_extra_044ldg)
• Issue 1152
  • fixed indent issue (test_extra_044mcs0)
• Issue 1153
  • fixed indent issue (test_extra_044mcu0)
• Issue 1154
  • fixed indent issue (test_extra_044mx31)
• Issue 1155
  • fixed indent issue (test_extra_044lde)
• Issue 1156
  • fixed indent issue (test_extra_044ldb0)

Changed

• None

v0.9.22: Version 0.9.22 - Date: 2024-08-05

Compare Source

Version 0.9.22 - Date: 2024-08-05

This release was focused on enabling fixing for Rule Md031 and uncovering any issues with the more deeply nested container cases. The good news is that, as the list in the fixed section shows, we fixed a lot of issues. The better news is that only a handful of those fixes dealt with the parser, with the bulk of the issues dealing with transitioning from Markdown to our internal token format and back to Markdown again.

Why is this important? When a user asks the PyMarkdown linter to fix any issues that it can, our team wants to have the utmost confidence that PyMarkdown is producing the correct fix. Therefore, we tokenize the Markdown and base our rules off tokens that we know are correct. The only way to validate that we have the correct tokens is to take those tokens and recreate the Markdown. If we cannot produce the exact Markdown that we started with, then we have a problem.

In most of the fixed issues below, the tokens are correct and can produce the proper HTML from the Markdown. However, in over 90% of the fixed issues below, when we recreate the Markdown, the Markdown that we produce if off by a couple of whitespace characters. For
the reasons stated above, it is important to our team to fix these issues with transparency. Therefore, while the fixed list is somewhat
long, it is an honest reflection of the issues that we found and addressed.

Added

• Issue 818
  • Adding Fix Mode for Md031.

Fixed

• Issue 1120
  • within Block-List, thematic break can sometimes not report newlines to the
    list block
• Issue 1122
  • opening a fenced code block in a Bq-List-Bq was closing the outer BQ
• Issue 1123
  • in some cases within a Bq-List-Bq, not counting the newlines properly
• Issue 1124
  • list items within a Bq-List-Bq can have incorrect starting text regarding
    the innermost block
• Issue 1125
  • parsing of blank lines within Bq-List-Bq does not always add the right
    newlines to the list
• Issue 1126
  • under some circumstances, with a Bq-List-Bq, thematic break can cause
    the block quote to close
• Issue 1127
  • rehydration can be wrong with indented blocks in Bq-List-Bq
• Issue 1130
  • check for adding extra line to list with blank line in *-List-Bq
    not flexible enough
• Issue 1132
  • false positives (negatives?) for list looseness fixed
• Issue 1135
  • fixed issue introduced with above shortcuting in Bq-List-Bq scenarios
    to avoid assert
• Issue 1137
  • fixed issue with hanging indents and some Bq-List-Bq scenarios
• Issue 1141
  • fixed assert with Bq-List-Bq with previously untested branch
• Issue 1142
  • fixed assert with list-list-bq-bq with previously untested branch
• Issue 1143
  • fixed rehydate with first leading space not being calculated properly
• Issue 1144
  • fixed parsing error with bq-list-bq-list and HTML block not being recongized
• Issue 1145
  • fixed rehydration where last leading space of just closed block not being set
    properly
• Issue 1146
  • fixed parsing issue with text after whitespace not taking indent into account
• Issue 1147
  • fixed issue with double counting of spaces to list and paragraph
• Issue 1148
  • fixed parsing error with bq-list-bq-list and ATX block not being recongized
• Issue 1149
  • fixed parsing error with bq-list-bq-list and fenced block not being recongized
• Issue 1150
  • fixed hydration with thematic break after multiple lists and bq to render previous
    leading spaces as invalid
• Issue 1151
  • fixed assert with Bq-List-Bq with previously untested branch
• Issue 1152
  • fixed rehydrate problem with indents not being calculated properly for inner
    blocks
• Issue 1153
  • fixed rehydrate issue with sequences causing leading spaces to be incorrect
• Issue 1154
  • fixed rehydrate issue with sequences causing leading spaces to be incorrect
• Issue 1155
  • fixed rehydrate issue with prior and closed block quotes not being factored
    in properly
• Issue 1156
  • fixed rehydrate issue with extra block quote character being added at end
    of document

Changed

• None

v0.9.21: Version 0.9.21 - Date: 2024-07-01

Compare Source

This release focuses on enabling the fix modes for various rules, performing more testing of scenarios to prepare for the release. Not finding anything major but uncovering some "weird" combinations that are causing unpredictable behavior. That behavior is mostly in the area of producing the correct Markdown from tokens to allow the fix mode to produce reliable fixes.

Added

• Issue 826
  • Added fix mode for Rule Md044
• Issue 824
  • Added fix mode for Rule Md046

Fixed

• Issue 1099
  • Fixed longstanding issue with tabs and newlines in code spans

Changed

• Issue 1103
  • added round of coalescing any text tokens separated during inline processing
  • rewrote rule md037 to new text tokens

v0.9.20

Compare Source

Version 0.9.20 - Date: 2024-05-30

This release focuses on completing the work to get the documentation up to date and in the new read-the-docs format. Some user issues were addressed, but this was mainly to get the documents into good shape for release.

To view the new documentation, go to ReadTheDocs.

Added

• Issue 1075
  • Complete redo of advanced extensions documentation.
• Issue 1079
  • Complete redo of advanced rules documentation.
• Issue 1083
  • Complete redo of api documentation.
• Issue 1081
  • Added "plugins info" extension to show current configuration.

Fixed

• Issue 1015
  • Fixed issue with double tabs within fenced block
• Issue 1077
  • Fixed issue with previous cleanup

Changed

• None

v0.9.19: Version 0.9.19

Compare Source

This release focuses on getting the documentation up to date and in the new read-the-docs format. Some small issues were addressed, but this is mainly to get the documents into good shape for release.

To view the new documentation, go to ReadTheDocs.

v0.9.18: Version 0.9.18

Compare Source

Version 0.9.18 - Date: 2024-03-18

This release focuses on getting the feature list complete for a version 1.0 release in the first half of 2024. This release was mainly fixes addressing the new "fix" functionality for a number of the rules, as well as issues with tab characters.

PLEASE NOTE. We have an extensive test suite, but we can always use your help with scenarios that we have not thought of. If you run into a situation that causes a bad parsing or other exception, please let us know.

A lot of the work we are doing to prepare for the new releases is centered around extra cases for tab characters as well as the newer fix functionality. Please report any issues with these features to help us make it better for others.

Added

• Issue 990
  • added ability to use a TOML file in pyproject.toml format with the
    --config command line flag

Fixed

• Issue 992
  • Verified behavior of Rule Md009, fixing some small issues
• Issue 994
  • Verified behavior of Rule Md029, adding configuration for starting ordered
    lists from integers greater than 1
• Issue 1001
  • Verified behavior of rules Md019 and Md021, fixing issues with Md021
• Issue 1003
  • Verified behavior of rule Md037 with more types of inline elements
• Issue 1007
  • Verified behavior of rule md023 with more cases, especially tab characters
  • multiple cases of fixing the rule and multiple cases of fixing the parser
• Issue 1015
  • Fixed issue with split tab and a simple list indent

Changed

• Issue 944
  • verified that all existing fix tests are parameterized
  • new fix tests for rule going forward will require this
• Issue 1005
  • verified behavior of rule Md039
  • added link reference defintion's link title to the previous list
    of link title and image's link title for examination
• Issue 1007
  • changed GHA workflow to be more precise when unable to start remote job

v0.9.17

Compare Source

Version 0.9.17 - Date: 2024-02-05

This release focuses on getting the feature list complete
for a version 1.0 release in early 2024. This release marked the
start of moving documentation from this repository to the more
curated ReadTheDocs.

Some notable additions/changes are:

• taking a second pass at the outputs from the recent fix addition, re-verifying
  the output and fixing any issues
• cleaning up documentation to properly note what type of whitespace is used
  in the core and well as various extensions and plugins
  • at the same time, clearly followed the specification on what kind of whitespace
    to use, instead of allowing unicode whitespace by default
• for parsers like Python-Markdown, used in the MkDocs tools, added Rule Pml101
  to handle the different indentation requirements
  • note that this new rule give advice against Md007, so only one of the two
    rules should be enabled at any one time

Added

• Issue 975
  • Added a new rule Pml101 to deal with "anchored list indents"
  • This adds support for Python-Markdown and other parsers like it
    • Used by tools such as mkdocs to build documentation sites
  • Defaults to an indent of 4 that starts from the beginning of the line or
    after a block quote start
  • Updated documentation for Md007 to mention Pml101 and when to use it
• Issue 983
  • Added base foundation for new documentation, publishing on
    read-the-docs.

Fixed

• Issue 929
  • second try, specifically missing github blob reference in urls
• Issue 945
  • inconsistent splitting of whitespace caused some issues
  • went through all strip() calls and ensured that they have the
    specific type of whitespace identified and documented
• Issue 964
  • final fix states needed verification and fixing of any issues
  • uncovered and fixed issues in Md007, Md019, and Md029
• Issue 977
  • fixed issue with md019 continuing to search for text blocks once the
    heading was completed
  • verified that Md021 does not have the same issue, but added tests to be sure
• Issue 981
  • added documentation for Rule Pml100
  • cleaned up mentions of whitespace in pragma and front matter extensions
• Issue 986
  • initial setting of log level to DEBUG with --stack-trace command line
    flag not working as expected
  • fixed to properly set log level to DEBUG for early application debugging

Changed

• Issue 966
  • adjusted fix for Md009 to remove any trailing whitespace if the line is within
    an Atx Heading

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.