Skip to content

Fix missing chalk dependency and improve README#318

Merged
Meris Nici (promeris) merged 1 commit intomasterfrom
fix/add-missing-chalk-dependency
Mar 12, 2026
Merged

Fix missing chalk dependency and improve README#318
Meris Nici (promeris) merged 1 commit intomasterfrom
fix/add-missing-chalk-dependency

Conversation

@bardhlohaj
Copy link
Collaborator

Summary

  • Add chalk as an explicit dependency (4.1.2) — it is imported in module-handler.ts and CustomHelp.ts but was never declared in package.json. A clean npm install -g @celonis/content-cli from the registry fails with Error: Cannot find module 'chalk' because chalk was only available as a hoisted transitive dependency during local development.
  • Improve the "Building and Using the Project locally" section — add prerequisites, step-by-step build instructions, and how to run/link the built CLI.
  • Add a Troubleshooting section — covers missing module errors, command not found, and Node.js version issues.

Test plan

  • Verified the error reproduces in an isolated install (copy dist/ to /tmp, run npm install --omit=dev, then node content-cli.js -h → crashes)
  • After adding chalk to dependencies, the same isolated install works correctly
  • All 247 existing tests pass (26 suites)
  • Audited all source imports — no other missing dependencies found

Made with Cursor

chalk is imported in module-handler.ts and CustomHelp.ts but was never
listed in package.json dependencies. It only worked locally because it
was hoisted as a transitive dependency. A clean install from the
registry (npm install -g) fails with "Cannot find module 'chalk'".

- Add chalk@4.1.2 to dependencies (last CJS-compatible version)
- Restructure the local build section with prerequisites and clear steps
- Add a Troubleshooting section for common installation issues

Includes-AI-Code: true
Made-with: Cursor
@bardhlohaj Bardh Lohaj (bardhlohaj) requested a review from a team as a code owner March 11, 2026 17:10
@promeris Meris Nici (promeris) merged commit 63bf45b into master Mar 12, 2026
3 of 4 checks passed
@promeris Meris Nici (promeris) deleted the fix/add-missing-chalk-dependency branch March 12, 2026 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants