Giters

loeffel-io / ls-lint

An extremely fast directory and filename linter - Bring some structure to your project filesystem

Home Page:https://ls-lint.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature proposal: Plain English rules

Lyberta opened this issue · comments

commented

I'm looking to deploy ls-lint for a project designed for non-programmers who mostly use only touchscreen and mouse. And I want it to look as user-friendly as possible. So there are a few naming conventions employed.

  • "Plain English With All Words Capitalized" - so every word starts with a capital letter and they are separated by spaces. The Philosophy Of Albert Camus.txt
  • "Plain English with only proper nouns capitalized" - so yeah, words are separated by spaces, first word is capitalized while subsequent words are not and then proper nouns are capitalized too where appropriate. The philosophy of Albert Camus.txt
  • "Plain English with most words capitalized" - like with naming things, parts of speech like "not, or, and, of, at, etc" are not capitalized while the rest are. The Philosophy of Albert Camus.txt

In all cases acronyms are capitalized too. Sure, once #120 is implemented, I can just hack my own regexes I guess but I'm sure other non-programmers will appreciate plain English rules available by default.