changelog.md

Change Log

This changelog is kept here for historical purposes. For the current changelog, goto our documentation site.

Version 0.9.19 - Date: 2024-04-30

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, goto ReadTheDocs.

Added

• Issue 801
  • Started movement of docs from README.md and docs directory to the newdocs directory with a shorter README.md.
• Issue 1059
  • Complete redo of pre-commit documentation.
• Issue 1070
  • Complete redo of advanced configuration documentation.

Fixed

• None

Changed

• Issue 1031
  • went through code base and used if/else expressions where possible
• Issue 1033
  • went through tests for Md007, add some extra tests to cover missed scenarios
• Issue 1037
  • replaced calls to collect/extract ParserHelper functions followed by asserts with X_verified functions that do that already
• Issue 1039
  • ensure that all asserts have a message with their reasoning
  • verify that the asserts are required, refactoring where necessary

Version 0.9.18 - Date: 2024-03-18

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

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

Version 0.9.16 - Date: 2024-01-20

This release is going to focus on getting the feature list complete for a version 1.0 release in early 2024. To a large extent, this involves adding the "fix" feature for some rules, and double checking the output of many of the existing rules, looking for missing issues.

Some other notable additions/changes are:

• the --continue-on-error command line flag allows PyMarkdown to continue processing after any tokenization error or plugin error
  • while we hope this is not necessary long term, it is useful
• added py.typed file for any API users
  • this allows mypy to understand the typing included with the PyMarkdown API
• more parameterized tests
  • borrowing a pattern we have observed, transitioning scenario tests over to this new pattern
  • any plugin with the new Fix feature has parameterized tests

Added

• Issue 618
  • Ability to tell PyMarkdown to fix issues
  • Not every plugin supports fix, see pymarkdown plugins list for the current list of plugins and fix status
• Issue 802
  • Extension: Extended Autolinks
• Issue 803
  • Extension: Strikethrough
• Issue 805
  • Extension: Task List Items
• Issue 808
  • Rule MD004 - Added fix options
• Issue 809
  • Rule MD007 - Added fix options
• Issie 813
  • Rule MD019 - Added fix options
• Issue 814
  • Rule MD021 - Added fix options
• Issue 816
  • Rule MD023 - Added fix options
• Issue 817
  • Rule MD029 - Added fix options
• Issue 820
  • Rule MD035 - Added fix options
• Issue 821
  • Rule MD037 - Added fix options
• Issue 822
  • Rule MD038 - Added fix options
• Issue 823
  • Rule MD039 - Added fix options
• Issue 825
  • Rule MD048 - Added fix options
• Issue 931
  • Rule MD005 - Added fix options
• Issue 938
  • Rule MD027 - Added fix options
• Issue 940
  • Rule MD006 (disabled) - Added fix options
• Issue 941
  • Rule MD030 - Added fix options
• Issue 946
  • Added --continue-on-error command line flag to "ignore" errors and to keep on processing.

Changed

• Issue 806
  • Documentation updated to denote fixes.
• Issue 812
  • Rule MD014 - Changed documentation to describe why not autofix
• Issue 827
  • Finished research on which rules are fixable and sorted.
• Issue 901
  • noticed cases where len(x) was being used instead of x or not x
• Issue 913
  • making proper use of is_xxx_end function from MarkdownToken class
• Issue 934
  • fix mode scans multiple times, with each scan producing lots of logs if on DEBUG
  • first fix was to allow a new command line option to suppress logs on any scan in fix mode past the first one
  • other fix was to make a clearer message when two rules trigger on the same field of the same token
• Issue 936
  • change documentation for rules that will not have a fix

Fixed

• Issue 929
  • Improper links in README.md when viewed at PyPi.org.
• Issue 930
  • Fixed issue of missing py.typed file.

Completed

• Issue 827
  • researched annotated each rule
  • rules "in queue" have no annotation yet, ones that have fixes have docs updated, ones that are not eligible have reason why

Version 0.9.15 - Date: 2023-12-05

