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

Improve naming of different lib types #160

Closed
jbrunton opened this issue Sep 30, 2020 · 0 comments · Fixed by #163
Closed

Improve naming of different lib types #160

jbrunton opened this issue Sep 30, 2020 · 0 comments · Fixed by #163

Comments

@jbrunton
Copy link
Owner

jbrunton commented Sep 30, 2020

Currently we have:

  • files and directories added as "libs" (i.e. added to template engine load path)
  • .gflowslib packages
  • the main context package

Option A:

  • Consider a lib to be any dependency (file, dir or package) added to the build path
  • Consider a package to be a special form of directory which includes workflows/ and libs/ directories.
  • Rename .gflowslib to .gflowspkg?

Option B:

  • Rename the libs config option to paths
  • A library then refers only to a .gflowslib package.

Option C:

  • distinguish between packages and libs (or paths) in config.
  • could link to root folder instead of manifest.
templates:
  engine: ytt
  libs:
  - vendor
  dependencies:
  - https://example.com/my-lib

Also consider: standardize package manifests on gflowspkg.json (or gflowslib.json, or gflows.pkg.json).

Pros of A: naming consistent with packages in NPM ecosystem and others.
Pros of C: simplify code and intent.

@jbrunton jbrunton linked a pull request Oct 2, 2020 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant