AOSSIE-Org / AOSSIE-Org/OrgExplorer

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

Open
#82 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
34
Forks
92
Avg merge
8d 7h
Merged PRs (30d)
12

Description

### 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:

```bash
npm run lint
```

currently results in:

```text
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:

```bash
npm install -D eslint prettier eslint-config-prettier eslint-plugin-react
```

2. Add the following scripts to `package.json`:

```json
{
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"lint": "eslint src/",
"format": "prettier --write src/"
}
}
```

3. Update the ESLint configuration to:

* Extend recommended React rules.
* Disable formatting conflicts with Prettier.

4. 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

- [x] I have joined the [Discord server](https://discord.gg/hjUhu33uAn) and will post updates there
- [x] I have searched existing issues to avoid duplicates

Contributor guide

Open the contributing guide

Research direction

Start by inspecting package.json, the existing eslint.config.js, and CONTRIBUTING.md; then run the current npm scripts to confirm the missing commands. Add the requested development tooling and scripts, align the contributor checklist, and verify that npm run lint and npm run format execute successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.