This release is mainly to fix issues related to technical debt. The PyMarkdown project takes Markdown and generates a token stream to represent that Markdown. To verify that the tokens are correct, HTML output is generated and matched against reference implementations of the specification. If those pass, the tests then try to recreate the Markdown from the information in the tokens. So, to pass a single test, the Markdown must generate tokens without any assertions, generate the correct HTML, and be able to recreate the Markdown that it parsed.

The issues fixed include some issues that fixed assertions, caused improperly formed HTML, and caused improperly formed Markdown. The majority of these issue involved tab characters and containers.

Added

• None

Changed

• None

Fixed

• Issue 731
  • see issue for details. fixed issues with unorder-bq-ordered that need more examination in the future
• Issue 828
  • list new items within block quotes were not always rendering properly in Markdown, required changes to markdown regen
• Issue 829
  • fixed issue with BlockQuoteData instance not being passed back properly. as a result, one closing of a block quote was not noticed by another closing further down the line
• Issue 832
  • partially fixed by other work, partial issue with the HTML output showing spaces instead of tabs, could be slightly different versions of commonmark tests
• Issue 833
  • not handling the split tab properly in these cases
• Issue 834
  • issues were tabs that were split on the same line as a list start
• Issue 835
  • a double block quote follwed by a fenced block in a single block quote was not properly closing
• Issue 836
  • these cases were hitting split tab cases within processing for fenced code blocks
• Issue 837
  • these cases were split tab cases where the text to compare to its detabified forms was incorrect, resulting in a failed match
• Issue 838
  • extra tab was showing up in double list scenarios where indented block start was split over the last list and the indented block
• Issue 839
  • handling of split tabs within lists was not added at all, causing an assert to fire
• Issue 840
  • was not properly looking up in tabbed map when rendering
• Issue 841
  • fixed issue with assert
  • had commented out branch because no cases were found, finally found one
  • spawned other issues to fix less serious issues
• Issue 842
  • fixed problem with HTML and lists and split tabs causing assertions
  • spawned other issues to fix less serious issues
• Issue 843
  • whitespace check not being suspended for one check caused the html block not to be closed
• Issue 848
  • indent spacing within containers causing tab to not be changed back properly
• Issue 849
  • in cases with double lists, split tab can sometimes get missed
• Issue 850
  • some of the lines we adding whitespace for both the bq indent (already taken care of) and the list, resulting in too many spaces
  • tab support added to those cases
• Issue 852
  • fixed bad tokenization. previous fix was improper, causing strings to be improperly indexed into to fix spacing issue
  • spawned other issues to fix less serious issues
• Issue 854
  • "fixed". not sure why this happened, and will probably open another issue to properly figure this out at a later date
  • in cases where a list is within a block quote, and the next line is a paragraph continuation that fails the requirements for a "normal" list continuation, this fix was required.
• Issue 857
  • fixed along with Issue 840, just filed separately
• Issue 878
  • a doubly indented list with a new paragraph continuation line starting with multiple tabs was not capturing the first tab properly in the list
• Issue 888
  • during fixing of 731, found some outside cases which were throwing asserts as they were outside of normal paths
  • mostly dealt with proper spacing with block quotes nested within lists.
• Issue 889
  • cleaned up issue with MD032 firing with nested blocks.
• Issue 891
  • fixed up Markdown issues with regenerating. Cause was improper adding of an extra newline in the leading spaces

Version 0.9.14 - Date: 2023-10-31

This release is mostly to incorporate a number of small fixes and additions. Behind the scenes, we spent a while looking at the roadmap and trying to figure out the best path going forward. Part of that was experimenting with different forms of testing, to see how applicable they would be to this project. That work will be starting soon and be incremental. It also pointed out a need for better documentation, which will also be incremental going forward.

That experimentation lead to a couple of changes:

• Front matter is now interpretted as strict YAML, and not as some mashup of rules. This was decided on as it easier to explain and document. This may cause some existing front-matter settings to not work as expected, especially validation of the front-matter itself and case-sensitivity on front-matter key fields.
• Added a new pragma command disable-num-lines to handle disabling rules for a given count of lines.

Added

• Issue 776
  • implement disable-num-lines pragma command
• Issue 786
  • added extension to disallow html, per GFM
  • added rule PML100 which detected the same thing, but does not fix

Changed

• Issue 750
  • started work on making the tests more compact and efficient

Fixed

• Issue 774
  • was following "weird" rules, changed to allow for standard YAML parser to determine validity
  • changed rule md001 to look for case sensitive front-matter key name instead of case sensitive per switch to full YAML processing
• Issue 791
  • html blocks inside of 2+ levels of block quote was asserting
  • slight change to surrounding code to deal with less than case
• Issue 793
  • list block end with no paragraphs was causing an assert with MD027
  • double checked assert, is not needed and was just preventative

Version 0.9.13.4 - Date: 2023-09-09

Note: noted there were some issues with the pymarkdown_test project and giving false positives. Will be looking into that for the next release.

Fixed

• Issue 755
  • fixed issue where new directories were not captured due to false positive
• Issue 759
  • code_blocks property for MD010 was inverted
  • will check for others like this as more fix mode work is done

Version 0.9.13 - Date: 2023-09-03

This release had some new features, but the most interesting one of all is the start of the work on the fix mode that has been requested. It is invoke by invoking the scan engine with -x-fix scan instead of scan. It is still in the early stages, but you can experiment with it and rules md001, md009, md010, and md047 for which fix mode has been implemented. Note that all the documentation will not reflect fix mode until it is further along, but try it out if you would like!

In addition, because of requests, the following two features and one bug fix have been addressed:

• YAML support
  • YAML support is provided for default configuration using the .pymarkdown.yml and .pymarkdown.yaml file
    • note that the .pymarkdown file is checked first, and if present, YAML default files will not be loaded
  • YAML support is provided for the command line --config argument
    • if the specified file does not parse as JSON, PyMarkdown will attempt to parse it as YAML
• Return Code Schemes
  • the --return-code-scheme argument accepts either default or minimal
  • default is the normaly return codes for PyMarkdown
  • minimal returns a code of 0 even if no files were found or if there were any rules triggered
• Rule MD010
  • The rule was not dealing with tabs in code-blocks properly
  • Fixed so that any line that contains a code-block does not trigger the rule

Added

• Issue 618
  • Alpha pass at fix mode
  • Rules md001, md009, md010, and md047 support fix mode, but not documented
• Issue 691
  • Allow YAML for configuration files

Changed

• Issue 723
  • Moved test version of transform to markdown into application directory
• Issue 728
  • Moved code from transform modules (html and markdown) into token classes
  • Refactored modules to put them in more consistent directories
• Issue 737
  • Rule MD010: Added code to not fire on fenced code blocks
• Issue 744
  • Added ability to change return code profile
• Issue 746
  • Moved scanning related code from main.py to new file module

Fixed

• None

Version 0.9.12 - Date: 2023-07-24

Added

• Issue 655
  • Added support for tool.pymarkdown section in pyproject.toml for current directory
• Issue 702
  • First version of the PyMarkdown API, so the project can be called from other Python files
  • Added PyDoc support to generate API docs for new API from build pipeline
• Issue 708
  • Split the Pipfile requirements into Dev and Non-Dev requirements
  • Updated to new version of application_properties with same split just added
• Split up test_main.py into smaller scripts with narrower focus
• Improved build pipeline
  • added check to ensure Pipfile and install-requirements remain in sync
  • added lint stage to pipeline
  • added packaging stage to ensure we can run our package script
• Added new pymarkdown_test project with (hopefully) automated kickoff from PyMarkdown

Changed

• None

Fixed

• None

Version 0.9.10 - Date: 2023-04-16

Added

• Issue 627
  • Added support for default .pymarkdown configuration file
  • Updated documentation for configuration

Changed

• None

Fixed

• None

Version 0.9.11 - Date: 2023-04-17

