This page will get more fleshed out in the future. For now, have an outline.
Naming files
Shadowenv files must end in .lisp
, and must be in the .shadowenv.d
directory. We additionally
strongly suggest that implementors name files with a three-digit decimal number prefix to enforce
a load order, and leave plenty of space between the entries you create:
050_base.lisp
500_node.lisp
510_ruby.lisp
900_user_config.lisp
Gitignore
We suggest gitignore
‘ing the entire .shadowenv.d
directory. The directory should be treated as
a locally-generated artifact and be generated entirely by user tooling. At Shopify, this is done by
dev
.
This is not the only valid way to go though, you may get some mileage out of committing the files. Let us know what you do!
Prompt Widget
You may find it helpful to have a visual indicator in your terminal that a
Shadowenv is active. You can embed $(shadowenv prompt-widget)
in your PS1
or
PROMPT
, etc., to achieve this.