Skip to content
Draft
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

---

Dotenv-linter can [check](/usage/check) / [fix](/usage/fix) / [compare](/usage/compare) `.env` files for problems that may cause the application to malfunction.
Dotenv-linter can [check](/usage/check) / [fix](/usage/fix) / [compare](/usage/diff) `.env` files for problems that may cause the application to malfunction.

**Available checks**:
<p>
Expand Down
7 changes: 4 additions & 3 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
* [👨‍💻 Installation](installation.md)

* 🎉 What's new?
* [v3.3.1 (latest)](whats_new/v331.md)
* [v4.0.0 (latest)](whats_new/v400.md)
* [v3.3.1](whats_new/v331.md)
* [v3.3.0](whats_new/v330.md)
* [v3.2.0](whats_new/v320.md)
* [v3.1.1](whats_new/v311.md)
Expand All @@ -13,9 +14,8 @@

* 🚀 Usage
* [✅ Check](usage/check.md)
* [🤲 Compare](usage/compare.md)
* [🤲 Diff](usage/diff.md)
* [🛠 Fix](usage/fix.md)
* [📄 List](usage/list.md)

* ✅ Checks
* [Duplicated key](checks/duplicated_key.md)
Expand All @@ -26,6 +26,7 @@
* [Leading character](checks/leading_character.md)
* [Lowercase key](checks/lowercase_key.md)
* [Quote character](checks/quote_character.md)
* [Schema violation](checks/schema_violation.md)
* [Space character](checks/space_character.md)
* [Substitution key](checks/substitution_key.md)
* [Trailing whitespace](checks/trailing_whitespace.md)
Expand Down
1 change: 1 addition & 0 deletions docs/checks/schema_violation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO
2 changes: 1 addition & 1 deletion docs/usage/check.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ✅ Check
# ✅ Check TODO

By default, `dotenv-linter` checks all `.env` files in the current directory:

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/compare.md → docs/usage/diff.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🤲 Compare
# 🤲 Compare TODO

`dotenv-linter` can compare `.env` files with each other and output the difference between them with the `compare` command (or its short version `c`):

Expand Down
10 changes: 5 additions & 5 deletions docs/usage/fix.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# 🛠 Fix
# 🛠 Fix TODO

`dotenv-linter` can also fix the found warnings with the `fix` command (or its short version `f`):

```bash
$ dotenv-linter fix
$ dotenv-linter fix .
Fixing .env
Original file was backed up to: ".env_1601378896"

Expand All @@ -18,7 +18,7 @@ All warnings are fixed. Total: 2
By default, `fix` creates backups of files. If you want to disable the backup function, use the argument `--no-backup`:

```bash
$ dotenv-linter fix --no-backup
$ dotenv-linter fix . --no-backup
Fixing .env
.env:2 DuplicatedKey: The BAR key is duplicated
.env:3 LowercaseKey: The foo key should be in uppercase
Expand All @@ -31,7 +31,7 @@ All warnings are fixed. Total: 2
If you want to run `fix` without modifying any files on disk, use the `--dry-run` flag.

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

Expand All @@ -46,7 +46,7 @@ FOO=foo_example
All warnings are fixed. Total: 2
```

#### Addition arguments
#### Addition arguments TODO

In addition, the `fix` command supports the following list of arguments:
* [--exclude](/usage/check?id=exclude-files)
Expand Down
19 changes: 0 additions & 19 deletions docs/usage/list.md

This file was deleted.

22 changes: 22 additions & 0 deletions docs/whats_new/v400.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# What's new in v3.3.1? TODO

Here's an overview of the key changes included in this release.

### 1. Fix docker image for `arm64`

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 🙏

---

How you can support the project 😉

* Star on [GitHub](https://github.com/dotenv-linter/dotenv-linter) ⭐️
* Become a sponsor on [GitHub Sponsors](https://github.com/sponsors/dotenv-linter) or [OpenCollective](https://opencollective.com/dotenv-linter) ❤️
* Contribute to the [dotenv-linter](https://github.com/dotenv-linter/dotenv-linter/blob/master/CONTRIBUTING.md) ⚙️