Fixed

• Emergency fix.

Version 0.9.10 - Date: 2023-04-16

Added

• Issue 627
  • Added support for default .pymarkdown configuration file
  • Updated documentation for configuration

Changed

• Issue 582
  • broke up leaf block processor into more distinct pieces
• Issue 589
  • broke up token to GFM module into more distinct pieces
• Issue 594
  • broke up token to link helper into more distinct pieces
• Issue 596
  • broke up token to inline processor into more distinct pieces
• Issue 598
  • broke up token to link reference definition helper into more distinct pieces
• Issue 600
  • broke up html helper into more distinct pieces
• Issue 603
  • broke up container block processor into more distinct pieces
• Issue 605
  • broke up block quote processor
• Issue 607
  • broke up list block processor
• Issue 630
  • ensured that remaining whitespace tests have the standard combinations tested in the previous whitespace tests

Fixed

• Issue 613
  • fixed issues with tabs and thematic breaks
• Issue 620
  • fixed issues with tabs and SetExt headings
• Issue 622
  • fixed issues with tabs and paragraphs
• Issue 625
  • fixed documentation to more clearly specifying the use of a comma-separated list for enabling and disabling rules
  • small change to list processing logic to strip whitespace between values, allowing for md001 , md002 to equal md001,md002
• Issue 626
  • fixed issue where parsing was not considering being in a code block before determining whether or not to start a list
• Issue 634
  • fixed and tested various scenarios with lists that contain mostly or all link elements
• Issue 637
  • fixed by adding extra examples and scenario tests to verify this is working
• Issue 639
  • addressed inter-release issue of not specifying all code directories in the setup script after refactoring

Version 0.9.9 - Date: 2023-02-26

This was a point release. Issues that were addressed:

• proprly dealing with the reintegration of tabs into the HTML output
• ensuring that tabs are represented properly in the internal token format
• cleaning up code to reduce various PyLint errors

Added

• Issue 561
  • added Sourcery.Ai to analysis tools
    • made sure all code hits 40% Sourcery quality threshold
    • cleaned up testing scripts

Changed

• various
  • updated build, publish, and analysis packages to latest versions
• Issue 561
  • changed error output to filter through main module for more control
• Issue 504
  • moved file logging code into own module
• Issue 496
  • moved file scanner code into own module

Fixed

• Issue 561
  • worked to reduce the count of too-many-locals reported by PyLint
• Issue 478
  • fixed false positive in reporting the start of the list
  • underlying issue was improper closing of the list, which was also fixed
• Issue 453
  • still in progress
  • cleaning up reintegration of tabs into output

Version 0.9.8 - Date: 2022-09-20

This was a point release. Issues that were addressed:

• fixed issues with block quotes and other containers
• added support for file extensions other than .md
• added support for linting markdown from standard input
• cleared up issue with using proper path separators on Windows
• added and fixed tests for proper handling of whitespaces
• added proper support for Unicode whitespace and Unicode punctuation around emphasis elements
• updated all Python dependencies to their current versions

NOTE for Windows users:

Prior to this release, when executing PyMarkdown against a file on a Windows machine, any paths were reported using the Posix format. This has been corrected as of the 0.9.8 release, with Linux and MacOs reporting paths in Posix format and Windows reporting paths in Windows format. If you have scripts that invoke PyMarkdown and interprets any returned paths, please examine those scripts to see if they need to be changed.

Added

• Issue 407
  • added support for other file extensions
• Issue 413
  • added more variants for nested-three-block-block tests
• Issue 441
  • added support for linting markdown from standard input
• Issue 456
  • added lots of new tests for different forms of whitespace with each element
• Issue 480
  • added proper support for Unicode whitespace and Unicode punctuation around emphasis elements

Changed

• Issue 168
  • moved paragraph handling code to own module
• Issue 330
  • cleared up issue with using proper path separators on Windows
• Issue 408
  • split tests for blocks into more discrete files
• Issue 450
  • enabled proper tests for pragmas
