1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
import sys
from unittest import mock
import pytest
from mdformat._cli import run
from tests.utils import FORMATTED_MARKDOWN, UNFORMATTED_MARKDOWN
def test_cli_override(tmp_path):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("wrap = 'no'\nend_of_line = 'lf'")
file_path = tmp_path / "test_markdown.md"
file_path.write_text("remove\nthis\nwrap\n")
assert run((str(file_path), "--wrap=keep")) == 0
assert file_path.read_text() == "remove\nthis\nwrap\n"
assert run((str(file_path),)) == 0
assert file_path.read_text() == "remove this wrap\n"
def test_conf_in_parent_dir(tmp_path):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("wrap = 'no'")
subdir_path = tmp_path / "subdir"
subdir_path.mkdir()
file_path = subdir_path / "test_markdown.md"
file_path.write_text("remove\nthis\nwrap")
assert run((str(file_path),)) == 0
assert file_path.read_text() == "remove this wrap\n"
def test_invalid_conf_key(tmp_path, capsys):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("numberr = true")
file_path = tmp_path / "test_markdown.md"
file_path.write_text("1. one\n1. two\n1. three")
assert run((str(file_path),)) == 1
captured = capsys.readouterr()
assert "Invalid key 'numberr'" in captured.err
def test_invalid_toml(tmp_path, capsys):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("]invalid TOML[")
file_path = tmp_path / "test_markdown.md"
file_path.write_text("some markdown\n")
assert run((str(file_path),)) == 1
captured = capsys.readouterr()
assert "Invalid TOML syntax" in captured.err
@pytest.mark.parametrize(
"conf_key, bad_conf",
[
("wrap", "wrap = -3"),
("end_of_line", "end_of_line = 'lol'"),
("validate", "validate = 'off'"),
("number", "number = 0"),
("exclude", "exclude = '**'"),
("exclude", "exclude = ['1',3]"),
("plugin", "plugin = []"),
("plugin", "plugin.gfm = {}\nplugin.myst = 1"),
("codeformatters", "codeformatters = 'python'"),
("extensions", "extensions = 'gfm'"),
("codeformatters", "codeformatters = ['python', 1]"),
("extensions", "extensions = ['gfm', 1]"),
],
)
def test_invalid_conf_value(bad_conf, conf_key, tmp_path, capsys):
if conf_key == "exclude" and sys.version_info < (3, 13):
pytest.skip("exclude conf only on Python 3.13+")
config_path = tmp_path / ".mdformat.toml"
config_path.write_text(bad_conf)
file_path = tmp_path / "test_markdown.md"
file_path.write_text("# Test Markdown")
assert run((str(file_path),)) == 1
captured = capsys.readouterr()
assert f"Invalid '{conf_key}' value" in captured.err
def test_conf_with_stdin(tmp_path, capfd, patch_stdin):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("number = true")
patch_stdin("1. one\n1. two\n1. three")
with mock.patch("mdformat._cli.Path.cwd", return_value=tmp_path):
assert run(("-",), cache_toml=False) == 0
captured = capfd.readouterr()
assert captured.out == "1. one\n2. two\n3. three\n"
@pytest.mark.skipif(
sys.version_info >= (3, 13), reason="'exclude' only possible on 3.13+"
)
def test_exclude_conf_on_old_python(tmp_path, capsys):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("exclude = ['**']")
file_path = tmp_path / "test_markdown.md"
file_path.write_text("# Test Markdown")
assert run((str(file_path),)) == 1
assert "only available on Python 3.13+" in capsys.readouterr().err
@pytest.mark.skipif(
sys.version_info < (3, 13), reason="'exclude' only possible on 3.13+"
)
def test_exclude(tmp_path, capsys):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("exclude = ['dir1/*', 'file1.md']")
dir1_path = tmp_path / "dir1"
file1_path = tmp_path / "file1.md"
file2_path = tmp_path / "file2.md"
file3_path = tmp_path / dir1_path / "file3.md"
dir1_path.mkdir()
file1_path.write_text(UNFORMATTED_MARKDOWN)
file2_path.write_text(UNFORMATTED_MARKDOWN)
file3_path.write_text(UNFORMATTED_MARKDOWN)
assert run((str(tmp_path),)) == 0
assert file1_path.read_text() == UNFORMATTED_MARKDOWN
assert file2_path.read_text() == FORMATTED_MARKDOWN
assert file3_path.read_text() == UNFORMATTED_MARKDOWN
@pytest.mark.skipif(
sys.version_info < (3, 13), reason="'exclude' only possible on 3.13+"
)
def test_empty_exclude(tmp_path, capsys):
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("exclude = []")
file1_path = tmp_path / "file1.md"
file1_path.write_text(UNFORMATTED_MARKDOWN)
assert run((str(tmp_path),)) == 0
assert file1_path.read_text() == FORMATTED_MARKDOWN
def test_conf_no_validate(tmp_path):
file_path = tmp_path / "file.md"
content = "1. ordered"
file_path.write_text(content)
with mock.patch(
"mdformat.renderer._context.get_list_marker_type",
return_value="?",
):
assert run((str(file_path),), cache_toml=False) == 1
assert file_path.read_text() == content
config_path = tmp_path / ".mdformat.toml"
config_path.write_text("validate = false")
assert run((str(file_path),), cache_toml=False) == 0
assert file_path.read_text() == "1? ordered\n"
|
