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

Enable flow-type eslint plugin rules #29

Closed
5 tasks done
ballercat opened this issue Dec 15, 2017 · 7 comments
Closed
5 tasks done

Enable flow-type eslint plugin rules #29

ballercat opened this issue Dec 15, 2017 · 7 comments

Comments

@ballercat
Copy link
Owner

ballercat commented Dec 15, 2017

Goal

Make the codebase more consistent with clear standards.

Overview

Original issue (#18)

Flow-types helps to reason about the code and maintain a stable API. Unfortunately, some files don't have flow, and the types don't match best-established practices, like avoiding any and *Type type names.

Acceptance Criteria

These are the sequence for how these changes should be applied. The only additional eslint rules to run on are listed below.

@ForsakenHarmony
Copy link
Contributor

Are all the disabled rules and warnings in the .eslintrc intentional?

@ballercat ballercat changed the title Add flow-type eslint plugin Enable flow-type eslint plugin rules, plus more eslint rules. Dec 16, 2017
@ballercat ballercat changed the title Enable flow-type eslint plugin rules, plus more eslint rules. Enable flow-type eslint plugin rules Dec 16, 2017
@ballercat
Copy link
Owner Author

I didn't have much use for them when it was just me working on the code. I'll have to re-enable most of these as part of the Issue.

@ForsakenHarmony
Copy link
Contributor

then why not just disable eslint?

@ballercat
Copy link
Owner Author

It's important to me that the code remains as easy as possible to maintain, especially as the project grows. I'd like to get more people involved improving the codebase as well, not having a standard style would make that difficult.

The results of me being lazy about enabling the rules are inconsistencies across the codebase now. How can I ask others to maintain quality if I can't follow the rules myself? And If I do get enough people to contribute, one of the worst things that could happen are arguments over code-style, which I'd like to avoid.

@ForsakenHarmony
Copy link
Contributor

No I'm asking why you used eslint before if you disable all those rules

@ballercat
Copy link
Owner Author

Oh, sure.

If you take a look at the currently enabled config, it's already pretty useful; it just doesn't enforce a few style rules I have done out of habit. It helped me catch silly bugs(undefined variables etc.,), and keep stuff like console.logs and debugger statements out of builds.

@ballercat
Copy link
Owner Author

Going to punt on the type naming rule. Maybe will be done at a later point.

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

2 participants