Skip to content

Navigation Menu

Sign in
Appearance settings
Sign up
Appearance settings

Allow custom footprints to be passed in via cli - #64

#64
Open
chrishoage wants to merge 1 commit into
ergogen:developergogen/ergogen:developfrom
chrishoage:cli-footprintschrishoage/ergogen:cli-footprintsCopy head branch name to clipboard
Open

Allow custom footprints to be passed in via cli#64
chrishoage wants to merge 1 commit into
ergogen:developergogen/ergogen:developfrom
chrishoage:cli-footprintschrishoage/ergogen:cli-footprintsCopy head branch name to clipboard

Conversation

@chrishoage

Copy link
Copy Markdown

Many people fork ergogen in order to add custom footprints. This is a little cumbersome and since there is already a way to inject footprints at runtime I have exposed this feature.

Please let me know if there are any other improvements you would like me to make before merging, as I do realize my implementation is a little naive (though my position is the CLI is a power user feature, and custom footprints double so. I saw it as "use at your own risk" sort of thing.

Example of use:

./src/cli.js test.yaml -o ./out -f ./footprints --clean

This allows, for example, a user to load a reversible promicro footprint, or any other custom footprint they wish. Users can depend on ergodash in their package.json for their project, then load footprints from their repo with out any need to fork (if all they wish is to load custom footprints)

@chrishoage

Copy link
Copy Markdown
Author

I actually ended up refactoring a lot of the cli in order to get a watch mode for the output so I could develop the board using the still in development v4

Not sure if you'd want me to open an PR, but if so just let me know.

https://github.com/chrishoage/spleeb/blob/main/scripts/cli.js

@mrzealot

mrzealot commented Aug 9, 2022

Copy link
Copy Markdown
Collaborator

Thanks for both of these! Footprints are under heavy refactoring at the moment, but afterwards I was already planning to support this (mostly with zip packages, but no reason why a separate footprint folder can't work). And watch functionality would be convenient, too. So, might not merge as-is, but these are good as drafts + reminders, and I'll be sure to get to them after the refactor phase is done. Tyty! 👍

@chrishoage

Copy link
Copy Markdown
Author

mostly with zip packages, but no reason why a separate footprint folder can't work

I'd def like to see a footprint folder since it would be a lot more "git friendly" than a zip file. Though I can see a zip being useful for people to include collections of footprints if they are not using git / making their own footprints.

So, might not merge as-is, but these are good as drafts + reminders

Feel free to close this if you'd like to reduce the noise in the repo. I just did this so I could have an easier time developing the board.

Thanks for the wonderful work on this project!

@mrzealot

mrzealot commented Aug 9, 2022

Copy link
Copy Markdown
Collaborator

I'd def like to see a footprint folder since it would be a lot more "git friendly" than a zip file. Though I can see a zip being useful for people to include collections of footprints if they are not using git / making their own footprints.

Oh sure, the "official" footprints will be in a folder, and "3rd party" ones can be then mixed and matched by adding their folder(s). I just mention zips as a way to allow self-contained, dependency-less packages that use custom footprints or whatnot. Also, zips are probably gonna be the more common usage as they'll be the easy way to add extra stuff (either a self-contained config, or just a bunch of footprints usable from the config) to the web ui - like you said, CLI is probably more of a power user feature.

Feel free to close this if you'd like to reduce the noise in the repo.

Oh no, no, it's good to have an active reminder. I must learn to thrive amid the chaos anyway 😆 Anyhow, I'm just glad my shit's turning out to be useful...

@mrzealot

mrzealot commented Dec 3, 2022

Copy link
Copy Markdown
Collaborator

Just a quick update that footprint sideloading has already landed in develop 👍 Leaving this open for the watch functionality reminder, tho...

@mrzealot mrzealot added the enhancement New feature or request label Dec 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.