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

we have no linting configuration (ESLint proposal) #58

Closed
Tracked by #59
tukib opened this issue Dec 5, 2023 · 1 comment
Closed
Tracked by #59

we have no linting configuration (ESLint proposal) #58

tukib opened this issue Dec 5, 2023 · 1 comment
Labels
needs triage This is a new issue that needs to be reviewed.

Comments

@tukib
Copy link
Member

tukib commented Dec 5, 2023

Problem

We have no linting configuration for our code editors and github workflows to use. This means that bad patterns may be uncaught even after code review.

Context

Configuring ESLint would solve the lack of linting configuration, and mitigate bad patterns in our code.

  • Add ESLint as a dev dependency and any necessary eslint plugins (e.g. @docusaurus/eslint-plugin)
  • Use the recommended configuration for @docusaurus/eslint-plugin
  • Modify the lint script in package.json to use ESLint as well - may be redundant, check if building docusaurus runs ESLint.

Fine tuning the specific ESLint rules will be done in a separate issue, as they will need further discussion and are beyond the scope of an initial configuration.

@tukib tukib added the needs triage This is a new issue that needs to be reviewed. label Dec 5, 2023
@tukib
Copy link
Member Author

tukib commented Dec 6, 2023

We have yet to encounter a strong need for this, so we'll pick this up later if the need arises.

@tukib tukib closed this as not planned Won't fix, can't repro, duplicate, stale Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage This is a new issue that needs to be reviewed.
Projects
None yet
Development

No branches or pull requests

1 participant