Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI: generate project #625

Open
josephjclark opened this issue Mar 13, 2024 · 1 comment
Open

CLI: generate project #625

josephjclark opened this issue Mar 13, 2024 · 1 comment

Comments

@josephjclark
Copy link
Collaborator

josephjclark commented Mar 13, 2024

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

@github-project-automation github-project-automation bot moved this to New Issues in v2 Mar 13, 2024
@christad92 christad92 moved this from New Issues to Backlog in v2 Mar 17, 2024
@josephjclark
Copy link
Collaborator Author

josephjclark commented Apr 18, 2024

We need to be careful with lightning compatibility when we do this, so that it's as easy as possible to deploy to lightning.

It would be a good first issue if I can tighten up the spec a little bit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant