You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+1-11
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,6 @@ Dependencies are installed to a `.deps` directory, with executables in `.deps/bi
30
30
-[.devkit Modules](#devkit-modules)
31
31
-[All-Purpose Modules](#all-purpose-modules)
32
32
*[cram](#cram)
33
-
*[dotenv](#dotenv)
34
33
*[shell-console](#shell-console)
35
34
-[Watch Modules](#watch-modules)
36
35
*[entr-watch](#entr-watch)
@@ -150,14 +149,6 @@ As long as you run cram via `script/test`, `dk test`, or `dk cram`, you can plac
150
149
151
150
Setup files can source other shell files, including other directories' `cram-setup.sh` files if you need to share setup between directories (e.g. `source "$TESTDIR/../cram-setup.sh"` to source and extend a parent directory's setup). You can also just symlink from one cram-setup.sh to another.
152
151
153
-
#### dotenv
154
-
155
-
The [dotenv](modules/dotenv) module sources a local clone of the [bashup/dotenv](https://github.com/bashup/dotenv/) tool for manipulating .env files in [docker-compose format](https://docs.docker.com/compose/compose-file/#env_file). After a `dk use: dotenv`, the rest of your `.dkrc` can use the `.env` function to read, edit, and set defaults in `.env` files -- perfect for project setup scripts or other commands that need configuration.
156
-
157
-
In addition, if you are using `direnv` (or the console command of the shell-console module), then you can also use the `dotenv` command directly on the command line.
158
-
159
-
For more information on how `dotenv` and `.env` work, please see the [dotenv documentation](https://github.com/bashup/dotenv/).
160
-
161
152
#### shell-console
162
153
163
154
The [shell-console](modules/shell-console) module implements a `dk.console` function to provide a `script/console` command that starts a bash subshell with the devkit API and all variables available -- a bit like dropping into a debugger for the `dk` command. This is particularly handy if you don't have or use `direnv`, as it basically gives you an alternative to typing `script/foo` or `.devkit/dk foo`: within the subshell you can just `dk foo`.
@@ -339,5 +330,4 @@ The following variables control the operation of the container:
339
330
340
331
Inside the docker container, a `run-bash VERSION command...` command is run first, allowing you to do any docker-specific setup (e.g. installing additional dependencies) by either overriding the command or defining a `before` handler for the `run-bash` event.
341
332
342
-
Note: the docker container will use `.deps/.bash-VERSION` as its `/workdir/.deps`, so that its installed dependencies can be platform-specific. Running `clean` inside a container will clean only the dependencies for that bash version, while running `clean` outside the container will wipe dependencies for both the base project and all bash versions used to that point.
343
-
333
+
Note: the docker container will use `.deps/.bash-VERSION` as its `/workdir/.deps`, so that its installed dependencies can be platform-specific. Running `clean` inside a container will clean only the dependencies for that bash version, while running `clean` outside the container will wipe dependencies for both the base project and all bash versions used to that point.
0 commit comments