Skip to content

Markdownlint: Fix TOP009 errors in existing custom rule test files #30060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 2, 2025
Merged

Markdownlint: Fix TOP009 errors in existing custom rule test files #30060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f55515
Fix TOP009 errors in existing custom rule test files
mao-sz Sep 1, 2025
187d506
Disable TOP008 for TOP006 test file
mao-sz Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### The following links should NOT be flagged

Expand All @@ -20,16 +20,16 @@

### The following links SHOULD be flagged

[this](someURL)

Check failure on line 23 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:23 TOP001/descriptive-link-text-labels Links must have descriptive text labels [Expected text to not include the words "this" or "here". Use a more descriptive text that clearly conveys the purpose or content of the link.] [Context: "[this](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[This video](someURL)

Check failure on line 24 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:24 TOP001/descriptive-link-text-labels Links must have descriptive text labels [Expected text to not include the words "this" or "here". Use a more descriptive text that clearly conveys the purpose or content of the link.] [Context: "[This video](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[video](someURL)

Check failure on line 25 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:25 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["video" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[video](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[videos](someURL)

Check failure on line 26 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:26 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["videos" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[videos](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[a video](someURL)

Check failure on line 27 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:27 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["a video" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[a video](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[docs](someURL)

Check failure on line 28 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:28 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["docs" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[docs](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[the documentation](someURL)

Check failure on line 29 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:29 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["the documentation" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[the documentation](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[their documentation](someURL)

Check failure on line 30 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:30 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["their documentation" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[their documentation](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[page](someURL)

Check failure on line 31 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:31 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["page" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[page](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[their homepage](someURL)

Check failure on line 32 in markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md

View workflow job for this annotation

GitHub Actions / Lint lesson/project files

Links must have descriptive text labels 

markdownlint/TOP001_descriptiveLinkTextLabels/tests/TOP001_test.md:32 TOP001/descriptive-link-text-labels Links must have descriptive text labels ["their homepage" is not sufficiently descriptive by itself. Use a more descriptive label that clearly conveys the purpose or content of the link.] [Context: "[their homepage](someURL)"] https://github.com/TheOdinProject/curriculum/blob/main/markdownlint/docs/TOP001.md
[playlist](someURL)
[a playlist](someURL)
[here](someURL)
Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP002_noCodeInHeadings/tests/TOP002_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Text content.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### This heading should NOT be flagged

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP003_defaultSectionContent/tests/TOP003_test_content-around-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This section contains a general overview of topics that you will learn in this l

Some additional content before the list that should flag an error.

- LO item
- LO item.

Some additional content after the list that should flag an error.

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP003_defaultSectionContent/tests/TOP003_test_incorrect-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Text content

This section has the wrong text following the heading that should flag an error.

- LO item
- LO item.

### Custom section

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP003_defaultSectionContent/tests/TOP003_test_missing-wrapper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Text content

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Custom section

Expand Down
6 changes: 3 additions & 3 deletions ...nlint/TOP003_defaultSectionContent/tests/TOP003_test_nested-and-ordered-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Text content

This section contains a general overview of topics that you will learn in this lesson.

- An item
- A nested item that should flag an error
- Unnested list item
- An item.
- A nested item that should flag an error.
- Unnested list item.

### Custom section

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP004_lessonHeadings/tests/TOP004_test_valid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file should not be flagged with any errors.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Custom section

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP005_blanksAroundMultilineHtmlTags/tests/TOP005_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file should flag with TOP005 errors, and no other linting errors.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Assignment

Expand Down
4 changes: 3 additions & 1 deletion markdownlint/TOP006_fullFencedCodeLanguage/tests/TOP006_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file should flag with TOP006 errors, and no other linting errors.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Assignment

Expand All @@ -22,9 +22,11 @@ Valid div due to each tag being surrounded by blank lines.
console.log("This code block should flag an error as it uses "js" instead of "javascript".");
```

<!-- markdownlint-disable TOP008 -->
~~~js
console.log("The rule will still flag even if tilde delimiters are used");
~~~
<!-- markdownlint-enable TOP008 -->

```javascript
console.log("This code block is valid as it uses the appropriate full name.");
Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP007_useMarkdownLinks/tests/TOP007_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file should flag with TOP007 errors, and no other linting errors.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Assignment

Expand Down
2 changes: 1 addition & 1 deletion markdownlint/TOP008_useBackticksForFencedCodeBlocks/tests/TOP008_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file should flag with TOP008 errors, and no other linting errors.

This section contains a general overview of topics that you will learn in this lesson.

- LO item
- LO item.

### Assignment

Expand Down