OpenFn / OpenFn/kit

CLI: Support state-props-to-remove?

Open
#591 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We should probably think about whether and how we include this in the CLI.

When the CLI runs locally it may not be necessary or desirable to remove any props from the returned state. All config should be known to the user anyway (for now - if we integrate a credential loader with Lightning then this is no longer true).

But the CLI and worker should have feature parity and have similar behaviour. So I do think we need to include this flag with the same default value as the worker, if only for posterity.

It's a small feature but I'm not interested in adding it to the 1.0 release queue.

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

No file or test is named. Start by locating the CLI and worker handling for state-props-to-remove? and compare their defaults; done means the CLI accepts the flag and matches the worker's behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.