• Issue 454
  • fixed special HTML sequences that were detected by Md033

Fixed

• Issue 301
  • fixed issue where was checking indent_level instead of column_number
  • clarified documentation
• Issue 410
  • not putting Markdown back together properly
• Issue 419
  • fixed parsing issue with trailing spaces in empty list items
• Issue 420
  • fix improper parsing with nested blocks quotes
• Issue 421
  • Markdown was not put back together properly with weird Block Quote/List combinations
• Issue 460
  • fixed up mismatching output with tabs
• Issue 461
  • generated HTML not removing whitespace before and after paragraphs
• Issue 465
  • not properly handling whitespace before fenced block info string
• Issue 468
  • closing fence block allowed tabs after the fence characters
• Issue 471
  • merging of end of line spaces not being handled properly
• Issue 476
  • tabs within code spans were triggered stripping of whitespace
• Issue 483
  • fixed RegEx within Md018 and Md021 to properly reflect spaces, not whitespaces
• Issue 486
  • fixed problem with tabs causing weird parsing with a new block quote

Version 0.9.7 - Date: 2022-07-04

Added

• None

Changed

• Bumping of versions of dependent packages
• Changed - Issue 361
  • cleaning up badges to make them consistent
• Changed - Issue 392
  • moved many of the "one-off" parameters out of arguments into a "grab-bag" with logging

Fixed

• Fixed - Issue 355
  • issues uncovered by bumping pylint version
• Fixed
  • issues with whitespace in certain situations being applied to both container and leaf tokens
• Fixed
  • issues with whitespace missing from certain scenarios
• Fixed
  • issues with lists and block quotes interacting badly, resulting in block quote being missed

Version 0.9.6 - Date: 2022-04-02

Added

• Added - Issue 293
  • next round of nested level tests, with new list items
• Added - Issue 319
  • added mypy typing to entire project and removed stubs for application_properties

Changed

• Changed - Issue 154
  • rule md003: added configuration allow-setext-update
• Changed - Issue 283
  • general: moved more modules into specific directories

Fixed

• Fixed - Issue 95
  • parser: with certain cases involving a new list item, can start a container in the middle of line
• Fixed - Issue 161
  • rule md005: was not returning proper values for actual and expected
• Fixed - Issue 189
  • rule md027: addressed index out of bounds error keeping track of blank lines after a block quote was started in a previous section
• Fixed - Issue 287
  • parser: code to handle indent was greedy with respect to HTML blocks and fenced code blocks
• Fixed - Issue 294
  • markdown generator: needed to take list items into account
• Fixed - Issue 295
  • markdown generator: fixed by work on 294
• Fixed - Issue 296
  • parser: improper closing of previous block caused duplicate list items
• Fixed - Issue 297
  • markdown generator: not indenting enough
• Fixed - Issue 298
  • parser: list processing go confused between block quote and list
• Fixed - Issue 299
  • parser: not recognizing inner list
• Fixed - Issue 300
  • parser: various issues with lists not being properly handled in nested scenarios

Version 0.9.5 - Date: 2022-02-07

This was a point release that highlighted improvements to the accuracy of reported tokens in situations with nested containers.

PLEASE! If you encounter any issues with this product, please file an issue report and tell us about it! There are a lot of combinations of Markdown elements to cover, and we need your help to prioritize them all!

Added

• Added - Issue 227
  • scenario tests: adding 3-level nesting tests with max space, and max space plus one variations
• Added - Issue 250
  • scenario tests: adding variations of removed block quotes on second line
• Added - Issue 261
  • scenario tests: variations of 3-level max space tests with no text after container starts on first line

Changed

• Changed - Issue 248
  • github actions: only run against main branch

Fixed

• Fixed - Issue 189
  • rule md027: weird case where total for series of block quotes that ended with a blank line was off by 1
• Fixed - Issue 218
  • parser: lot of small things needed fixing to set the variables properly for this issue's resolution
  • parser: after that, was not properly handling shutting down a block quote that downgraded
