= RCFT-PyMarkdown
Matthew Norton <matt@carrotmanmatt.com>
v1.0, 02/05/2024
ifndef::env-idea[]
include::.asciidoctorconfig[]
endif::[]
A Python wrapper around {url-pymarkdown}[jackdewinter's PyMarkdown linter] to remove custom-formatted tables in {labelled-url-wiki-markdown} files.
image:https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCarrotManMatt%2Frcft-pymarkdown%2Fmain%2Fpyproject.toml&query=%24.tool.poetry.version&label=RCFT-PyMarkdown[Current Version,link={url-project-repo}]
image:https://img.shields.io/badge/Python-3.12-blue?&logo=Python&logoColor=white[Python Version,link={url-python-312}]
image:https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCarrotManMatt%2Frcft-pymarkdown%2Fmain%2Fpoetry.lock&query=%24.package%5B%3F%28%40.name%3D%3D%27pymarkdownlnt%27%29%5D.version&logo=Markdown&label=PyMarkdown[PyMarkdown Version,link={url-pymarkdown}]
image:https://github.com/CarrotManMatt/rcft-pymarkdown/actions/workflows/tests.yaml/badge.svg[Tests Status,link={url-project-repo}/actions/workflows/tests.yaml]
image:https://img.shields.io/badge/mypy-checked-%232EBB4E&label=mypy[mypy Status,link={url-mypy}]
image:https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json[Ruff,link={url-ruff}]
image:https://results.pre-commit.ci/badge/github/CarrotManMatt/rcft-pymarkdown/main.svg[pre-commit.ci Status,link=https://results.pre-commit.ci/latest/github/CarrotManMatt/rcft-pymarkdown/main]
image:https://img.shields.io/badge/validated-brightgreen?logo=asciidoctor&label=Asciidoctor[Asciidoctor Status,link={url-asciidoc-asciidoctor}]
image:https://img.shields.io/badge/validated-brightgreen?logo=yaml&label=yamllint[yamllint Status,link={url-yamllint}]
When running {labelled-url-pymarkdown} it may incorrectly flag errors inside a table that has correct formatting.
Using this wrapper, the tables will temporarily be removed to prevent these incorrect errors.
WARNING: **Your tables within any {labelled-url-wiki-markdown} files will not be linted**.
This is because temporary files are created that do not include the tables, and these files are then linted.
== Usage
If you require sending additional arguments to the `+pymarkdown+` command you must <<manually-removing-custom-formatted-tables,manually remove>> and then <<manually-restoring-custom-formatted-tables,manually restore>> the custom-formatted tables from {labelled-url-wiki-markdown} files.
=== Scanning All Files After Removing Custom-Formatted Tables
To perform linting using {labelled-url-pymarkdown}, after removing custom-formatted tables, use the `+scan-all+` action:
[source,console]
$ rcft-pymarkdown scan-all
[#manually-removing-custom-formatted-tables]
=== Manually Removing Custom-Formatted Tables
To manually remove any custom-formatted tables without running {labelled-url-pymarkdown}, use the `+remove+` action:
[source,console]
$ rcft-pymarkdown remove
[#manually-restoring-custom-formatted-tables]
=== Manually Restoring Custom-Formatted Tables
To manually restore any custom-formatted tables without running {labelled-url-pymarkdown}, use the `+restore+` action:
[source,console]
$ rcft-pymarkdown restore
Raw data
{
"_id": null,
"home_page": "https://github.com/CarrotManMatt/rcft-pymarkdown.git",
"name": "RCFT-PyMarkdown",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "markdown, linter, static analysis",
"author": "CarrotManMatt",
"author_email": "matt@carrotmanmatt.com",
"download_url": "https://files.pythonhosted.org/packages/9a/89/76b10bd9ed7c02c6f7afe9e337b7a5cf2fe94c92f28b6ff1673f1ff5e41e/rcft_pymarkdown-1.0.4.tar.gz",
"platform": null,
"description": "= RCFT-PyMarkdown\nMatthew Norton <matt@carrotmanmatt.com>\nv1.0, 02/05/2024\n\nifndef::env-idea[]\ninclude::.asciidoctorconfig[]\nendif::[]\n\nA Python wrapper around {url-pymarkdown}[jackdewinter's PyMarkdown linter] to remove custom-formatted tables in {labelled-url-wiki-markdown} files.\n\nimage:https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCarrotManMatt%2Frcft-pymarkdown%2Fmain%2Fpyproject.toml&query=%24.tool.poetry.version&label=RCFT-PyMarkdown[Current Version,link={url-project-repo}]\nimage:https://img.shields.io/badge/Python-3.12-blue?&logo=Python&logoColor=white[Python Version,link={url-python-312}]\nimage:https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2FCarrotManMatt%2Frcft-pymarkdown%2Fmain%2Fpoetry.lock&query=%24.package%5B%3F%28%40.name%3D%3D%27pymarkdownlnt%27%29%5D.version&logo=Markdown&label=PyMarkdown[PyMarkdown Version,link={url-pymarkdown}]\nimage:https://github.com/CarrotManMatt/rcft-pymarkdown/actions/workflows/tests.yaml/badge.svg[Tests Status,link={url-project-repo}/actions/workflows/tests.yaml]\nimage:https://img.shields.io/badge/mypy-checked-%232EBB4E&label=mypy[mypy Status,link={url-mypy}]\nimage:https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json[Ruff,link={url-ruff}]\nimage:https://results.pre-commit.ci/badge/github/CarrotManMatt/rcft-pymarkdown/main.svg[pre-commit.ci Status,link=https://results.pre-commit.ci/latest/github/CarrotManMatt/rcft-pymarkdown/main]\nimage:https://img.shields.io/badge/validated-brightgreen?logo=asciidoctor&label=Asciidoctor[Asciidoctor Status,link={url-asciidoc-asciidoctor}]\nimage:https://img.shields.io/badge/validated-brightgreen?logo=yaml&label=yamllint[yamllint Status,link={url-yamllint}]\n\n\nWhen running {labelled-url-pymarkdown} it may incorrectly flag errors inside a table that has correct formatting.\nUsing this wrapper, the tables will temporarily be removed to prevent these incorrect errors.\n\nWARNING: **Your tables within any {labelled-url-wiki-markdown} files will not be linted**.\nThis is because temporary files are created that do not include the tables, and these files are then linted.\n\n== Usage\n\nIf you require sending additional arguments to the `+pymarkdown+` command you must <<manually-removing-custom-formatted-tables,manually remove>> and then <<manually-restoring-custom-formatted-tables,manually restore>> the custom-formatted tables from {labelled-url-wiki-markdown} files.\n\n=== Scanning All Files After Removing Custom-Formatted Tables\n\nTo perform linting using {labelled-url-pymarkdown}, after removing custom-formatted tables, use the `+scan-all+` action:\n\n[source,console]\n$ rcft-pymarkdown scan-all\n\n[#manually-removing-custom-formatted-tables]\n=== Manually Removing Custom-Formatted Tables\n\nTo manually remove any custom-formatted tables without running {labelled-url-pymarkdown}, use the `+remove+` action:\n\n[source,console]\n$ rcft-pymarkdown remove\n\n[#manually-restoring-custom-formatted-tables]\n=== Manually Restoring Custom-Formatted Tables\n\nTo manually restore any custom-formatted tables without running {labelled-url-pymarkdown}, use the `+restore+` action:\n\n[source,console]\n$ rcft-pymarkdown restore\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Python wrapper around jackdewinter's PyMarkdown linter to remove custom tables in Markdown files",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/CarrotManMatt/rcft-pymarkdown.git",
"Repository": "https://github.com/CarrotManMatt/rcft-pymarkdown.git"
},
"split_keywords": [
"markdown",
" linter",
" static analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7ef151659eeff10913cea82cc93caf05f20672078e0b7516fd8ea20f8550529c",
"md5": "88320de0e77cd049d22c0463c8b1e175",
"sha256": "a72840d3482c025dbc258e8e8b78067c3b7375b9573d2bc109118a7d3c916d56"
},
"downloads": -1,
"filename": "rcft_pymarkdown-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88320de0e77cd049d22c0463c8b1e175",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 12461,
"upload_time": "2024-05-04T20:05:01",
"upload_time_iso_8601": "2024-05-04T20:05:01.730607Z",
"url": "https://files.pythonhosted.org/packages/7e/f1/51659eeff10913cea82cc93caf05f20672078e0b7516fd8ea20f8550529c/rcft_pymarkdown-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a8976b10bd9ed7c02c6f7afe9e337b7a5cf2fe94c92f28b6ff1673f1ff5e41e",
"md5": "02123d022519a06896a96bad7fac99fd",
"sha256": "9d08e4e7380c1f8e04c036d0faf4897fe137a24461b2b01bca3e91cb05cc5338"
},
"downloads": -1,
"filename": "rcft_pymarkdown-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "02123d022519a06896a96bad7fac99fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 11554,
"upload_time": "2024-05-04T20:05:02",
"upload_time_iso_8601": "2024-05-04T20:05:02.938908Z",
"url": "https://files.pythonhosted.org/packages/9a/89/76b10bd9ed7c02c6f7afe9e337b7a5cf2fe94c92f28b6ff1673f1ff5e41e/rcft_pymarkdown-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 20:05:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CarrotManMatt",
"github_project": "rcft-pymarkdown",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rcft-pymarkdown"
}
JSON
