Skip to content

Add vendor/ to .markdownlintignore#39724

Merged
gziolo merged 3 commits intoWordPress:trunkfrom
tomalec:patch-2
Mar 25, 2022
Merged

Add vendor/ to .markdownlintignore#39724
gziolo merged 3 commits intoWordPress:trunkfrom
tomalec:patch-2

Conversation

@tomalec
Copy link
Copy Markdown
Contributor

@tomalec tomalec commented Mar 24, 2022

What?

Add vendor/ to .markdownlintignore
for wp-scripts, to match the documented behavior
https://developer.wordpress.org/block-editor/reference-guides/packages/packages-scripts/#lint-md-docs

Why?

Documentation states:

By default, files located in build, node_modules, and vendor folders are ignored.

How?

Testing Instructions

  1. Open a project that has some lint errors in /vendor folder, like https://github.com/woocommerce/google-listings-and-ads/
  2. Run wp-scripts lint-md-docs

Before

> wp-scripts lint-md-docs

…
vendor/automattic/jetpack-a8c-mc-stats/README.md:35 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```php"]
vendor/automattic/jetpack-assets/README.md:7 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]

Screenshots or screencast

@tomalec tomalec mentioned this pull request Mar 24, 2022
Merged
@gziolo gziolo added [Tool] WP Scripts /packages/scripts [Type] Bug An existing feature does not function as intended labels Mar 24, 2022
gziolo
gziolo approved these changes Mar 24, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Code changes look good. Good catch 👍

Any idea why CI checks didn’t trigger?

Would you mind including an entry in the CHANGELOG file similar to:

https://github.com/WordPress/gutenberg/blob/trunk/packages/scripts/CHANGELOG.md#bug-fix

@tomalec
Copy link
Copy Markdown
Contributor Author

tomalec commented Mar 25, 2022

Any idea why CI checks didn’t trigger?

😕 maybe because I created this PR via GitHub UI?

Would you mind including an entry in the CHANGELOG file similar to:

Done 80ea265

@gziolo gziolo merged commit 2943570 into WordPress:trunk Mar 25, 2022
@github-actions github-actions bot added this to the Gutenberg 13.0 milestone Mar 25, 2022
@gziolo
Copy link
Copy Markdown
Member

gziolo commented Mar 25, 2022

Thank you for the changelog change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gziolo gziolo gziolo approved these changes

@ntwb ntwb Awaiting requested review from ntwb ntwb is a code owner

@nerrad nerrad Awaiting requested review from nerrad nerrad is a code owner

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@ryanwelcher ryanwelcher Awaiting requested review from ryanwelcher ryanwelcher is a code owner

Assignees

No one assigned

Labels

[Tool] WP Scripts /packages/scripts [Type] Bug An existing feature does not function as intended

Projects

None yet

Milestone

Gutenberg 13.0

Development

Successfully merging this pull request may close these issues.

2 participants

@tomalec @gziolo