• Fixed - Issue 228
  • parser: previous adjustment no longer needed
• Fixed - Issue 229
  • parser: generated HTML did not include indented code block
• Fixed - Issue 230
  • parser: dropping leading >
• Fixed - Issue 231
  • parser: fixed by issue-229
• Fixed - Issue 232
  • parser: fixed by issue-233
  • parser: fixed by issue-228
• Fixed - Issue 233
  • parser: limiting container checking to limited set, expanded
  • parser: extra indent was not accounted for in space calculations
  • parser: double block quotes not being handled properly
  • parser: indent being processed twice
• Fixed - Issue 252
  • parser: in rare cases, was adding leading spaces to both list and paragraph within
• Fixed - Issue 262
  • parser: when checking for block quote decrease, did not have empty scenarios checked for
• Fixed - Issue 263
  • parser: with empty list items, was creating 2 blank line tokens, plus extra list indent
• Fixed - Issue 264
  • parser: fixed issue with blending current text and original text to parse
  • parser: cleaned up remaining issues about closing off containers too early
• Fixed - Issue 265
  • parser: fixed with work on Issue 262
• Fixed - Issue 268
  • parser: previous work took too many newlnes out, this put the right ones back in

Version 0.9.4 - Date: 2022-01-04

This was a point release that highlighted improvements to the accuracy of reported tokens in situations with nested containers.

• Removed "call home support" similar to VSCode and other products.
  • One of our contributors pointed out a number of falacies, and we agreed.
• Enhanced testing of the whitespace calculations recently completed.

Changed

• Changed - Issue 184
  • scenario tests: instead of mixup in different areas, added initial combinations to test in one place
• Changed - Issue 207
  • adding more upfront analysis, upgrading Columnar to new version
• Changed - Issue 214
  • removing call home support

Fixed

• Fixed - Issue 159
  • parser: was using wrong values to determine nesting level
• Fixed - Issue 185
  • parser: nesting of block quote, list, block quote raised an assert
• Fixed - Issue 186
  • parser: due to work on Issue 187, these now passed after assert examine and disabled
• Fixed - Issue 187
  • parser: three separate adjustments needed to be made to ensure the whitespace is consistent
• Fixed - Issue 188
  • parser: not dealing with a block occurring after 2 nested lists
• Fixed - Issue 192
  • parser: needed to adjust __calculate_current_indent_level function to accomodate nesting
• Fixed - Issue 196
  • markdown: transformer was not calculating indent properly
• Fixed - Issue 197
  • parser: block quote processor was not closing blocks properly, resulting in bad HTML
• Fixed - Issue 198
  • markdown: algorithm was not taking into effect newer change to calculate container indices later
• Fixed - Issue 199
  • parser: fixed by work done on Issue 202
• Fixed - Issue 200
  • markdown: calculation for previous indent and whitespace to add after was off
• Fixed - Issue 201
  • parser: fixed by work done on Issue 202
• Fixed - Issue 202
  • parser: block quote processor needed a lot of work to handle whitespace properly
  • parser: container block processor not handling 4 spaces at start of line properly
• Fixed - Issue 203
  • markdown: adjustments to properly calculate indent
  • parser: list block processor not transferring extracted text to a nested block
  • various cleanup
• Fixed - Issue 219
  • parser: indents of 4 within a single and double level list were not cleanly differentiating

Version 0.9.3 - Date: 2021-12-14

This was a point release to allow fixed issues to be released. While the full descriptions are below, here are some highlights:

• Added "call home support" similar to VSCode and other products, to allow notification of new versions
  • This is currently experimental. Feedback welcome.
• Lots of refactoring to reduce complexity and adhere to guidelines
• Rewrite of the whitespace calculations to drastically reduce their complexity

Added

• Added - Issue 104
  • core: added support for calling home every week to see if there is a new version at PyPi.org

Changed

• Changed - Issue 85
  • scenario tests: verified and documented inlines with newline tests
• Changed - Issue 96
  • parser: was misunderstanding. extra blank line was verified as per spec
• Changed - Issue 103
  • refactoring: look for better way to use .items()
• Changed - Issue 107
  • refactoring: identified and removed unused pylint suppressions
• Changed - Issue 112
  • refactoring: finding and applying all Sourcery recommended issues
• Changed - Module Refactoring to reduce complexity
  • plugin_manager.py
  • list_block_processor.py
  • coalesce_processor.py + emphasis_helper.py
  • container_block_processor.py
  • leaf_block_processor.py
  • link_reference_definition_helper.py
  • link_helper.py
  • inline_processor.py
  • block_quote_processor.py
  • tokenized_markdown.py
  • main.py + inline_helper.py + rule md027
  • rest of main directory
  • extensions and rules
• Changed - Issue 145
  • refactoring: Either implemented todo or filed new issue to do it later
• Changed - Issue 151
  • refactoring: tightening up code after refactoring
• Changed - Issue 155
  • refactoring: moving this_bq_count and stack_bq_quote into new BlockQuoteData class
• Changed - Issue 166
  • refactoring: large refactoring to standardize the whitespace in tokens

Fixed

• Fixed - Issue 87
  • scenario tests: removing disable_consistency_checks from tests and getting clean
    • parser: found and resolved two issues
    • consistency checks: found and resolved ~7 issues
  • general: pass through code to clean up string usage
  • consistency check: verified rehydrate usage through project
  • consistency check: tightening leading space index for block quotes
    • parser: found and resolved issue with extra newline added to leading spaces for block quote
• Fixed - Issue 90
  • scenario tests: verified noted tests have been fixed
  • rule md027: rewrote bq index logic to work properly
• Fixed(partial) - Issue 92
  • rule md027: nested containers were not thoroughly tested
  • parser: added new bugs linked to Issue 92 as part of discovery
• Fixed - Issue 93
  • parser: was not handling extracted spaces properly, causing issues with calculating values for thematic breaks
  • parser: spent time rewriting whitespace calculation and storage to address the issue
• Fixed - Issue 94
  • parser: after work on 153, this was resolved
• Fixed - Issue 97
  • parser: after work on 153, this was resolved
• Fixed - Issue 98
  • parser: after work on 153, this was resolved
• Fixed - Issue 99
  • parser: after work on 153, this was resolved
• Fixed - Issue 100
  • parser: after work on 153, this was resolved
• Fixed - Issue 153
  • parser: hit missed scenario test with list indents

Version 0.9.2 - Date: 2021-10-24

This was a point release to allow fixed issues to be released. While the full descriptions are below, here are some highlights:

• Fixed issue with PyMarkdown scripts not having correct permissions
• Added more scenario tests and verified that those worked
• Fixed small issues with parser and rules, mostly boundary cases

Added

• None

Changed

• Changed - Issue 44
  • scenario tests: went through every scenario test and validated comment string
• Changed - Issue 62
  • parser: not reproducible, but added extra scenario tests to make sure
• Changed - Issue 64
  • rule md030: was not implemented according to specification for "double, changed to do so
• Changed - Issue 66
  • rule md023: rule fine, scenario tests running with bad data
• Changed - Issue 68
  • documentation: added more clear description of sibling
• Changed - Issue 70
  • scenario tests: gave better names, added one for configuration

Fixed

• Fixed - Issue 43
  • parser: on start of nested list, was not allowing indent to be based on parent indent
• Fixed - Issue 47
  • parser: wasn't treating "partial" LRDs as valid, rewinding past their start
• Fixed - Issue 49
  • parser: aborting a LRD within a list was not generating correct reset state
  • scenario tests: addressed same issue in fenced code block and LRD tests
  • issue: added Issue 50 to test with extra levels
• Fixed - Issue 51
  • parser: not handling list starts properly where the list indent was less than the line before it
• Fixed - Issued 53
  • parser: when dealing with lines within a list item within a block quote, not removing leading spaces properly
• Fixed - Issue 56
  • scenario tests: resolved outstanding rules tests that were skipped
  • parser: when parsing - > , did not properly retain new block quote level on return
