chore: use default config from mkdocs.yml #27

Author: daxartio

Makefile

@@ -53,15 +53,13 @@ test-report:  ## Report testing
 
 .PHONY: lint
 lint:  ## Check code
-	$(RUNNER) ruff $(CODE)
-	$(RUNNER) black --check $(CODE)
+	$(RUNNER) ruff check $(CODE)
 	$(RUNNER) pytest --dead-fixtures --dup-fixtures
 	$(RUNNER) mypy $(CODE)
 
 .PHONY: format
 format:  ## Formatting code
-	$(RUNNER) ruff --fix-only $(CODE)
-	$(RUNNER) black $(CODE)
+	$(RUNNER) ruff format $(CODE)
 
 .PHONY: docs
 docs:  ## Build docs

docs/configuration.md

@@ -15,7 +15,7 @@ plugins:
         - "$"
 ```
 
-You can override configurations for each block. If you set a part of the settings, the other part will be set to the default value.
+You can override configurations for each block. If you set a part of the settings, the other part will be set to the default value from `mkdocs.yml`.
 
 `<!-- termynal: {"prompt_literal_start": ["$", ">>>", "PS >"], title: powershell, buttons: windows} -->`
 

pyproject.toml

@@ -26,14 +26,13 @@ mkdocs = ["mkdocs >= 1.4"]
 
 [dependency-groups]
 dev = [
-    "black >= 24.10",
     "mypy >= 1.13.0",
     "pytest >= 7.4",
     "pytest-cov >= 4.1",
     "pytest-deadfixtures >= 2.2",
     "pytest-mock >= 3.14",
     "pyyaml >= 6.0",
-    "ruff >= 0.1",
+    "ruff < 1",
     "types-markdown >= 3.7",
     "types-pyyaml >= 6.0",
 ]
@@ -85,63 +84,10 @@ fail_under = 94
 addopts = "--strict-markers --showlocals --verbosity 2"
 log_level = "DEBUG"
 
-[tool.ruff]
-select = [
-    "F",
-    "E",
-    "W",
-    "C90",
-    "I",
-    "N",
-    "D",
-    # "UP",
-    "YTT",
-    # "ANN",
-    "S",
-    "BLE",
-    # "FBT",
-    "B",
-    "A",
-    "COM",
-    "C4",
-    "DTZ",
-    "T10",
-    "EM",
-    "EXE",
-    "ISC",
-    "ICN",
-    "G",
-    "INP",
-    "PIE",
-    "T20",
-    "PT",
-    "Q",
-    "RET",
-    "SIM",
-    "TID",
-    "TCH",
-    "ARG",
-    "PTH",
-    "ERA",
-    "PD",
-    # "PGH",
-    "PL",
-    "TRY",
-    "RSE",
-    "RUF",
-]
-ignore = [
-    "D100",
-    "D101",
-    "D102",
-    "D103",
-    "D104",
-    "D105",
-    "D106",
-    "D107",
-    "D203",
-    "D213",
-    "D401",
-    "S101",
-]
+[tool.ruff.lint]
+select = []
+ignore = []
 exclude = []
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101"]

termynal/markdown.py

@@ -2,7 +2,16 @@
 import re
 from enum import Enum
 from textwrap import dedent
-from typing import TYPE_CHECKING, Any, Dict, Iterable, List, NamedTuple, Optional, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Dict,
+    List,
+    NamedTuple,
+    Optional,
+    Sequence,
+    Union,
+)
 
 import yaml
 import yaml.parser
@@ -22,7 +31,7 @@ class Buttons(str, Enum):
 
 class Config(NamedTuple):
     title: str
-    prompt_literal_start: Iterable[str]
+    prompt_literal_start: Sequence[str]
     buttons: Buttons
 
 
@@ -47,7 +56,7 @@ def __repr__(self) -> str:  # pragma:no cover
 ParsedBlock = Union[Command, Comment, Output, Progress]
 
 
-def make_regex_prompts(prompt_literal_start: Iterable[str]) -> "re.Pattern[str]":
+def make_regex_prompts(prompt_literal_start: Sequence[str]) -> "re.Pattern[str]":
     prompt_literal_start = [re.escape(p).strip() for p in prompt_literal_start]
     prompt_to_replace = {
         ">": ">",
@@ -88,7 +97,7 @@ def add_spaces(code: str, spaces: str) -> str:
     return "\n".join(result)
 
 
-def parse_config(raw: str) -> Optional[Config]:
+def parse_config(raw: str, default: Optional[Config]) -> Optional[Config]:
     try:
         config = yaml.full_load(raw)
     except yaml.parser.ParserError:  # pragma:no cover
@@ -97,14 +106,22 @@ def parse_config(raw: str) -> Optional[Config]:
     if not isinstance(config, dict):
         return None
 
-    return parse_config_from_dict(config)
+    return parse_config_from_dict(config, default)
 
 
-def parse_config_from_dict(config: Dict[str, Any]) -> Config:
+def parse_config_from_dict(
+    config: Dict[str, Any],
+    default: Optional[Config] = None,
+) -> Config:
     return Config(
-        title=str(config.get("title", "bash")),
-        prompt_literal_start=list(config.get("prompt_literal_start", ("$",))),
-        buttons=Buttons(config.get("buttons", "macos")),
+        title=str(config.get("title", default.title if default else "bash")),
+        prompt_literal_start=list(
+            config.get(
+                "prompt_literal_start",
+                default.prompt_literal_start if default else ("$",),
+            ),
+        ),
+        buttons=Buttons(config.get("buttons", default.buttons if default else "macos")),
     )
 
 
@@ -236,7 +253,7 @@ def run(self, lines: List[str]) -> List[str]:
                 spaces = m.group("spaces") or ""
                 config_raw = (m.group("config") or "").strip()
                 if config_raw:
-                    config = parse_config(config_raw)
+                    config = parse_config(config_raw, self.config)
                     if config:
                         termynal = Termynal(config)
 

tests/test_markdown_extension.py

@@ -35,6 +35,6 @@ def test_cases_yml(
             TermynalExtension(**config),
         ],
     )
-    assert (
-        html == expected_html
-    ), "The expected html is different, see tests/test_cases.yml"
+    assert html == expected_html, (
+        "The expected html is different, see tests/test_cases.yml"
+    )