minchin.md-it.insert 1.0.0__tar.gz

minchin_md_it_insert-1.0.0/.requirements/base.in

@@ -0,0 +1 @@
+markdown-it-py

minchin_md_it_insert-1.0.0/.requirements/dev.in

@@ -0,0 +1,5 @@
+pip-tools
+minchin.releaser >= 0.9.5
+black
+isort
+pytest

minchin_md_it_insert-1.0.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: minchin.md-it.insert
+Version: 1.0.0
+Summary: insert, for Markdown-IT-py
+Author-email: William Minchin <w_minchin@hotmail.com>
+Maintainer-email: William Minchin <w_minchin@hotmail.com>
+License: AGPL-3.0
+Project-URL: Bug Tracker, https://github.com/MinchinWeb/minchin.md-it.insert/issues
+Project-URL: Repository, https://github.com/MinchinWeb/minchin.md-it.insert
+Project-URL: Changelog, https://github.com/MinchinWeb/minchin.md-it.insert/blob/master/CHANGELOG.rst
+Keywords: commonmark,markdown,plugin,insert
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/x-rst
+Requires-Dist: markdown-it-py
+Provides-Extra: dev
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: minchin.releaser>=0.9.5; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+Insert for Markdown-IT-Py
+=========================
+
+This is a plugin for the Python implementation of
+`Markdown-IT <https://github.com/executablebooks/markdown-it-py>`_ (a CommonMark
+parser) that provides insert (``<ins>``) via double pluses (``++``).
+
+Example usage::
+
+    >>> from markdown_it import MarkdownIt
+    >>> from minchin.md_it.insert import insert_plugin
+    >>> md = MarkdownIt().use(insert_plugin)
+    >>> md.render("I ++added++ this")
+    '<p>I <ins>added</ins> this</p>\\n'
+    >>> md.render("this++text\\\\ has\\\\ spaces++")
+    '<p>this<ins>text\\ has\\ spaces</ins></p>\\n'
+
+Tests can be run using ``pytest``.
+
+This is ported from hasgeek's Funnel, under the AGPL-3.0 license.

minchin_md_it_insert-1.0.0/README.rst

@@ -0,0 +1,20 @@
+Insert for Markdown-IT-Py
+=========================
+
+This is a plugin for the Python implementation of
+`Markdown-IT <https://github.com/executablebooks/markdown-it-py>`_ (a CommonMark
+parser) that provides insert (``<ins>``) via double pluses (``++``).
+
+Example usage::
+
+    >>> from markdown_it import MarkdownIt
+    >>> from minchin.md_it.insert import insert_plugin
+    >>> md = MarkdownIt().use(insert_plugin)
+    >>> md.render("I ++added++ this")
+    '<p>I <ins>added</ins> this</p>\\n'
+    >>> md.render("this++text\\\\ has\\\\ spaces++")
+    '<p>this<ins>text\\ has\\ spaces</ins></p>\\n'
+
+Tests can be run using ``pytest``.
+
+This is ported from hasgeek's Funnel, under the AGPL-3.0 license.

minchin_md_it_insert-1.0.0/minchin/md_it/insert/__init__.py

@@ -0,0 +1,14 @@
+"""Insert tag plugin, for Markdown-It."""
+
+from .funnel import insert_plugin
+
+__all__ = ("insert_plugin", )
+
+__title__ = "minchin.md-it.insert"
+__tagline__ = "Superscript, for Markdown-IT-Py"
+__version__ = "1.0.0"
+__author__ = "William Minchin"
+__email__ = "w_minchin@hotmail.com"
+__license__ = "AGPL-3.0 License"
+__copyright__ = "Copyright 2026 William Minchin"
+__url__ = "https://github.com/MinchinWeb/minchin.md-it.insert"

minchin_md_it_insert-1.0.0/minchin/md_it/insert/funnel.py

@@ -0,0 +1,167 @@
+"""
+Markdown-it-py plugin to introduce <ins> markup using ++inserted++.
+
+Ported from markdown_it.rules_inline.strikethrough.
+Extracted from ``funnel`` at
+    https://github.com/hasgeek/funnel/blob/main/funnel/utils/markdown/mdit_plugins/ins_tag.py
+    under the AGPL-3.0 license
+
+Copyright (c) 2026 William Minchin
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+
+from markdown_it import MarkdownIt
+from markdown_it.renderer import RendererHTML
+from markdown_it.rules_inline import StateInline
+from markdown_it.rules_inline.state_inline import Delimiter
+from markdown_it.token import Token
+from markdown_it.utils import EnvType, OptionsDict
+
+__all__ = ['insert_plugin']
+
+PLUS_CHAR = '+'
+
+
+def tokenize(state: StateInline, silent: bool) -> bool:
+    """Insert each marker as a separate text token, and add it to delimiter list."""
+    start = state.pos
+    ch = state.src[start]
+
+    if silent:
+        return False
+
+    if ch != PLUS_CHAR:
+        return False
+
+    scanned = state.scanDelims(state.pos, True)
+
+    length = scanned.length
+
+    if length < 2:
+        return False
+
+    if length % 2:
+        token = state.push('text', '', 0)
+        token.content = ch
+        length -= 1
+
+    i = 0
+    while i < length:
+        token = state.push('text', '', 0)
+        token.content = ch + ch
+        state.delimiters.append(
+            Delimiter(
+                marker=ord(ch),
+                length=0,  # disable "rule of 3" length checks meant for emphasis
+                token=len(state.tokens) - 1,
+                end=-1,
+                open=scanned.can_open,
+                close=scanned.can_close,
+            )
+        )
+        i += 2
+
+    state.pos += scanned.length
+    return True
+
+
+def _post_process(state: StateInline, delimiters: list[Delimiter]) -> None:
+    lone_markers = []
+    maximum = len(delimiters)
+
+    for i in range(maximum):
+        start_delim = delimiters[i]
+        if start_delim.marker != ord(PLUS_CHAR):
+            continue
+
+        if start_delim.end == -1:
+            continue
+
+        end_delim = delimiters[start_delim.end]
+
+        token = state.tokens[start_delim.token]
+        token.type = 'ins_open'
+        token.tag = 'ins'
+        token.nesting = 1
+        token.markup = PLUS_CHAR * 2
+        token.content = ''
+
+        token = state.tokens[end_delim.token]
+        token.type = 'ins_close'
+        token.tag = 'ins'
+        token.nesting = -1
+        token.markup = PLUS_CHAR * 2
+        token.content = ''
+
+        end_token = state.tokens[end_delim.token - 1]
+
+        if end_token.type == 'text' and end_token == PLUS_CHAR:
+            lone_markers.append(end_delim.token - 1)
+
+    # If a marker sequence has an odd number of characters, it's split
+    # like this: `+++++` -> `+` + `++` + `++`, leaving one marker at the
+    # start of the sequence.
+    #
+    # So, we have to move all those markers after subsequent ins_close tags.
+    #
+    while lone_markers:
+        i = lone_markers.pop()
+        j = i + 1
+
+        while j < len(state.tokens) and state.tokens[j].type == 'ins_close':
+            j += 1
+
+        j -= 1
+
+        if i != j:
+            token = state.tokens[j]
+            state.tokens[j] = state.tokens[i]
+            state.tokens[i] = token
+
+
+def ins_open(
+    renderer: RendererHTML,  # noqa: ARG001
+    tokens: Sequence[Token],  # noqa: ARG001
+    idx: int,  # noqa: ARG001
+    options: OptionsDict,  # noqa: ARG001
+    env: EnvType,  # noqa: ARG001
+) -> str:
+    return '<ins>'
+
+
+def ins_close(
+    renderer: RendererHTML,  # noqa: ARG001
+    tokens: Sequence[Token],  # noqa: ARG001
+    idx: int,  # noqa: ARG001
+    options: OptionsDict,  # noqa: ARG001
+    env: EnvType,  # noqa: ARG001
+) -> str:
+    return '</ins>'
+
+
+def post_process(state: StateInline) -> None:
+    """Walk through delimiter list and replace text tokens with tags."""
+    tokens_meta = state.tokens_meta
+    maximum = len(state.tokens_meta)
+    _post_process(state, state.delimiters)
+    curr = 0
+    while curr < maximum:
+        try:
+            curr_meta = tokens_meta[curr]
+        except IndexError:
+            pass
+        else:
+            if curr_meta and 'delimiters' in curr_meta:
+                _post_process(state, curr_meta["delimiters"])
+        curr += 1
+
+
+def insert_plugin(md: MarkdownIt) -> None:
+    """Render ``++text++`` markup with a HTML ``<ins>`` tag."""
+    md.inline.ruler.before('strikethrough', 'ins', tokenize)
+    md.inline.ruler2.before('strikethrough', 'ins', post_process)
+    md.add_render_rule('ins_open', ins_open)
+    md.add_render_rule('ins_close', ins_close)

minchin_md_it_insert-1.0.0/minchin.md_it.insert.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: minchin.md-it.insert
+Version: 1.0.0
+Summary: insert, for Markdown-IT-py
+Author-email: William Minchin <w_minchin@hotmail.com>
+Maintainer-email: William Minchin <w_minchin@hotmail.com>
+License: AGPL-3.0
+Project-URL: Bug Tracker, https://github.com/MinchinWeb/minchin.md-it.insert/issues
+Project-URL: Repository, https://github.com/MinchinWeb/minchin.md-it.insert
+Project-URL: Changelog, https://github.com/MinchinWeb/minchin.md-it.insert/blob/master/CHANGELOG.rst
+Keywords: commonmark,markdown,plugin,insert
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/x-rst
+Requires-Dist: markdown-it-py
+Provides-Extra: dev
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: minchin.releaser>=0.9.5; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+Insert for Markdown-IT-Py
+=========================
+
+This is a plugin for the Python implementation of
+`Markdown-IT <https://github.com/executablebooks/markdown-it-py>`_ (a CommonMark
+parser) that provides insert (``<ins>``) via double pluses (``++``).
+
+Example usage::
+
+    >>> from markdown_it import MarkdownIt
+    >>> from minchin.md_it.insert import insert_plugin
+    >>> md = MarkdownIt().use(insert_plugin)
+    >>> md.render("I ++added++ this")
+    '<p>I <ins>added</ins> this</p>\\n'
+    >>> md.render("this++text\\\\ has\\\\ spaces++")
+    '<p>this<ins>text\\ has\\ spaces</ins></p>\\n'
+
+Tests can be run using ``pytest``.
+
+This is ported from hasgeek's Funnel, under the AGPL-3.0 license.

minchin_md_it_insert-1.0.0/minchin.md_it.insert.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.rst
+pyproject.toml
+.requirements/base.in
+.requirements/dev.in
+minchin.md_it.insert.egg-info/PKG-INFO
+minchin.md_it.insert.egg-info/SOURCES.txt
+minchin.md_it.insert.egg-info/dependency_links.txt
+minchin.md_it.insert.egg-info/requires.txt
+minchin.md_it.insert.egg-info/top_level.txt
+minchin/md_it/insert/__init__.py
+minchin/md_it/insert/funnel.py
+tests/test_insert.py

minchin_md_it_insert-1.0.0/minchin.md_it.insert.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

minchin_md_it_insert-1.0.0/minchin.md_it.insert.egg-info/requires.txt

@@ -0,0 +1,8 @@
+markdown-it-py
+
+[dev]
+pip-tools
+minchin.releaser>=0.9.5
+black
+isort
+pytest

minchin_md_it_insert-1.0.0/minchin.md_it.insert.egg-info/top_level.txt

@@ -0,0 +1 @@
+minchin

minchin_md_it_insert-1.0.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["minchin*"]
+exclude = ["tests"]
+
+[tool.setuptools.dynamic]
+# this has to be the place the version is located via static analysis
+version = {attr = "minchin.md_it.insert.__version__"}
+# description = {attr = "minchin.jrnl.__description__"}  # must be pulled from file
+readme = {file = ["README.rst"], content-type = "text/x-rst"}
+dependencies = {file = [".requirements/base.in"]}
+
+[tool.setuptools.dynamic.optional-dependencies]
+dev = {file = [".requirements/dev.in"] }
+# release = {file = [".requirements/release.in"] }
+# docs = {file = [".requirements/docs.in"] }
+
+[project]
+name = "minchin.md-it.insert"
+description = "insert, for Markdown-IT-py"
+dynamic = [
+    "version",
+    # "description",
+    "readme",
+    "dependencies",
+    "optional-dependencies",
+]
+authors = [
+    {name = "William Minchin", email="w_minchin@hotmail.com" },
+]
+maintainers = [
+    {name = "William Minchin", email="w_minchin@hotmail.com" },
+]
+# requires-python = ">=3.6"
+keywords = ["commonmark", "markdown", "plugin", "insert"]
+license = {text = "AGPL-3.0"}
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Plugins",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Topic :: Text Processing :: Markup :: Markdown",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+# "Homepage" =
+"Bug Tracker" = "https://github.com/MinchinWeb/minchin.md-it.insert/issues"
+# Documentation = 
+Repository = "https://github.com/MinchinWeb/minchin.md-it.insert"
+Changelog = "https://github.com/MinchinWeb/minchin.md-it.insert/blob/master/CHANGELOG.rst"
+# "Release Notes"
+
+
+[tool.isort]
+# Maintain compatibility with Black
+profile = "black"
+# multi_line_output = 3
+
+# Sort imports within their section independent of the import type
+force_sort_within_sections = true
+
+known_first_party = ["minchin"]
+sections = "FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER"
+
+skip_gitignore = true
+
+[tool.black]
+line-length = 88
+
+[tool.flake8]
+# requires flake8-pyproject to read this
+ignore = [
+    "E203",  # conflicts with `black`
+    "W503",  # "line break before binary operator", conflicts with `black`
+]
+max-line-length = 88
+count = true

minchin_md_it_insert-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

minchin_md_it_insert-1.0.0/tests/test_insert.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+
+from markdown_it import MarkdownIt
+from markdown_it.utils import read_fixture_file
+import pytest
+
+from minchin.md_it.insert import insert_plugin
+
+FIXTURE_PATH = Path(__file__).parent.joinpath("fixtures")
+
+
+@pytest.mark.parametrize(
+    "line,title,input,expected",
+    read_fixture_file(FIXTURE_PATH.joinpath("insert.md")),
+)
+def test_insert_fixtures(line, title, input, expected):
+    md = MarkdownIt("commonmark").use(insert_plugin)
+    md.options["xhtmlOut"] = False
+    text = md.render(input)
+    assert text.rstrip() == expected.rstrip()