CLI: add config debug utilities
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
The CLI should be able to help diagnose and fix common config problems.
For example - you should be able to ask the CLI what the config object should look like for your adaptor
> $ openfn config http
The http adaptor has the following config:
baseUrl: string
username: string
password: string
It would also be nice to have some validation on a config object, which throws a nice error if it detects your config is wrong.
The runtime shouldn't do any validation - but the CLI can, using the existing config schema stuff in the adaptor.
It should probably warn, rather than error/fail, when config is invalid (you'll get an error downstream anyway if your config is critically wrong)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the CLI config command and the existing adaptor config-schema implementation. Check how schemas expose the expected config fields and how CLI warnings are reported. Done should include a way to display an adaptor's expected config and warn clearly when supplied config fails validation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100