Skip to content

v0.9.16

Compare
Choose a tag to compare
@jackdewinter jackdewinter released this 21 Jan 01:08
· 94 commits to main since this release
5087500

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