Markdownlint: Use test runner for custom rule tests #30592
+2,808
−194
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--format CLI option released in v0.19.0 and required in custom rule tests
mao-sz
added
Type: Chore
github-actions
bot
removed
the
Type: Chore
mao-sz
added
the
Type: Chore
Contributor
Author
|
I opted to have the custom rule test workflow just run all tests on any custom rule/test file change, rather than try to mess with changed file paths and selectively running tests. That seemed like a hell of a lot of work for little gain, and I'd have to deal with ensuring changes to For some reason the test workflow uses the TAP test reporter despite it just running |
Normal markdownlint workflow now should only apply to lessons/projects
Not all parts of TOP003 are fixable
Original fix tests only assert that running the fix script matches the respective `fixed_*` md file, but do not actually test that the applied fixes are sensible and fully resolve the relevant errors.
Nested/ordered list test md files need splitting because of this (nested can't be fixed but ordered can).
Missing headings not fixable but incorrect heading levels are, so the test md files should be split.
mao-sz
force-pushed
the
markdownlint-testing
branch
from
8b9cc87 to
94fc986
Compare
ManonLef
requested review from
a team and
JustWaveThings
and removed request for
a team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
The current way of testing markdownlint custom rules is functional but not the most ideal. Ideal would be automated tests with a runner and against assertions, but until now has been a low priority thing due to potential complexities in testing CLI stuff with third-party libraries.
This is one beefy PR but should be more approachable by reviewing the individual commits, and all tests hopefully passing.
Please do checkout into the PR locally and run
npm run testjust in case I've made errors with the GH workflow.This PR
markdownlint/from standard markdownlint GH workflow (intended for lessons/projects)markdownlint-cli2minimum version to0.20.0due to needing the--formatCLI option for tests (released in0.19.0)Issue
Closes #30590
Additional information
I can start work on #30575 after this is merged, since the contribution/review protocol will have changed.
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection