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

gearchy feature custom goggle dependencies #36

Open
devidw opened this issue Sep 18, 2022 · 0 comments
Open

gearchy feature custom goggle dependencies #36

devidw opened this issue Sep 18, 2022 · 0 comments

Comments

@devidw
Copy link
Owner

devidw commented Sep 18, 2022

In the goggle editor, the user should be able to define a list of gist URLs that are treated as dependencies (extra tab in the editor?)

This way, goggles could inherit/extend rules from other goggles

The defined dependencies have to be saved into the goggle, most likely some meta comment

And once the gist gets written to GitHub, the dependencies have to be pulled and their instructions (all metadata and comments should be removed) need to be placed inside the goggle

Placement inside the goggle should wrap inside a pair of comments that defines start and end of dependencies

Vendor instructions need to be ignored or striped before the goggle is loaded into the editor

For example, something like:

! name: …

! depends_on: https://…
! depends_on: https://…

! dependency injection start
…
! dependency injection end

…

For implementation of such functionality, perhaps there should be something like a plugin system to be able to extend goggledy to allow custom metadata lines and custom start/end blocks inside goggles

Maybe goggledy should handle an internal list of possible line syntaxes and plugins could register custom syntax definitions like for example a custom metadata line which would detec any ! …: … line


Dependency functionality should not be bundled into goggledy directly, rather as an extra package

The package could ship functionality to:

  • clear a goggle instance from dependency specific comment and instructions
  • get and set the dependency URLs and dependency instructions from a goggle instance
  • fetch and process the dependency URLs and get the instructions cleaned from meta, comments, etc.

These functions would be invoked inside gearchy when the goggle is parsed and stringified

Dependency URLs and content should be managed inside an extra store or the goggle store

Gearchy should also allow the user to trigger an update on the dependencies, this would fetch all dependency sources and place them inside the goggle

Normally only those already in the goggle would be saved to the updated goggle again without updating

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

No branches or pull requests

1 participant