diff --git a/docs/usage/fix.md b/docs/usage/fix.md index 3523858..d7b842c 100644 --- a/docs/usage/fix.md +++ b/docs/usage/fix.md @@ -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: diff --git a/docs/whats_new/v331.md b/docs/whats_new/v331.md index 4285465..e62c261 100644 --- a/docs/whats_new/v331.md +++ b/docs/whats_new/v331.md @@ -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.
Thanks to everyone who contributed 🙏