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

Remove GitHub Super-Linter #341

Merged
merged 1 commit into from
Apr 4, 2022
Merged

Conversation

kylelaker
Copy link
Contributor

@kylelaker kylelaker commented Apr 1, 2022

We've run into issues in the past with the super linter. It evaluates
file one-by-one rather how developers run tests. When run against the
entire codebase it's extremely slow; this causes issues because it means
that configuration changes that may break linting aren't caught (since
rarely do code files get modified at the same time as linting
configuration files). We've had issues with breaking changes in tools
used for linting (such as migrating from jsonlint to eslint).

We lint JSON and JavaScript with npm run lint. The only thing we
meaningfully lint outside that is Markdown and YAML. Both of these are
pretty easy to just use the actual tools that Super-Linter is running
anyway.

We might be able to integrate markdownlint into our npm lint workflow
but we can't for yamllint (since it's a Python package) so there's not
much value in that as far as I can see.

@kylelaker kylelaker force-pushed the feature/update-eslint-config branch 2 times, most recently from 9e74da8 to dd5b82d Compare April 1, 2022 23:02
@kylelaker kylelaker changed the title Resolve linting errors due to config issues Remove GitHub Super-Linter Apr 1, 2022
@kylelaker kylelaker force-pushed the feature/update-eslint-config branch from dd5b82d to 6aab4de Compare April 1, 2022 23:09
We've run into issues in the past with the super linter. It evaluates
file one-by-one rather how developers run tests. When run against the
entire codebase it's extremely slow; this causes issues because it means
that configuration changes that may break linting aren't caught (since
rarely do code files get modified at the same time as linting
configuration files). We've had issues with breaking changes in tools
used for linting (such as migrating from jsonlint to eslint).

We lint JSON and JavaScript with `npm run lint`. The only thing we
meaningfully lint outside that is Markdown and YAML. Both of these are
pretty easy to just use the actual tools that Super-Linter is running
anyway.

We might be able to integrate markdownlint into our `npm lint` workflow
but we can't for yamllint (since it's a Python package) so there's not
much value in that as far as I can see.
@kylelaker kylelaker force-pushed the feature/update-eslint-config branch from 6aab4de to 0b81254 Compare April 1, 2022 23:17
@kylelaker kylelaker marked this pull request as ready for review April 1, 2022 23:21
@hreineck hreineck merged commit 6adabc0 into develop Apr 4, 2022
@rgauss rgauss deleted the feature/update-eslint-config branch April 5, 2022 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants