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

Shep as a library #258

Open
chris-olszewski opened this issue Jun 15, 2017 · 4 comments
Open

Shep as a library #258

chris-olszewski opened this issue Jun 15, 2017 · 4 comments

Comments

@chris-olszewski
Copy link
Contributor

I think we're pretty close to this being a thing. Just a matter of making sure all the functions return something/can be used without their respective commands being run first.

@chris-olszewski
Copy link
Contributor Author

Would also probably make sense to make all calls to shep as a library be quiet by default

@chris-olszewski
Copy link
Contributor Author

So a few things that I think are still a bit up in the air:

  • Where should documentation for the pragmatic interface live? (Also how to generate it)
  • There are some commands that don't translate well to being used in a library:
    • run as if there are errors it calls process.exit(numOfErrors) -> should be moved to command file
    • logs as it returns a chain of promises that continue to grow until the process is stopped -> streams?
  • Some commands don't have a clear idea of what they should return:
    • new
    • deploy
    • build
    • generate functions

@chris-olszewski
Copy link
Contributor Author

As part of this I feel like we should try to remove listr calls from the functions themselves. Big issue with this is shep.deploy as listr is actually relied on by deploy for control flow

@southpolesteve
Copy link
Collaborator

southpolesteve commented Jun 17, 2017 via email

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

No branches or pull requests

2 participants