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

ci(linting): improve results readability and add markdownlint #6355

Merged
merged 7 commits into from
Jan 28, 2023
Merged

ci(linting): improve results readability and add markdownlint #6355

merged 7 commits into from
Jan 28, 2023

Conversation

benelan
Copy link
Member

@benelan benelan commented Jan 26, 2023 •
edited
Loading

Summary

  • Redirects stdout to /dev/null in the npm run lint:* scripts. When linting it would previously print a line for every file being linted, which buried errors/warnings when they popped up in stderr. Now we can actually see the warnings/errors.
  • Adds markdownlint for our documentation. We were having some weirdness with the changelog formatting which this will resolve, among other things.
  • Skipped the following markdownlint rules, which we don't seem to care about based on all of the errors in our code lol
    • MD013 - Line length (everywhere)
    • MD024 - Multiple headers with the same content (e.g in our changelog)
    • MD033 - Inline HTML
    • MD041 - First line in file should be a top level header (e.g in our main readme)

@benelan
ci: add markdownlint
d0e4692
@benelan
ci: add markdownlint to improve our doc
e46ddbf
@benelan
ci: fix linting issues improve npm scripts
8b62d7c
@benelan
ci: fix blob matching syntax
9e276fa
@benelan
Merge remote-tracking branch 'origin/master' into benelan/markdown-li…
5b4b6dd 
…nter

* origin/master:
  1.0.3
  docs: update component READMEs (#6337)
  docs: update license year (#6339)
  fix(pagination): bumping scale of chevron icon to M when host is scale L (#6338)
  ci: prepare release scripts for v1 (#6336)
  ci: add npm script to remove js files compiled by tsc (#6333)
  1.0.0-next.736
  fix(select): bumping scale of chevron icon to M when host is scale l (#6335)
  1.0.0-next.735
@benelan
ci(lintstaged): add markdown linting
b1d02c2
@benelan benelan requested a review from a team as a code owner January 26, 2023 03:17
@github-actions github-actions bot added the chore Issues with changes that don't modify src or test files. label Jan 26, 2023
jcfranco
jcfranco approved these changes Jan 27, 2023
View reviewed changes
Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

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

Sweet improvement! ✨💻🧹✨

@benelan benelan added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label Jan 27, 2023
@benelan benelan merged commit f773e0e into master Jan 28, 2023
@benelan benelan deleted the benelan/markdown-linter branch January 28, 2023 02:05
@benelan benelan mentioned this pull request Feb 1, 2023
Merged
benelan added a commit that referenced this pull request Feb 2, 2023
@benelan
ci(release): lint readme and changelog before committing (#6406)
771a988 
**Related Issue:** #6355

## Summary
I added markdown lint in the PR above but it isn't running during
releases because we have `standard-version` set to `noVerify`. So this
is manually linting the readme/changelog before committing.
@jcfranco jcfranco mentioned this pull request Aug 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jcfranco jcfranco jcfranco approved these changes

Assignees

@benelan benelan

Labels
chore Issues with changes that don't modify src or test files. pr ready for visual snapshots Adding this label will run visual snapshot testing.
Projects
None yet
Milestone
2023 February Priorities - 1.1.0 - No...
Development

Successfully merging this pull request may close these issues.
2 participants
@benelan @jcfranco