• Fixed - Issue 59
  • parser: on line after list item, if started with ===, would think it was SetExt instead of continuation text.
• Fixed - Issue 72
  • rule md006: was not properly handling block quotes and nested lists
• Fixed - Issue 74
  • parser: not handling cases with list then block quote, with only block quote on next line
  • scenario tests: added extra tests to cover variations on more complex nesting cases
• Fixed - Issue 76
  • scenario tests: added extra test to cover missing variations
  • parser: was not handle the unwinding of lists properly in one case due to off-by-one error
• Fixed - Issue 77
  • command line: scripts not interfacing properly on linux systems
• Fixed - Issue 79
  • scenario tests: added extra test to cover missing variations
  • rule Md005: rewritten to respond to ordered lists better

Version 0.9.1 - Date: 2021-10-06

This was a point release to make several new features and fixed issues to be released. While the full descriptions are below, here are some highlights:

• Added documentation on how to use Git Pre-Commit hooks with PyMarkdown
• Added support to allow PyMarkdown to be executed as a module with -m
• Various scenario test tasks including verifying disabled rules were required

Added

• Added
  • documentation: documentation on how to use pre-commit hooks
• Added
  • core: support for executing pymarkdown as a module (python -m pymarkdown)
• Added
  • rules test: verified existing case, added missing related case
• Added
  • rules test: added new test case with provided data
  • documentation: addressed documentation issue with description for rule_md044.md
• Added
  • rule md033: new configuration value allow_first_image_element
    • if True, allows ONLY <h1><img></h1> sequence (with any parameters needed) if is first token in document
• Added
  • documentation: added description of how HTML comments are different
• Added
  • core: added sorting of triggered rules before they are displayed

Changed

• Changed
  • rules tests:verified need for --disable-rules through tests, removing any that were not needed
  • documentation: addressed some documentation issues with docs/rules.md and doc/rules/rule_md032.md

Fixed

• Fixed
  • rule Md033: no longer triggers on end tags, adjusted default allowed tags
• Fixed
  • rule Md023: whitespace at end of lines in SetExt Heading no longer being recognized as starting whitespace.
• Fixed
  • rule Md032: was not recognizing 2 end list tokens in a row
• Fixed
  • rule Md037: was not properly looking for spaces inside of possible emphasis characters
• Fixed
  • parser: found parsing error with lists in block quotes
  • rule md031,md032: fixed that and fixed issues in rules md031 and md032
• Fixed
  • parser: multiline inline elements with a Block Quote were not getting their starting positions calculated properly
    • any element directly after those elements were also likely to have a bad position
• Fixed
  • parser: fixed instance of multi-level list within block quotes not firing properly
  • issues: added item to issues list to do more looking on nested lists
  • rule md007: may show up here with nested lists

Version 0.9.0 - Date: 2021-09-21

The main focus of this release was to fill out the features that the project supports to the beta release level. Big ticket items addressed were:

• Better support from the command line for extensions and plugins
• Implementing all the rules for launch

Added

• Added - ability to have configuration values for adding pluings and enabling stack trace.
• Added - better access for plugin information from the command line.
• Added - extension manager to start to bring extensions up to the same level as plugins.
• Added - support for missing rules in the initial set of rules.

Changed

• Changed - to move the code for application_properties class from this project into a new Python package, and to make this project dependant on that package.
• Changed - markdown_token.py to included better high level is_*_token functions
• Updated - documentation on front-matter and pragma extensions.

Fixed

• Fixed - issues with nested Block Quotes and Lists not interacting properly with each other

Version 0.8.0 - Date: 2021-05-31

Added

• added -r flag to control whether the scan is recursive
• added support for linting and testing through GitHub Actions

Changed

• None

Fixed

• improved documentation
• cleaned up error handling
• issues with tests not running properly on Linux and MacOs

Version 0.5.0 - Date: 2021-05-16

Added

• Initial release

Changed

• None

Fixed

• None