⬆️ UPGRADE: mdformat 0.5.x (#2)

Co-authored-by: Chris Sewell <[email protected]>
Co-authored-by: Taneli Hukkinen <[email protected]>

Author: 3 people

.pre-commit-test.yaml

@@ -7,5 +7,3 @@ repos:
       files: "tests/pre-commit-test.md"
       types: [markdown]
       language: system
-      additional_dependencies:
-        - mdformat-plugin

README.md

@@ -49,6 +49,15 @@ To run the pre-commit hook test:
 tox -e py37-hook
 ```
 
+### Required changes for a new plugin
+This demonstration is setup with a plugin named `plugin` there are a number of locations to change. At a top level for a plugin
+`foo` at least the following changes are required
+- Global find and replace `mdformat_plugin` to `mdformat_foo` including folder names.
+- Global find and replace `mdformat-plugin` to `mdformat-foo` including folder names.
+- `tests/test_fixtures.py`: `output = render_text(text, extensions={"plugin"})` becomes `output = render_text(text, extensions={"foo"})`
+- `pyproject.toml` in addition to the global find and replace: `plugin = "mdformat_plugin"` becomes `foo = "mdformat_foo"`
+
+Do not forget to update authorship / maintainers in `pyproject.toml` as well.
 ## Publish to PyPi
 
 Either use flit directly:

pyproject.toml

@@ -17,7 +17,7 @@ classifiers = [
 keywords = "mdformat,markdown,markdown-it"
 
 requires-python=">=3.6"
-requires=["mdformat~=0.3.1"]
+requires=["mdformat >=0.5.3,<0.6.0"]
 
 [tool.flit.metadata.requires-extra]
 test = [

tests/fixtures.md

@@ -11,14 +11,14 @@ another test
 .
 Some *markdown*
 
-* a
-* b
-- c
+- a
+- b
+* c
 .
 Some *markdown*
 
-* a
-* b
+- a
+- b
 
-- c
+* c
 .