fix(style): tag markdownlint.toml as a markdown style

andreoliwa · Nov 5, 2023 · 578bfb5 · 578bfb5
1 parent 532ec06
commit 578bfb5
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -190,8 +190,6 @@ any
      - `EditorConfig <https://editorconfig.org/>`_
    * - `py://nitpick/resources/any/git-legal <src/nitpick/resources/any/git-legal.toml>`_
      - `Git.legal - CodeClimate Community Edition <https://github.com/kmewhort/git.legal-codeclimate>`_
-   * - `py://nitpick/resources/any/markdownlint <src/nitpick/resources/any/markdownlint.toml>`_
-     - `Markdown lint <https://github.com/markdownlint/markdownlint>`_
    * - `py://nitpick/resources/any/pre-commit-hooks <src/nitpick/resources/any/pre-commit-hooks.toml>`_
      - `pre-commit hooks for any project <https://github.com/pre-commit/pre-commit-hooks>`_
    * - `py://nitpick/resources/any/prettier <src/nitpick/resources/any/prettier.toml>`_
@@ -219,6 +217,17 @@ kotlin
    * - `py://nitpick/resources/kotlin/ktlint <src/nitpick/resources/kotlin/ktlint.toml>`_
      - `ktlint <https://github.com/pinterest/ktlint>`_
 
+markdown
+~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+
+   * - Style URL
+     - Description
+   * - `py://nitpick/resources/markdown/markdownlint <src/nitpick/resources/markdown/markdownlint.toml>`_
+     - `Markdown lint <https://github.com/markdownlint/markdownlint>`_
+
 presets
 ~~~~~~~
 

diff --git a/docs/library.rst b/docs/library.rst
@@ -31,8 +31,6 @@ any
      - `EditorConfig <https://editorconfig.org/>`_
    * - :gitref:`py://nitpick/resources/any/git-legal <src/nitpick/resources/any/git-legal.toml>`
      - `Git.legal - CodeClimate Community Edition <https://github.com/kmewhort/git.legal-codeclimate>`_
-   * - :gitref:`py://nitpick/resources/any/markdownlint <src/nitpick/resources/any/markdownlint.toml>`
-     - `Markdown lint <https://github.com/markdownlint/markdownlint>`_
    * - :gitref:`py://nitpick/resources/any/pre-commit-hooks <src/nitpick/resources/any/pre-commit-hooks.toml>`
      - `pre-commit hooks for any project <https://github.com/pre-commit/pre-commit-hooks>`_
    * - :gitref:`py://nitpick/resources/any/prettier <src/nitpick/resources/any/prettier.toml>`
@@ -60,6 +58,17 @@ kotlin
    * - :gitref:`py://nitpick/resources/kotlin/ktlint <src/nitpick/resources/kotlin/ktlint.toml>`
      - `ktlint <https://github.com/pinterest/ktlint>`_
 
+markdown
+~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+
+   * - Style URL
+     - Description
+   * - :gitref:`py://nitpick/resources/markdown/markdownlint <src/nitpick/resources/markdown/markdownlint.toml>`
+     - `Markdown lint <https://github.com/markdownlint/markdownlint>`_
+
 presets
 ~~~~~~~
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -15,7 +15,7 @@ exceptiongroup==1.1.3 ; python_version >= "3.8" and python_version < "3.11"
 flake8==5.0.4 ; python_version >= "3.8" and python_version < "4.0"
 flatten-dict==0.4.2 ; python_version >= "3.8" and python_version < "4.0"
 furl==2.1.3 ; python_version >= "3.8" and python_version < "4.0"
-identify==2.5.31 ; python_version >= "3.8" and python_version < "4.0"
+identify==2.5.30 ; python_version >= "3.8" and python_version < "4.0"
 idna==3.4 ; python_version >= "3.8" and python_version < "4.0"
 imagesize==1.4.1 ; python_version >= "3.8" and python_version < "4.0"
 importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10"

diff --git a/docs/source/nitpick.resources.markdown.rst b/docs/source/nitpick.resources.markdown.rst
@@ -0,0 +1,7 @@
+nitpick.resources.markdown package
+==================================
+
+.. automodule:: nitpick.resources.markdown
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/nitpick.resources.rst b/docs/source/nitpick.resources.rst
@@ -15,6 +15,7 @@ Subpackages
    nitpick.resources.any
    nitpick.resources.javascript
    nitpick.resources.kotlin
+   nitpick.resources.markdown
    nitpick.resources.presets
    nitpick.resources.proto
    nitpick.resources.python

diff --git a/src/nitpick/resources/markdown/__init__.py b/src/nitpick/resources/markdown/__init__.py
@@ -0,0 +1 @@
+"""Styles for Markdown files."""
diff --git a/src/nitpick/resources/any/markdownlint.toml → ...pick/resources/markdown/markdownlint.toml b/src/nitpick/resources/any/markdownlint.toml → ...pick/resources/markdown/markdownlint.toml
diff --git a/src/nitpick/resources/presets/nitpick.toml b/src/nitpick/resources/presets/nitpick.toml
@@ -28,7 +28,7 @@ include = [
     "py://nitpick/resources/any/editorconfig",
     "py://nitpick/resources/any/git-legal",
     "py://nitpick/resources/any/pre-commit-hooks",
-    "py://nitpick/resources/any/markdownlint",
+    "py://nitpick/resources/markdown/markdownlint",
 
     "py://nitpick/resources/shell/bashate",
     "py://nitpick/resources/shell/shellcheck",

diff --git a/...builtin/any/markdownlint/.codeclimate.yml → ...in/markdown/markdownlint/.codeclimate.yml b/...builtin/any/markdownlint/.codeclimate.yml → ...in/markdown/markdownlint/.codeclimate.yml
diff --git a/tests/test_builtin/real.toml b/tests/test_builtin/real.toml
@@ -28,7 +28,7 @@ include = [
     "py://nitpick/resources/any/editorconfig",
     "py://nitpick/resources/any/git-legal",
     "py://nitpick/resources/any/pre-commit-hooks",
-    "py://nitpick/resources/any/markdownlint",
+    "py://nitpick/resources/markdown/markdownlint",
 
     "py://nitpick/resources/shell/bashate",
     "py://nitpick/resources/shell/shellcheck",