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

Optionally ignore missing files from cli #463

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ gem 'dotenv-rails', groups: [:development, :test]

And then execute:

```shell
```console
$ bundle
```

Expand Down Expand Up @@ -49,7 +49,7 @@ gem 'gem-that-requires-env-variables'

Install the gem:

```shell
```console
$ gem install dotenv
```

Expand All @@ -72,16 +72,22 @@ Dotenv.load('file1.env', 'file2.env')

Alternatively, you can use the `dotenv` executable to launch your application:

```shell
```console
$ dotenv ./script.rb
```

The `dotenv` executable also accepts a single flag, `-f`. Its value should be a comma-separated list of configuration files, in the order of most important to least. All of the files must exist. There _must_ be a space between the flag and its value.
The `dotenv` executable also accepts the flag `-f`. Its value should be a comma-separated list of configuration files, in the order of most important to least. All of the files must exist. There _must_ be a space between the flag and its value.

```
```console
$ dotenv -f ".env.local,.env" ./script.rb
```

The `dotenv` executable can optionally ignore missing files with the `-i` or `--ignore` flag. For example, if the `.env.local` file does not exist, the following will ignore the missing file and only load the `.env` file.

```console
$ dotenv -i -f ".env.local,.env" ./script.rb
```

To ensure `.env` is loaded in rake, load the tasks:

```ruby
Expand Down Expand Up @@ -223,7 +229,8 @@ Credentials should only be accessible on the machines that need access to them.


You can use the `-t` or `--template` flag on the dotenv cli to create a template of your `.env` file.
```shell

```console
$ dotenv -t .env
```
A template will be created in your working directory named `{FINAME}.template`. So in the above example, it would create a `.env.template` file.
Expand Down Expand Up @@ -251,7 +258,8 @@ Personally, I prefer to commit the `.env` file with development-only settings. T
By default, it **won't** overwrite existing environment variables as dotenv assumes the deployment environment has more knowledge about configuration than the application does. To overwrite existing environment variables you can use `Dotenv.overload`.

You can also use the `-o` or `--overload` flag on the dotenv cli to override existing `ENV` variables.
```shell

```console
$ dotenv -o -f ".env.local,.env"
```

Expand Down
14 changes: 9 additions & 5 deletions lib/dotenv/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ class CLI < OptionParser
def initialize(argv = [])
@argv = argv.dup
@filenames = []
@ignore = false
@overload = false

super("Usage: dotenv [options]")
Expand All @@ -20,6 +21,10 @@ def initialize(argv = [])
@filenames = list
end

on("-i", "--ignore", "ignore missing env files") do
@ignore = true
end

on("-o", "--overload", "override existing ENV variables") do
@overload = true
end
Expand All @@ -43,11 +48,10 @@ def initialize(argv = [])
end

def run
if @overload
Dotenv.overload!(*@filenames)
else
Dotenv.load!(*@filenames)
end
method = @overload ? "overload" : "load"
method = "#{method}!" unless @ignore

Dotenv.public_send(method, *@filenames)
rescue Errno::ENOENT => e
abort e.message
else
Expand Down
6 changes: 6 additions & 0 deletions spec/dotenv/cli_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ def run(*args)
end.to raise_error(SystemExit, /No such file/)
end

it "ignores missing files when --ignore flag given" do
expect do
run "--ignore", "-f", ".doesnotexist"
end.not_to raise_error
end

it "loads from multiple files specified by -f" do
expect(ENV).not_to have_key("PLAIN")
expect(ENV).not_to have_key("QUOTED")
Expand Down