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.

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

Add rule to check for file naming #41

Closed
pascalberger opened this issue Jan 11, 2017 · 5 comments
Closed

Add rule to check for file naming #41

pascalberger opened this issue Jan 11, 2017 · 5 comments
Labels

Comments

@pascalberger
Copy link
Contributor

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 - .
@DavidAnson
Copy link
Owner

DavidAnson commented 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.

@pascalberger
Copy link
Contributor Author

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 :)

@DavidAnson
Copy link
Owner

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

@pascalberger
Copy link
Contributor Author

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

@DavidAnson
Copy link
Owner

Great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants