Add "health check" to detect inconsistencies

Open
#112 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
cli, tooling

Research direction

Start by reviewing how manifest.json and package.json dependencies are read, along with the existing npm translator error for missing dependencies. Define how checks for undeclared dependencies, mismatched sap.app/id values, and missing npm install should run implicitly rather than as a new command. Done means these inconsistencies produce actionable hints without breaking valid projects.

Written by the indexing model from the issue text.

Description

Some kind of health check should be really helpful to detect common mistakes such as

  • compare manifest.json dependency declaration to package.json dependencies and give a hint about missing / undeclared dependencies
  • inconsistencies between sap.app/id of manifest.json and the actual component name
  • missing npm install (no dependencies found)
    • Currently this only gives an error but doesn't give a hint how to solve it: Error: [npm translator] Could not locate module @openui5/sap.ui.core via resolve logic (error: Cannot find module '@openui5/sap.ui.core/package.json'

It might be better to do such checks implicitly rather than introducing a new command.

Dominant language
JavaScript
Stars
511
Forks
83
Avg merge
1d 5h
Merged PRs (30d)
55

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 UI5/cli

All issues in UI5/cli

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.