Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit 7958ad4

Browse files
author
Jeremy Wiebe
committed
Update test docs for upgraded remark lib and new tests
1 parent 201921a commit 7958ad4

File tree

4 files changed

+59
-24
lines changed

4 files changed

+59
-24
lines changed

docs/test/bad.expected.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
{}
12
Used to test violations of style.
23

34
## BAD: Starting with wrong level heading.
@@ -44,21 +45,20 @@ BAD: Indented code-block.
4445
# Indented code block
4546

4647
BAD: Missing newline at end of file.
47-
docs/test/bad.md
48-
1:1 warning Missing newline character at end of file final-newline remark-lint
49-
7:1-7:43 warning Heading levels should increment by one level at a time heading-increment remark-lint
50-
9:1-9:33 warning Don’t use multiple top level headings (9:1) no-multiple-toplevel-headings remark-lint
51-
13:1-13:27 warning Do not use headings with similar content (11:1) no-duplicate-headings remark-lint
52-
15:104 warning Line must be at most 80 characters maximum-line-length remark-lint
53-
18:5 warning Incorrect list-item indent: remove 2 spaces list-item-indent remark-lint
54-
26:4 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
55-
30:1-30:8 warning Marker style should be `-` unordered-list-marker-style remark-lint
56-
30:4 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
57-
34:5 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
58-
35:1-35:9 warning Marker should be `2`, was `1` ordered-list-marker-value remark-lint
59-
35:5 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
60-
38:1 warning Remove 1 line before node no-consecutive-blank-lines remark-lint
61-
40:1-42:4 warning Missing code-language flag fenced-code-flag remark-lint
62-
46:1-46:26 warning Code blocks should be fenced code-block-style remark-lint
63-
64-
⚠ 15 warnings
48+
bad.md
49+
7:1-7:43 warning Heading levels should increment by one level at a time heading-increment remark-lint
50+
9:1-9:33 warning Don’t use multiple top level headings (9:1) no-multiple-toplevel-headings remark-lint
51+
13:1-13:27 warning Do not use headings with similar content per section (11:1) no-duplicate-headings-in-section remark-lint
52+
15:104 warning Line must be at most 80 characters maximum-line-length remark-lint
53+
18:5 warning Incorrect list-item indent: remove 2 spaces list-item-indent remark-lint
54+
26:4 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
55+
30:1-30:8 warning Marker style should be `-` unordered-list-marker-style remark-lint
56+
30:4 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
57+
34:5 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
58+
35:1-35:9 warning Marker should be `2`, was `1` ordered-list-marker-value remark-lint
59+
35:5 warning Incorrect list-item indent: remove 1 space list-item-indent remark-lint
60+
38:1 warning Remove 1 line before node no-consecutive-blank-lines remark-lint
61+
40:1-42:4 warning Missing code-language flag fenced-code-flag remark-lint
62+
46:1-46:26 warning Code blocks should be fenced code-block-style remark-lint
63+
64+
⚠ 14 warnings

docs/test/bad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ BAD: Indented code-block.
4545

4646
# Indented code block
4747

48-
BAD: Missing newline at end of file.
48+
BAD: Missing newline at end of file.

docs/test/good.expected.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1+
{}
12
Used to test style.
23

34
# GOOD: Starting level one heading.
45

56
## GOOD: One level step down headings.
67

7-
<!--lint disable no-duplicate-headings -->
8+
<!--lint disable no-duplicate-headings-in-section -->
89

910
### GOOD: Repeated Content when rule is disabled
1011

1112
### GOOD: Repeated Content when rule is disabled
1213

13-
<!--lint enable no-duplicate-headings -->
14+
<!--lint enable no-duplicate-headings-in-section -->
15+
16+
## GOOD: Section with subsections that duplicate
17+
18+
This section has subsections that contain identical headers (steps) which
19+
should be allowed by `no-duplicate-headings-in-section`
20+
21+
### GOOD: Section A
22+
23+
#### GOOD: Step 1
24+
25+
#### GOOD: Step 2
26+
27+
### GOOD: Section B
28+
29+
#### GOOD: Step 1
30+
31+
#### GOOD: Step 2
1432

1533
GOOD: Sentences that are just long enough that they don't need to be wrapped!!!
1634

@@ -28,4 +46,4 @@ GOOD: Fenced code-blocks with langauge.
2846
```python
2947
print 'Hello Mobify'
3048
```
31-
docs/test/good.md: no issues found
49+
good.md: no issues found

docs/test/good.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,30 @@ Used to test style.
44

55
## GOOD: One level step down headings.
66

7-
<!--lint disable no-duplicate-headings -->
7+
<!--lint disable no-duplicate-headings-in-section -->
88

99
### GOOD: Repeated Content when rule is disabled
1010

1111
### GOOD: Repeated Content when rule is disabled
1212

13-
<!--lint enable no-duplicate-headings -->
13+
<!--lint enable no-duplicate-headings-in-section -->
14+
15+
## GOOD: Section with subsections that duplicate
16+
17+
This section has subsections that contain identical headers (steps) which
18+
should be allowed by `no-duplicate-headings-in-section`
19+
20+
### GOOD: Section A
21+
22+
#### GOOD: Step 1
23+
24+
#### GOOD: Step 2
25+
26+
### GOOD: Section B
27+
28+
#### GOOD: Step 1
29+
30+
#### GOOD: Step 2
1431

1532
GOOD: Sentences that are just long enough that they don't need to be wrapped!!!
1633

0 commit comments

Comments
 (0)