Skip to content

[FEATURE]: Add missing lint and format scripts to package.json #82

Description

@amankv1234

Feature and its Use Cases

Is your feature request related to a problem? Please describe.

The CONTRIBUTING.md checklist instructs contributors to run npm run lint before opening a pull request, but the current package.json does not define either a lint or format script.

Running:

npm run lint

currently results in:

npm ERR! Missing script: "lint"

This mismatch creates confusion for new contributors and makes it difficult to maintain consistent code quality across the project.


Describe the solution you'd like

Add standard linting and formatting scripts to package.json so contributors can easily run the same checks locally.

Proposed changes

  1. Install ESLint and Prettier as development dependencies:
npm install -D eslint prettier eslint-config-prettier eslint-plugin-react
  1. Add the following scripts to package.json:
{
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview",
    "lint": "eslint src/",
    "format": "prettier --write src/"
  }
}
  1. Update the ESLint configuration to:
  • Extend recommended React rules.
  • Disable formatting conflicts with Prettier.
  1. Update CONTRIBUTING.md so that the checklist correctly references the new scripts.

Describe alternatives you've considered

  • Removing the npm run lint reference from CONTRIBUTING.md

    This would eliminate the confusion, but it would also reduce code quality standards rather than improve them.

  • Using only Prettier without ESLint

    While Prettier handles formatting, ESLint helps detect potential issues such as unused variables, missing imports, and other code-quality problems that Prettier cannot catch.


Additional context

The repository already contains an eslint.config.js file, which suggests that ESLint support has been partially set up. It only lacks the corresponding npm scripts and any missing development dependencies.

Once these changes are added, the CONTRIBUTING.md checklist (npm run lint passes) will work as intended and provide a smoother onboarding experience for contributors.

Additional Context

Image

Code of Conduct

  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions