OpenFn / OpenFn/kit

CLI: New merge/checkout etc commands should error properly

Open
#1,118 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

The new CLI commands, when they encounter an error, will log politely and return early

This is actually really annoying because unit tests won't catch unexpected exceptions and can, I think, accidentally pass.

Most CLI functions will throw when they encounter critical errors, and the CLI is setup to handle this properly (it uses a non zero exit code for example).

It'll take a while I think to restructure the errors so creating this issue as a reminder to do it later

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the new CLI commands and the existing CLI error-handling path. Run the relevant unit tests to identify commands that log and return instead of propagating critical errors. Done means unexpected command failures are observable by tests and produce the CLI's normal non-zero exit behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.