AOSSIE-Org / AOSSIE-Org/OrgExplorer

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

未關閉
#82 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement
主要語言
JavaScript
星號
34
分支
92
平均合併
8 天 7 小時
30 天內合併 PR
12

描述

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

貢獻指南

開啟貢獻指南

研究方向

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.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
eslint, javascript
領域
documentation, tooling
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
62/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。