Skip to content

chore(linting): add naming convention rule #1170

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

Merged
merged 5 commits into from
Jul 20, 2022

Conversation

xDivisionByZerox
Copy link
Member

Add a basic linting rule to apply naming conventions.
For now, I only added the rule that classes, interfaces, type declarations, and enum members have to be written in PascalCase.

I'm open to more strict definitions in this PR.

@xDivisionByZerox xDivisionByZerox added c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent labels Jul 19, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Jul 19, 2022
@xDivisionByZerox xDivisionByZerox requested a review from a team July 19, 2022 16:05
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner July 19, 2022 16:05
@xDivisionByZerox xDivisionByZerox self-assigned this Jul 19, 2022
@codecov
Copy link

codecov bot commented Jul 19, 2022

Codecov Report

Merging #1170 (e682212) into main (b9284dc) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1170      +/-   ##
==========================================
- Coverage   99.65%   99.64%   -0.01%     
==========================================
  Files        2146     2146              
  Lines      230462   230467       +5     
  Branches      983      980       -3     
==========================================
- Hits       229671   229657      -14     
- Misses        770      789      +19     
  Partials       21       21              
Impacted Files Coverage Δ
src/modules/date/index.ts 99.05% <100.00%> (+<0.01%) ⬆️
src/modules/name/index.ts 100.00% <100.00%> (ø)
src/modules/internet/user-agent.ts 87.24% <0.00%> (-5.51%) ⬇️

pkuczynski
pkuczynski previously approved these changes Jul 19, 2022
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

I'm ok with that for now
But is there maybe a no-config default-preset?

@xDivisionByZerox
Copy link
Member Author

I'm ok with that for now
But is there maybe a no-config default-preset?

Not that I'm aware of. All configs we extend from do not set this rule.

TBH, I'm a big fan of explicitly settings configs and not relying on defaults. That way you ensure your config always stays the same even if the preset you extend from decides to change their settings. But that's my opinion.

@pkuczynski
Copy link
Member

TBH, I'm a big fan of explicitly settings configs and not relying on defaults. That way you ensure your config always stays the same even if the preset you extend from decides to change their settings. But that's my opinion.

I second that.

@Shinigami92 Shinigami92 enabled auto-merge (squash) July 20, 2022 09:00
@Shinigami92 Shinigami92 merged commit b0a4847 into main Jul 20, 2022
@ST-DDT ST-DDT deleted the chore/linting/add-naming-convention-rule branch July 20, 2022 09:09
hankucz added a commit to hankucz/faker that referenced this pull request Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants