chore(package): package.json has no engines, description or repository field, so the required Node version is not stated

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, nodejs

Research direction

Open package.json at the repo root and confirm which of description, repository and engines are missing. Read the CI workflow (the Node version the Worker build and test script run on) so engines.node matches it rather than guessing. Add the three fields, then add a small test or CI check that parses package.json and asserts engines.node is set and description/repository.url are non-empty; done when that check and the existing test script both pass.

Written by the indexing model from the issue text.

Description

agents area: runtime automation chore cli consistency dependencies developer-experience difficulty: easy documentation enhancement good first issue help wanted hygiene json-output priority: P3 starters tests

Problem

The package.json of flisk-sh/analytics has no description, repository or engines field. A contributor cloning the repo gets no hint which Node version it needs, so an older Node can fail with an unclear error on npm install or on the test script. Tools that read package.json (npm, dependency bots, repo scanners) also show a nameless entry with no link back to the repo.

Repro:

gh api repos/flisk-sh/analytics/contents/package.json --jq .content | base64 -d | python3 -c "import sys,json; d=json.load(sys.stdin); print([k for k in ['description','repository','engines'] if k not in d])"
# ['description', 'repository', 'engines']

Root Cause Analysis

The file was created with only name, private, scripts and dependencies. The metadata fields npm and Node tooling use to document the project were never added.

TDD Fix Plan

  1. RED: Write a test (or a CI check) that parses package.json and asserts engines.node is set.
    GREEN: Add "engines": {"node": ">=20"} matching the version CI and the Worker build use.
  2. RED: Write a test that asserts description is a non-empty string and repository.url points at this repo.
    GREEN: Add both fields.

REFACTOR: None expected.

Acceptance Criteria

  • engines.node is set and matches the CI Node version
  • description and repository are present
  • All new tests pass
  • Existing tests still pass
Dominant language
JavaScript
Stars
0
Forks
2
Avg merge
1h 33m
Merged PRs (30d)
7

Getting set up

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 flisk-sh/analytics

All issues in flisk-sh/analytics

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.