[GH-ISSUE #41] Add rule to check for file naming #33

Closed
opened 2026-03-03 01:23:10 +03:00 by kerem · 5 comments
Owner

Originally created by @pascalberger on GitHub (Jan 11, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/41

Adding a rule to check for file naming would be a nice enhancement.

Guidelines which for example we currently are using:

  • Filename needs to be lowercase
  • Allowed characters: a-z 0-9 - .
Originally created by @pascalberger on GitHub (Jan 11, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/41 Adding a rule to check for file naming would be a nice enhancement. Guidelines which for example we currently are using: * Filename needs to be lowercase * Allowed characters: `a-z 0-9 - .`
kerem 2026-03-03 01:23:10 +03:00
  • closed this issue
  • added the
    new rule
    label
Author
Owner

@DavidAnson commented on GitHub (Jan 11, 2017):

To be clear, you are referring to the names of the Markdown files that are parsed for content, right? If so, this feels a bit on the edge of what I think a Markdown linter should do. But I will think about this more.

<!-- gh-comment-id:271930628 --> @DavidAnson commented on GitHub (Jan 11, 2017): To be clear, you are referring to the names of the Markdown files that are parsed for content, right? If so, this feels a bit on the edge of what I think a Markdown linter should do. But I will think about this more.
Author
Owner

@pascalberger commented on GitHub (Jan 12, 2017):

Yes, I was referring to the *.md files. I see the point that this is not a typical use case for a linter, since it is no longer about the content. On the other hand, considering a repo containing some source and Markdown documentation, it still has to do with the Markdown part :)

<!-- gh-comment-id:272108013 --> @pascalberger commented on GitHub (Jan 12, 2017): Yes, I was referring to the `*.md` files. I see the point that this is not a typical use case for a linter, since it is no longer about the content. On the other hand, considering a repo containing some source and Markdown documentation, it still has to do with the Markdown part :)
Author
Owner

@DavidAnson commented on GitHub (Jan 12, 2017):

Got it.

What about something like this instead: https://www.npmjs.com/package/gulp-check-file-naming-convention

Or maybe:
https://www.npmjs.com/package/check-filename

<!-- gh-comment-id:272230239 --> @DavidAnson commented on GitHub (Jan 12, 2017): Got it. What about something like this instead: https://www.npmjs.com/package/gulp-check-file-naming-convention Or maybe: https://www.npmjs.com/package/check-filename
Author
Owner

@pascalberger commented on GitHub (Jan 18, 2017):

Thinking a little bit more about it, doing these checks outside might be the better solution than duplicating existing functionality here.

<!-- gh-comment-id:273463198 --> @pascalberger commented on GitHub (Jan 18, 2017): Thinking a little bit more about it, doing these checks outside might be the better solution than duplicating existing functionality here.
Author
Owner

@DavidAnson commented on GitHub (Jan 19, 2017):

Great.

<!-- gh-comment-id:273692988 --> @DavidAnson commented on GitHub (Jan 19, 2017): Great.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#33
No description provided.