Skip to content

[Repo Assist] chore: document Node.js >=18 engine requirement in package.json #130

@github-actions

Description

@github-actions

🤖 This is an automated draft PR from Repo Assist, an AI assistant.

Summary

Adds "node": ">=18" to the engines field in package.json, documenting the minimum Node.js version required by the project's test runner.

Problem

The npm run test:unit script (node --test test/unit.test.js) uses the Node.js built-in test runner, which was introduced in Node.js 18. Without an engines.node field, a developer running npm install or npm test on an older Node version (e.g. 16) gets a cryptic TypeError: The "runner" argument must be of type function. Received undefined error rather than a clear compatibility warning from npm.

Fix

Add a single field to the existing engines object:

"engines": {
    "vscode": "^1.19.0",
    "node": ">=18"
}

This is a metadata-only change — no runtime behaviour is affected.

Benefits

  • npm prints a clear engine compatibility warning if developers have a mismatched Node version
  • Documents the actual runtime requirement (already implicitly required by test:unit)
  • Appears in the VS Code Marketplace extension manifest for transparency

Test Status

✅ All 7 unit tests pass: npm run test:unit
✅ Syntax check clean: node --check extension.js

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

Warning

🛡️ Protected Files

This was originally intended as a pull request, but the patch modifies protected files: package.json.

These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.

Click here to create the pull request once you have reviewed the changes

To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions