Release v3.1.0 (#42)

mgrachev · web-flow · commit 33b60e911042 · 2021-06-09T15:24:55.000+03:00
diff --git a/docs/README.md b/docs/README.md
@@ -17,6 +17,7 @@ Dotenv-linter can [check](/usage/check) / [fix](/usage/fix) / [compare](/usage/c
 &nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/lowercase_key">Lowercase key</a><br />
 &nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/quote_character">Quote character</a><br />
 &nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/space_character">Space character</a><br />
+&nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/substitution_key">Substitution Key</a><br />
 &nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/trailing_whitespace">Trailing whitespace</a><br />
 &nbsp;&nbsp;&nbsp;&nbsp;✅&nbsp;<a href="#/checks/unordered_key">Unordered Key</a><br />
 </p>
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -2,7 +2,8 @@
 * [👨‍💻Installation](installation.md)
 
 * 🎉What's new?
-	* [v3.0.0 (latest)](whats_new/v300.md)
+	* [v3.1.0 (latest)](whats_new/v310.md)
+	* [v3.0.0](whats_new/v300.md)
 	* [v2.2.1](whats_new/v221.md)
 	* [v2.2.0](whats_new/v2_2_0.md)  
 
diff --git a/docs/checks/incorrect_delimiter.md b/docs/checks/incorrect_delimiter.md
@@ -1,4 +1,4 @@
-# Incorrect delimiter
+# Incorrect Delimiter
 
 Detects if a key does not use an underscore to separate words:
 
diff --git a/docs/checks/key_without_value.md b/docs/checks/key_without_value.md
@@ -1,4 +1,4 @@
-# Key without value
+# Key Without Value
 
 Detects if a line has a key without a value:
 
diff --git a/docs/checks/leading_character.md b/docs/checks/leading_character.md
@@ -1,4 +1,4 @@
-# Leading character
+# Leading Character
 
 Detects if a line starts with an unallowed character (characters from `A` to `Z` and `_` (underscore) are allowed):
 
diff --git a/docs/checks/lowercase_key.md b/docs/checks/lowercase_key.md
@@ -1,4 +1,4 @@
-# Lowercase key
+# Lowercase Key
 
 Detects if a key has lowercase characters:
 
diff --git a/docs/checks/quote_character.md b/docs/checks/quote_character.md
@@ -1,4 +1,4 @@
-# Quote character
+# Quote Character
 
 Detects if a value contains quote characters (`'` / `"`) but skips if the value contains whitespaces or newline characters:
 
diff --git a/docs/checks/space_character.md b/docs/checks/space_character.md
@@ -1,4 +1,4 @@
-# Space character
+# Space Character
 
 Detects lines with a whitespace around equal sign character `=`:
 
diff --git a/docs/checks/trailing_whitespace.md b/docs/checks/trailing_whitespace.md
@@ -1,4 +1,4 @@
-# Trailing whitespace
+# Trailing Whitespace
 
 Detects if a line has a trailing whitespace:
 
diff --git a/docs/whats_new/v300.md b/docs/whats_new/v300.md
@@ -1,4 +1,4 @@
-# What's new in v3.0.0 (latest)?
+# What's new in v3.0.0?
 
 Two and a half months have passed since the last release, and we are ready to present you a new version of `dotenv-linter` — v3.0.0 🎉
 
@@ -184,7 +184,8 @@ PR: [#348](https://github.com/dotenv-linter/dotenv-linter/pull/348) ([@vbrandl](
 
 ### 9. Performance improvement 🚀
 
-Last but not least, we have improved the performance of the already fast `dotenv-linter`. The maximum start time has decreased from `9.3` ms to `4.3` ms (by more than `50%`) 🙀
+Last but not least, we have improved the performance of the already fast `dotenv-linter`.<br />
+The maximum start time has decreased from `9.3` ms to `4.3` ms (by more than `50%`) 🙀
 
 To check this, we made a benchmark using the [hyperfine](https://github.com/sharkdp/hyperfine) utility:
 
@@ -195,9 +196,11 @@ To check this, we made a benchmark using the [hyperfine](https://github.com/shar
 
 PR: [#350](https://github.com/dotenv-linter/dotenv-linter/pull/350) ([@vbrandl](https://github.com/vbrandl))
 
-These are all the key changes that are included in the new [v3.0.0](https://github.com/dotenv-linter/dotenv-linter/releases/tag/v3.0.0) release.
+These are all the key changes that are included in the new [v3.0.0](https://github.com/dotenv-linter/dotenv-linter/releases/tag/v3.0.0) release.<br/>
 Thanks to everyone who contributed 🙏
 
+---
+
 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) ❤️
diff --git a/docs/whats_new/v310.md b/docs/whats_new/v310.md
@@ -0,0 +1,141 @@
+# What's new in v3.1.0 (latest)?
+
+Here's an overview of the key changes included in this release.
+
+### 1. Suggestion of changes 🔥
+
+Previously, [action-dotenv-linter](https://github.com/dotenv-linter/action-dotenv-linter) could only display linter warnings as comments or code annotations.
+
+<img width="900" alt="github-pr-check" src="https://raw.githubusercontent.com/dotenv-linter/action-dotenv-linter/master/examples/example-github-pr-check.png">
+
+In the new version, [action-dotenv-linter](https://github.com/dotenv-linter/action-dotenv-linter) can immediately suggest changes.<br/>
+Now you don't need to switch to the code editor every time to fix the `.env` files.
+
+<img width="900" alt="github-code-suggestions" src="https://raw.githubusercontent.com/dotenv-linter/action-dotenv-linter/master/examples/example-github-code-suggestions.png">
+
+To enable this feature, just change the `reporter` to `github-code-suggestions`:
+
+```yaml
+# .github/workflows/dotenv.yml
+name: dotenv
+on: [pull_request]
+jobs:
+  dotenv-linter:
+    name: runner / dotenv-linter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run dotenv-linter with code suggestions
+        uses: dotenv-linter/action-dotenv-linter@v2
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-code-suggestions
+```
+
+PR: [#29](https://github.com/dotenv-linter/action-dotenv-linter/pull/29) ([@mgrachev](https://github.com/mgrachev))
+
+### 2. Variable substitution 🆕
+
+Most of the `dotenv` libraries support variable substitution, where you can reuse variable values in `.env` files:
+
+```bash
+# .env
+BAR=VALUE
+BAZ=$BAR
+FOO=${BAR}
+```
+
+It seems to be nothing complicated, but even here you can make some mistakes:
+
+```bash
+# .env
+BAZ=${BAR
+FOO=$BAR}
+```
+
+Therefore, we have added a new `Substitution Key` check, which will allow you to find and fix such problems.
+
+PR: [#414](https://github.com/dotenv-linter/dotenv-linter/pull/414) ([@de-sh](https://github.com/de-sh)), [#428](https://github.com/dotenv-linter/dotenv-linter/pull/428) ([@DDtKey](https://github.com/DDtKey))
+
+### 3. Improving checks 👍
+
+In the previous version, `dotenv-linter` did not take into account the presence of substitution variables in `.env` files:
+
+```bash
+# .env
+FOO=VALUE
+BAR="$FOO"
+```
+
+What caused the following warnings:
+
+```bash
+$ dotenv-linter 
+Checking .env
+.env:2 QuoteCharacter: The value has quote characters (', ")
+.env:2 UnorderedKey: The BAR key should go before the FOO key
+
+Found 2 problems
+```
+
+In the new version, we have fixed this and now `dotenv-linter` does not display any warnings when using substitution variables.
+
+PR: [#401](https://github.com/dotenv-linter/dotenv-linter/pull/401) ([@Ru5ty0ne](https://github.com/Ru5ty0ne)), [#406](https://github.com/dotenv-linter/dotenv-linter/pull/406) ([@stygian-coffee](https://github.com/stygian-coffee)), [#418](https://github.com/dotenv-linter/dotenv-linter/pull/418) ([@JuanMarchetto](https://github.com/JuanMarchetto))
+
+### 4. Checking backups 👌
+
+Usually, before fixing the file, `dotenv-linter` creates a backup by appending a timestamp to the filename.
+
+```bash
+$ dotenv-linter fix
+Fixing .env
+Original file was backed up to: ".env_1623238316"
+
+.env:2 UnorderedKey: The BAR key should go before the FOO key
+
+All warnings are fixed. Total: 1
+```
+
+When the linter was restarted, such files were scanned again and backups were created for them:
+
+```bash
+$ dotenv-linter fix
+Fixing .env
+Fixing .env_1623238316
+Original file was backed up to: ".env_1623238316_1623238541"
+
+.env_1623238316:2 UnorderedKey: The BAR key should go before the FOO key
+
+All warnings are fixed. Total: 1
+```
+
+Starting with the new version, all backup files are created with the `.bak` extension and are excluded from scanning.
+
+PR: [#367](https://github.com/dotenv-linter/dotenv-linter/pull/367) ([@mstruebing](https://github.com/mstruebing))
+
+### 5. Displaying messages 👀
+
+We added message output when there are no files for checking, fixing or comparing:
+
+```bash
+$ dotenv-linter
+Nothing to check
+
+$ dotenv-linter fix
+Nothing to fix
+
+$ dotenv-linter compare .env1 .env2
+Nothing to compare
+```
+
+PR: [#392](https://github.com/dotenv-linter/dotenv-linter/pull/392) ([@jodli](https://github.com/jodli)), [#394](https://github.com/dotenv-linter/dotenv-linter/pull/394) ([@mdycz](https://github.com/mdycz)), [#398](https://github.com/dotenv-linter/dotenv-linter/pull/398) ([@jakecorrenti](https://github.com/jakecorrenti))
+
+These are all the key changes that are included in the new [v3.1.0](https://github.com/dotenv-linter/dotenv-linter/releases/tag/v3.1.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) ⚙️ 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Incorrect delimiter`
	`1`	`+# Incorrect Delimiter`
`2`	`2`
`3`	`3`	`Detects if a key does not use an underscore to separate words:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Key without value`
	`1`	`+# Key Without Value`
`2`	`2`
`3`	`3`	`Detects if a line has a key without a value:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Leading character`
	`1`	`+# Leading Character`
`2`	`2`
`3`	`3`	Detects if a line starts with an unallowed character (characters from `A` to `Z` and `_` (underscore) are allowed):
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Lowercase key`
	`1`	`+# Lowercase Key`
`2`	`2`
`3`	`3`	`Detects if a key has lowercase characters:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Quote character`
	`1`	`+# Quote Character`
`2`	`2`
`3`	`3`	Detects if a value contains quote characters (`'` / `"`) but skips if the value contains whitespaces or newline characters:
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Space character`
	`1`	`+# Space Character`
`2`	`2`
`3`	`3`	Detects lines with a whitespace around equal sign character `=`:
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Trailing whitespace`
	`1`	`+# Trailing Whitespace`
`2`	`2`
`3`	`3`	`Detects if a line has a trailing whitespace:`
`4`	`4`