CLI: generate project
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
User story
Users should be able to use the CLI to generate a stub project. This is particularly useful in training.
Details
We need a structure like this:
jobs/job.js
tmp/state.json
workflow.json
.gitignore
.vscode/settings.json
project.yaml
vsconfig is optional but it would be cool to usea vsconfig which disables code assist in vsc (because it's super annoying when writing job code)
We may also want a project.yaml for easy deploy.
This vscode config should disable code complete:
// .vscode/settings.json
{
"javascript.suggest.enabled": false
}
API
The obvious way to do this is:
openfn generate project
Does this class with the AI project, which is openfn generate adaptor my-adaptor?
I don't think so, I think it all sits together
Release notes
Tests
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 entry point for openfn generate and compare it with the existing openfn generate adaptor command. Clarify the intended project layout, optional .vscode/settings.json, and project.yaml behavior before implementing generation. Done means the command produces the requested stub structure and has tests covering the generated files and command behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript, vscode
- Domain
- cli, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100