garden icon indicating copy to clipboard operation
garden copied to clipboard

[FEATURE]: Configurable folder to search for custom commands

Open isaacpz opened this issue 2 years ago • 3 comments

Feature Request

All custom commands currently must be stored in the project root. For projects with many custom commands, this makes the root folder explode with lots of files.

I understand there is a performance concern with searching all subfolders, but it'd be great if I could configure a single folder that should be used to store custom commands in.

Ideally, subfolders of the configured folder would also be searched (with a much less demanding performance impact because the search path will be so restricted)

Background / Motivation

I am trying to set up a Garden project that heavily uses the custom command functionality.

What should the user be able to do?

In the project garden.yml, the user should be able to include something like: customCommandPath: commands, which is added to the search path when looking for custom commands.

For example, this folder structure should work:

project.garden.yml (includes customCommandPath: commands)
commands/
   command1.garden.yml
   command2.garden.yml
   command3.garden.yml
   module1/
      command4.garden.yml
command5.garden.yml

Why do they want to do this? What problem does it solve?

I do not want lots of custom command configurations in the root of my project.

Suggested Implementation(s)

See above

How important is this feature for you/your team?

🌹 It’s a nice to have, but nice things are nice 🙂

isaacpz avatar Apr 22 '22 21:04 isaacpz

Hi @isaacpz—thanks for writing this up!

@edvald, am I right in assuming that this could be done without significant performance impact?

thsig avatar Jun 09 '22 09:06 thsig

Correct, this should have no performance impact since the project config is loaded before the commands are loaded.

edvald avatar Jun 14 '22 13:06 edvald

This issue has been automatically marked as stale because it hasn't had any activity in 90 days. It will be closed in 14 days if no further activity occurs (e.g. changing labels, comments, commits, etc.). Please feel free to tag a maintainer and ask them to remove the label if you think it doesn't apply. Thank you for submitting this issue and helping make Garden a better product!

stale[bot] avatar Sep 21 '22 03:09 stale[bot]

This issue has been automatically marked as stale because it hasn't had any activity in 90 days. It will be closed in 14 days if no further activity occurs (e.g. changing labels, comments, commits, etc.). Please feel free to tag a maintainer and ask them to remove the label if you think it doesn't apply. Thank you for submitting this issue and helping make Garden a better product!

stale[bot] avatar Jan 07 '23 20:01 stale[bot]

This issue has been automatically marked as stale because it hasn't had any activity in 90 days. It will be closed in 14 days if no further activity occurs (e.g. changing labels, comments, commits, etc.). Please feel free to tag a maintainer and ask them to remove the label if you think it doesn't apply. Thank you for submitting this issue and helping make Garden a better product!

stale[bot] avatar May 21 '23 20:05 stale[bot]