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

Update README.md #293

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #293

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ab8773
Update README.md
iamtodor Jun 5, 2022
76bf965
Update README.md
iamtodor Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Quoting the glob like `--ignore '*.md'` passes it through unexpanded and ignores

#### Globbing examples

To lint all Markdown files in a Node.js project (excluding dependencies), the following commands might be used:
To lint all Markdown files recursively in a Node.js project (excluding dependencies), `*/**.md` wildcard comes in handy. The following commands might be used:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think */**.md is what's intended? And **/*.md is already shown on the next two lines.

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson my intention was to add mention the explanation of this wildcard that is used in the code

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think lines 62 and 64 already show the preferred syntax?

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson yeah, I agree it shows the syntax.
So I didn't change the syntax, but rather add a precise clarification as a word explanation about the syntax, right?

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson what do you think of these changes? Is there anything that concerns you that we can discuss?

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson If you still think this PR has no sense, and it's not discussable please let me know - I will close it :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Please read the comment you link to again, it does not say what you think it says.

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson You're missing the first part of the folder wildcard if you want it have a recursive glob "**/*.md" ? taken from #292 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

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

The existing examples and Nick's comment use the syntax **/*.md which is the conventional way to match all files with a particular extension. Your proposed change uses the syntax */**.md which means something different.

Copy link
Author

Choose a reason for hiding this comment

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

@DavidAnson ah, sorry, it was a typo. I didn't notice it. I thought to add */**.md, but mistakenly I added **/*.md. Thank you for your look, I updated the PR accordingly

Please, let me know if it works for you :)


Windows CMD: `markdownlint **/*.md --ignore node_modules`

Expand Down