Fix all remark warnings #3261
Merged
Fix all remark warnings #3261
Conversation
This file contains 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
added 5 commits
May 31, 2021 20:31
This enables the transitive dependencies to be pinned, just like for all other packages.
These are needed to correctly parse certain constructs in Markdown files (such as tables and YAML frontmatter), and without them, remark produces invalid warnings on some files.
The previous versions reference the old version of the `remark-lint-table-cell-padding` plugin, which doesn't work correctly with the current version of `remark-parse` (and thus produces spurious warnings).
This way, if a PR updates the remark configuration and that causes new errors to appear, those errors will show up in that PR, instead of the (unrelated) PR that next updates the affected files. There is no runtime cost to this, because remark takes approximately 1 second to check all files.
nmanovic
approved these changes
May 31, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation and context
Currently, the remark workflow only runs remark on changed files, which means that it's possible for files that have already existed in the repository by the time the workflow was added to contain remark warnings. And by "possible" I mean that these warnings do exist, and there is a lot of them.
This PR fixes all of these warnings, and changes the workflow so that remark is run on all files, making it impossible for this situation to reoccur. It also ensures that remark dependencies are installed deterministically, and updates the remark configuration to avoid false positives. See the commit messages for details.
How has this been tested?
N/A - no code changes (except for the workflow)
Checklist
developbranch[ ] I have added description of my changes into CHANGELOG filethere aren't any user-visible changes[ ] I have added tests to cover my changesno changes in the code[ ] I have linked related issues (read github docs)[ ] I have increased versions of npm packages if it is necessary (cvat-canvas,cvat-core, cvat-data and cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
[ ] I have updated the license header for each file (see an example below)no headers in Markdown files