[scanner] package.json 'typecheck' script always fails — bare 'tsc' with no tsconfig.json (none ever existed)

Open Beginner friendly
#284 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active

Research direction

Start with package.json:51 and the TypeScript-related devDependencies, then run npm run typecheck on a clean checkout to reproduce the failure. Check .github/workflows/ and CONTRIBUTING.md as noted in the issue. Confirm the maintainer's choice between adding the Docusaurus-based configuration and removing the orphaned script and dependencies; done means the chosen path leaves no misleading typecheck setup.

Written by the indexing model from the issue text.

Description

agent/scanner bug hive/hosted-available-lke648397-260827-5n31

Finding

package.json:51 defines "typecheck": "tsc", and the repo carries both typescript ~5.8.3 and @docusaurus/tsconfig 3.8.1 as devDependencies — but there is no tsconfig.json (or jsconfig.json) in the repo, and git log --all -- tsconfig.json jsconfig.json shows one has never existed.

Running it on a clean checkout (verified at main@00b44df, Node 22, typescript 5.8.3):

$ npm run typecheck
> tsc
Version 5.8.3
tsc: The TypeScript Compiler - Version 5.8.3
... (prints full help text) ...
# exit code 1

Bare tsc with no tsconfig and no file arguments prints help and exits 1, so the script can never succeed.

Impact

Low: typecheck is an orphan — no workflow calls it (grep typecheck .github/workflows/ → nothing), npm run check does not aggregate it (_list:check:* only matches check:* names), and CONTRIBUTING.md never mentions it. But it is a broken, misleading script in package.json, and the presence of @docusaurus/tsconfig strongly suggests a tsconfig was intended (the standard Docusaurus tsconfig extends that package) but never committed.

Recommendation

Either:

  1. Add the missing config — commit a tsconfig.json extending @docusaurus/tsconfig (the Docusaurus-generated default), so npm run typecheck actually type-checks the src/ React components, or
  2. Remove the script — drop typecheck and the typescript/@docusaurus/tsconfig devDependencies if type-checking is not wanted.

A single small PR closes this either way.


Filed by scanner agent (ACMM L4 — issues-only mode)

🐝 Hive Agent: scanner | Instance: hosted-available-lke648397-260827-5n31 | SHA: 00b44df

— hive: agent=scanner backend=copilot model=kimi-k3

Dominant language
JavaScript
Stars
0
Forks
2
Avg merge
2d 22h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cncf/endusers

All issues in cncf/endusers

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.