Merge branch 'master' into mdformat-myst

Author: chrisjsewell

.github/workflows/benchmark.yml

@@ -46,45 +46,3 @@ jobs:
         commit-msg-append: "[ci skip]"
         one-chart-groups: packages,plugins
         fail-on-alert: false
-
-  benchmark-plugins:
-
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.8
-
-    - name: Install tox
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox
-
-    - name: Run plugin benchmarks
-      run: tox -e py38-bench-plugins -- --benchmark-min-rounds 20 --benchmark-json bench-plugins.json
-
-    # - name: Upload plugin data
-    #   uses: actions/upload-artifact@v2
-    #   with:
-    #     name: bench-plugins
-    #     path: bench-plugins.json
-    #     if-no-files-found: error
-
-    - name: Store benchmark result
-      uses: chrisjsewell/github-action-benchmark@v2
-      with:
-        name: Parsing Benchmarks
-        output-file-path: bench-plugins.json
-        # Use personal access token instead of GITHUB_TOKEN due to https://github.saobby.my.eu.orgmunity/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869/highlight/false
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        auto-push: true
-        commit-msg-append: "[ci skip]"
-        one-chart-groups: packages,plugins
-        # Show alert with commit comment on detecting possible performance regression
-        alert-threshold: '200%'
-        comment-on-alert: true
-        fail-on-alert: false
-        alert-comment-cc-users: '@chrisjsewell'

.github/workflows/tests.yml

@@ -9,6 +9,8 @@ on:
     tags:
       - 'v*'
   pull_request:
+  schedule:
+    - cron: '0 0 * * 0'  # every week
 
 jobs:
 
@@ -53,6 +55,29 @@ jobs:
         file: ./coverage.xml
         fail_ci_if_error: true
 
+  test-plugins:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install markdown-it-py
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[testing]
+    - name: clone and install mdit-py-plugins
+      run: |
+        git clone https://github.com/executablebooks/mdit-py-plugins.git
+        pip install --no-deps -e mdit-py-plugins
+    - name: Run pytest for unit tests of mdit-py-plugins
+      run: cd mdit-py-plugins; pytest
+
   benchmark:
 
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -23,36 +23,40 @@ repos:
       additional_dependencies: [mdformat-myst==0.1.2]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.3.0
+    rev: v3.4.0
     hooks:
     - id: check-json
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
 
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.44"
+    rev: "0.46"
     hooks:
     - id: check-manifest
+      args: [--no-build-isolation]
+      additional_dependencies: [setuptools>=46.4.0]
+
+  # this is not used for now,
+  # since it converts markdown-it-py to markdown_it_py and removes comments
+  # - repo: https://github.com/asottile/setup-cfg-fmt
+  #   rev: v1.17.0
+  #   hooks:
+  #   - id: setup-cfg-fmt
 
   - repo: https://github.com/psf/black
     rev: 20.8b1
     hooks:
     - id: black
 
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
+    rev: 3.9.1
     hooks:
     - id: flake8
       additional_dependencies: [flake8-bugbear==21.3.1]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.790
+    rev: v0.812
     hooks:
     - id: mypy
       additional_dependencies: [attrs]
-
-  - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v1.16.0
-    hooks:
-    - id: setup-cfg-fmt

.readthedocs.yml

@@ -7,6 +7,7 @@ python:
         path: .
         extra_requirements:
           - linkify
+          - plugins
           - rtd
 
 sphinx:

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 1.0.0b2 - 2021-04-25
+
+‼️ BREAKING: Move `mdit-py-plugins` out of the core install requirements and into a `plugins` extra.
+
+Synchronised code with the upstream Markdown-It `v12.0.6`:
+
+- 🐛 FIX: Raise HTML blocks priority to resolve conflict with headings
+- 🐛 FIX: Newline not rendered in image alt attribute
+
 ## 1.0.0b1 - 2021-03-31
 
 [Full commit log](https://github.com/executablebooks/markdown-it-py/compare/v0.6.2...9ecda04)
@@ -8,7 +17,7 @@ This is the first beta release of the stable v1.x series.
 
 There are four notable (and breaking) changes:
 
-1. The code has been synchronised with the upstream Markdown-It v12.0.4.
+1. The code has been synchronised with the upstream Markdown-It `v12.0.4`.
    In particular, this update alters the parsing of tables to be consistent with the GFM specification: <https://github.github.com/gfm/#tables-extension->
    A number of parsing performance and validation improvements are also included.
 2. `Token.attrs` are now stored as dictionaries, rather than a list of lists.

README.md

@@ -32,7 +32,14 @@ conda install -c conda-forge markdown-it-py
 or
 
 ```bash
-pip install markdown-it-py
+pip install markdown-it-py[plugins]
+```
+
+or with extras
+
+```bash
+conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins
+pip install markdown-it-py[linkify,plugins]
 ```
 
 ## Usage

benchmarking/bench_plugins.py

@@ -51,6 +51,7 @@
     ("py:class", "markdown_it.helpers.parse_link_destination._Result"),
     ("py:class", "markdown_it.helpers.parse_link_title._Result"),
     ("py:class", "MarkdownIt"),
+    ("py:class", "_NodeType"),
 ]
 
 

docs/conf.py

@@ -1,4 +1,4 @@
 from .main import MarkdownIt  # noqa: F401
 
 
-__version__ = "1.0.0b1"
+__version__ = "1.0.0b2"