Skip to content
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

Jump to bottom

Added scripts and configuration to run markdownlint #290

Merged
merged 22 commits into from
Feb 9, 2022
Merged

Added scripts and configuration to run markdownlint #290

merged 22 commits into from
Feb 9, 2022

Conversation

claremacrae
Copy link
Contributor

@claremacrae claremacrae commented Feb 9, 2022 •
edited
Loading

All work done by pairing with @chrisgrieser

This is a step on the way to fixing #31

We have...

  • Set up the markdownlint configuration .markdownlintrc
    • This disables the rules we do not want to run in the context of the hub
    • We have already discussed two subjective rules in the Discord, and have implemented the collective decision
  • Set up the markdownlint ignore file .markdownlintignore
    • Edit: This disables linting on 2 specific files, and all MOCs, that currently more work on them, to get them to pass the linting rules.
  • Created a script to run markdownlint on the hub .github/scripts/run_markdownlint.sh
    • This includes temporary disabling all rules that would currently be reported as violations
  • Made git ignore node_modules/

For detail, see the individual commits.

claremacrae and others added 22 commits January 23, 2022 13:24
@claremacrae @chrisgrieser
Create .markdownlintrc
2ee7ce8 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Add options to prevent unwanted changes
e5527e7 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Delete obsolete rules
08fcb9f 
These do nothing.

Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Disable warnings caused by "This note in GitHub"
d006094 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Capture command to run markdownlint
f30bfef 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Allow white space in inline code
bc236ce 
This prevents ` [ ] ` changing to ` [ ]` in:
04 - Guides, Workflows, & Courses/Guides/An Introduction to Dataview.md

Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Reduce repetition in script
0b1efe3 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Disable some fixes to aid reviewing
f293c1f 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Ignore node_modules/
665aeb6 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Save markdownlint output to file, to track changes
21a60ae 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Don't lint MOC files, due to "Spaces after list markers"
3ba41dd 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Don't lint 'T - GitHub Repository.md' - "Spaces inside emphasis markers"
95e470f 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Get summary of number of rules triggered
ebd63fd 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Wrap long line in script for easier history
45ae3f6 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Disable list-marker-space until the hub is cleaned up
fb9ee70 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Disable fence code block warnings until the hub is cleaned up
82ced10 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Change sorting of summary of lint output
32a45d8 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Ignore 'An Introduction to Dataview.md' for now
2588098 
This generates a number of warnings

Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Disable all remaining markdown lint warnings
5de8b66 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Add explanatory comments
d74d677 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Hub members chose blanks both sides of heading
e26d8f4 
Co-Authored-By: pseudometa <[email protected]>
@claremacrae @chrisgrieser
Enable running of markdownlint on the whole hub
0715378 
Co-Authored-By: pseudometa <[email protected]>
chrisgrieser
chrisgrieser approved these changes Feb 9, 2022
View reviewed changes
Copy link
Member

@chrisgrieser chrisgrieser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reviewed during pairing with @claremacrae

@chrisgrieser chrisgrieser merged commit e76e2b3 into main Feb 9, 2022
@claremacrae claremacrae deleted the linting branch February 10, 2022 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisgrieser chrisgrieser chrisgrieser approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@claremacrae @chrisgrieser