Project wide editorconfig lint

[aslafy-z]

• I've checked that this isn't a new swag opportunity proposal.
• I've checked that this isn't a duplicate pull request.

Use https://github.com/jedmao/eclint to check and fix lint respecting rules from .editorconfig file.

Added to the lint-staged pipeline.

LICENSE is set to be ignored as it does not respect any rules, we can also add a specific rule for it instead of ignoring it.

[swapagarwal]

Why moving away from XO?

[aslafy-z]

We are not! xo is a js only linter.
We use eclint to lint all other files (pug, styl, html, json, ...)

[swapagarwal]

Oops. My bad! 😅

[vikaspotluri123]

I think this is good to merge, I haven't run any tests locally since it should all be visual. My comment is for general discussion, not blocking 😊

[vikaspotluri123]

General question: is this absolutely required? I know there are lots of repos that do this, but (for me personally) it wastes a lot of time because I have to wait for lint to run until I can commit + push to remotes and it makes me not want to commit because there's too much friction

[plibither8]

I agree. I would prefer a pre-push hook rather than pre-commit

[vikaspotluri123]

With CI, failing lint prevents merge

[plibither8]

But CI is after pushing changes, right? And CI evaluates the last commit.

[aslafy-z]

Something like this: https://github.com/theenadayalank/lint-prepush?
I'll have to drop the --fix option if we go that way as it does not support creating a lint-fix commit. Push will fail if lint is not OK.

The lint-staged task runs really fast on my computer, is it slow for you? I think keeping the lint-fixes within the commit is better but if you guys want to ditch it, we can.

[plibither8]

Why can't we just do this:

"pre-push": "npm run lint:fix"

[aslafy-z]

If the task returns without errors (even if it linted some files, unstaged so), it will continue to push without creating a fix commit.

[plibither8]

Oh, okay, I understand.

I'll have to drop the --fix option if we go that way as it does not support creating a lint-fix commit. Push will fail if lint is not OK.

I'm fine with this. But if we decide to continue with the pre-commit hook, I'm fine with that too 😄

[vikaspotluri123]

The lint-staged task runs really fast on my computer, is it slow for you?

Yep, adds 3-5 seconds, even though I have an ssd 😭

[itaisteinherz]

I usually see projects checking for linting errors only on CI. If you decide on going in this route, I think it's preferable to have linting done automatically on push instead of on every commit, since the latter makes the entire iteration process slower and more annoying.
Regarding creating a lint-fix commit automatically on push / commit, that doesn't seem like a good idea to me, since many times I've had auto-fixable linting errors which I needed to fix manually as that was more appropriate.

These are just my opinions and observations from working on other projects though.

[aslafy-z]

Can I merge this?

[vikaspotluri123]

👍