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

ADD Eslint rules for the app #436

Open
punithnayak opened this issue Jul 29, 2023 · 3 comments
Open

ADD Eslint rules for the app #436

punithnayak opened this issue Jul 29, 2023 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@punithnayak
Copy link

What would you like to be added:
To maintain standardized coding styles let us add eslint configuration

Why is this needed:
To maintain uniformity in the code
https://docusaurus.io/docs/api/misc/@docusaurus/eslint-plugin

@punithnayak punithnayak added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 29, 2023
@RainbowMango
Copy link
Member

Looks good to me after taking a glance at the ESLint.
But I still don't know what specific issues the ESLint can detect. Do we need a demo?

@rakshitgondwal
Copy link
Contributor

I can't seem to figure out how ESLint would exactly work as a plugin🤔 Would it show us the errors inside the IDE or how?
Also, I can't seem to think about any use cases of the only 2 rules supported by ESLint. Can you put some light in here please? @punithnayak

Instead what I suggest is to use a linter that would run as a GitHub Action workflow. I think https://github.com/gaurav-nelson/github-action-markdown-link-check would be a good option if we are to go for this idea. WDYT? @RainbowMango

But obviously, if there are some particular use cases for ESLint that needs to have a check for, we can integrate these both too.

@shivansh-bhatnagar18
Copy link

@rakshitgondwal @RainbowMango Integrating ESLint in our code will help us keep track of the incoming Pull Requests in the future and maintain good coding practices if we add it as a GitHub workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

4 participants