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

List all provided TypeScript ESLint rules #1277

Open
samreid opened this issue Jul 11, 2022 · 7 comments
Open

List all provided TypeScript ESLint rules #1277

samreid opened this issue Jul 11, 2022 · 7 comments

Comments

@samreid
Copy link
Member

samreid commented Jul 11, 2022

After #1276, we should follow that same convention for listing all of the existing TypeScript ESLint rules. We can add comments about why our team has enabled or disabled a rule.

I have converted to this form on my working copy but have more adjustments before I'll be ready to commit. Probably some time Monday.

Heads up to @jessegreenberg who did the initial work on setting up TypeScript ESLint rules.

@samreid samreid self-assigned this Jul 11, 2022
@samreid samreid changed the title Write out all support TypeScript ESLint rules List all provided TypeScript ESLint rules Jul 11, 2022
samreid added a commit to phetsims/phet-core that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/number-play that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/gravity-and-orbits that referenced this issue Jul 11, 2022
samreid added a commit that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/models-of-the-hydrogen-atom that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/mean-share-and-balance that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/quadrilateral that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/my-solar-system that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/geometric-optics that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/ratio-and-proportion that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/counting-common that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/greenhouse-effect that referenced this issue Jul 11, 2022
samreid added a commit to phetsims/circuit-construction-kit-common that referenced this issue Jul 11, 2022
@samreid
Copy link
Member Author

samreid commented Aug 8, 2022

I added a rule that seemed to match with our conventions, @typescript-eslint/explicit-module-boundary-types but couldn't figure it out for mixins so it is disabled on those lines.

samreid added a commit to phetsims/tandem that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/center-and-variability that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/utterance-queue that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/joist that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/number-play that referenced this issue Aug 8, 2022
samreid added a commit that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/gravity-and-orbits that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/scenery that referenced this issue Aug 8, 2022
samreid added a commit to phetsims/axon that referenced this issue Aug 9, 2022
samreid added a commit to phetsims/quadrilateral that referenced this issue Aug 9, 2022
samreid added a commit to phetsims/joist that referenced this issue Aug 9, 2022
samreid added a commit to phetsims/tandem that referenced this issue Aug 9, 2022
samreid added a commit that referenced this issue Aug 9, 2022
samreid added a commit that referenced this issue Aug 9, 2022
marlitas added a commit to phetsims/circuit-construction-kit-common that referenced this issue Aug 12, 2022
marlitas added a commit to phetsims/phet-core that referenced this issue Aug 12, 2022
@samreid
Copy link
Member Author

samreid commented Aug 27, 2022

There are about 30 remaining rules that are marked as TODO about enabling the rule or investigating it more. About a dozen of those rules have autofix. I've been chipping away at this but am ready to bring back to dev meeting for check-in and to see how we want to divide the remaining work.

@samreid samreid removed their assignment Aug 27, 2022
@samreid samreid self-assigned this Sep 28, 2022
samreid added a commit that referenced this issue Sep 29, 2022
@samreid samreid removed their assignment Oct 14, 2022
@jessegreenberg
Copy link
Contributor

While working on #1368 I noticed that explicit-module-boundary-types was enabled for this issue. It has a lot of overlap with our custom explicit-method-return-types, I am wondering if we can delete explicit-method-return-types now.

@marlitas
Copy link
Contributor

This issue has no assignments and @jessegreenberg's question seems worthy to bring return to to be discussed so that his question can be answered, and this issue reassigned.

@jessegreenberg
Copy link
Contributor

Regarding #1277 (comment), explicit-module-boundary-types does not require return types for private functions. So I prefer our custom explicit-method-return-types and think we should keep it. Our rule also has an auto fix which is nice to keep around.

Ill remove from agenda since that is why it was added.

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

No branches or pull requests

4 participants