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

Opt-in ESLint config #67

Open
tukib opened this issue Dec 6, 2023 · 1 comment
Open

Opt-in ESLint config #67

tukib opened this issue Dec 6, 2023 · 1 comment

Comments

@tukib
Copy link
Member

tukib commented Dec 6, 2023

Problem

Writing and reviewing correct code can be more efficient with the use of ESLint. However, this could slow down contributors who are unfamiliar with ESLint rules, and we have not yet identified a good reason to require it.

Context

Configure an opt-in ESLint config for our project. This will follow from:

we will check in .eslintrc rules for the whole thing. and then we will control which files are required to conform to it (opt in) in the eslintignore file.

old proposal

We could check in a template config (e.g. template.eslint.rc) and add the real config to gitignore (e.g. .eslintrc). We will not add ESLint to the package.json lint script.~~

  • Then by default, neither code editors nor the lint PR check will use this.
  • To opt-in, a contributor can copy the template.
@tukib tukib added the needs triage This is a new issue that needs to be reviewed. label Dec 6, 2023
@seanmakesgames
Copy link
Member

we will check in .eslintrc rules for the whole thing. and then we will control which files are required to conform to it (opt in) in the eslintignore file.

@seanmakesgames seanmakesgames removed the needs triage This is a new issue that needs to be reviewed. label Dec 7, 2023
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