Skip to content

💡[Feature]: Add ESLint and Prettier for consistent code quality #787

@sheikhlimon

Description

@sheikhlimon

Is there an existing issue for this?

  • I have searched the existing issues

Feature Description

Our Docusaurus + TypeScript project currently does not enforce consistent code style or catch certain runtime errors early. This can lead to:

  • Inconsistent code style across contributors
  • Uncaught syntax or type issues in config or components
  • Potential accessibility issues in JSX
  • Harder code reviews for PRs

Use Case

  • Add ESLint with the following setup:
    • @typescript-eslint/parser and plugin for TypeScript rules
    • eslint-plugin-react and eslint-plugin-react-hooks for React best practices
    • eslint-plugin-jsx-a11y for accessibility checks
    • Prettier integration for consistent formatting

Benefits

  • Catch code errors before runtime
  • Ensure consistent code style across contributors
  • Improve accessibility and best practices
  • Easier code reviews and CI integration

Add ScreenShots

No response

Priority

Low

Record

  • I have read the Contributing Guidelines
  • Are you a GSSOC'25 contributor
  • I want to work on this issue

Metadata

Metadata

Assignees

Type

Projects

Status

In Progress

Relationships

None yet

Development

No branches or pull requests

Issue actions