Kvalifik / how-we-work

A handbook for software development at Kvalifik
0 stars 0 forks source link

Eslint rule for file naming #162

Closed forecast[bot] closed 2 years ago

forecast[bot] commented 2 years ago

Problem: There is a discrepancy in our file naming on backends in regards to using camelCase or kebab-case.

Product: We want to implement an Eslint rule that checks whether the file names are all kebab-case, and add it to our backend template

Reasoning: kebab-case is the go-to standard for Node.js development and eslint automates enforcement of the standard, such that no onboarding is needed

Additional details: There seems to be a rule online for this: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md

Also, please note that React component files are to be named in PascalCase as per React standards.

forecast[bot] commented 2 years ago

Should be catched in PR reviews