[FEATURE]: Add missing lint and format scripts to package.json
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 62/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- eslint, javascript
- Domain
- documentation, tooling
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.
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:
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
- Install ESLint and Prettier as development dependencies:
npm install -D eslint prettier eslint-config-prettier eslint-plugin-react
- Add the following scripts to
package.json:
{
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"lint": "eslint src/",
"format": "prettier --write src/"
}
}
- Update the ESLint configuration to:
- Extend recommended React rules.
- Disable formatting conflicts with Prettier.
- Update
CONTRIBUTING.mdso that the checklist correctly references the new scripts.
Describe alternatives you've considered
-
Removing the
npm run lintreference fromCONTRIBUTING.mdThis 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
Code of Conduct
- I have joined the Discord server and will post updates there
- I have searched existing issues to avoid duplicates
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 98
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AOSSIE-Org/OrgExplorer
-
[BUG]: "Clear All" in Settings doesn't clear the saved analysis, old data comes back after reload Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
AOSSIE-Org/OrgExplorer#253 · 3 comments · 1 assignee ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
AOSSIE-Org/OrgExplorer#251 · 2 comments · 1 assignee ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
AOSSIE-Org/OrgExplorer#245 · 1 assignee ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
AOSSIE-Org/OrgExplorer#230 · 2 comments ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
AOSSIE-Org/OrgExplorer#228 · 2 comments ·
All issues in AOSSIE-Org/OrgExplorer
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100
-
Issue-Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sugarlabs/musicblocks#8924 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Opencustomer-eng status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100