Skip to content

Document new --dry-run flag #61

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

Merged
merged 2 commits into from
Jun 4, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/usage/fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,26 @@ Fixing .env
All warnings are fixed. Total: 2
```

#### Dry run

If you want to run `fix` without modifying any files on disk, use the `--dry-run` flag.

```bash
$ dotenv-linter fix --dry-run
Fixing .env
Dry run - not changing any files on disk.

BAR=bar_example_one
# BAR=bar_example_two
FOO=foo_example


.env:2 DuplicatedKey: The BAR key is duplicated
.env:3 LowercaseKey: The foo key should be in uppercase

All warnings are fixed. Total: 2
```

#### Addition arguments

In addition, the `fix` command supports the following list of arguments:
Expand Down
4 changes: 4 additions & 0 deletions docs/whats_new/v331.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Here's an overview of the key changes included in this release.

PR: [#757](https://github.com/dotenv-linter/dotenv-linter/pull/757) ([@harryzcy](https://github.com/harryzcy))

### 2. Add `--dry-run` option to the "fix" subcommand

PR: [#772](https://github.com/dotenv-linter/dotenv-linter/pull/772) ([@Dev380](https://github.com/Dev380))

These are all the key changes that are included in the new [v3.3.1](https://github.com/dotenv-linter/dotenv-linter/releases/tag/v3.2.0) release.<br/>
Thanks to everyone who contributed 🙏

Expand Down