Merge pull request #56 from dotenv-linter/release-v330

mgrachev · web-flow · commit 680a7b265cec · 2022-12-24T16:14:32.000+03:00
Release v3.3.0
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,42 +1,44 @@
-* [💡What's a .env file?](whats_env.md)
-* [👨‍💻Installation](installation.md)
+* [💡 What's a .env file?](whats_env.md)
+* [👨‍💻 Installation](installation.md)
 
-* 🎉What's new?
-    * [v3.2.0 (latest)](whats_new/v320.md)
+* 🎉 What's new?
+    * [v3.3.0 (latest)](whats_new/v330.md)
+    * [v3.2.0](whats_new/v320.md)
     * [v3.1.1](whats_new/v311.md)
     * [v3.1.0](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)  
 
-* 🚀Usage
-    * [✅Check](usage/check.md)
-    * [🤲Compare](usage/compare.md)
-    * [🛠Fix](usage/fix.md)
-    * [📄List](usage/list.md)
+* 🚀 Usage
+    * [✅ Check](usage/check.md)
+    * [🤲 Compare](usage/compare.md)
+    * [🛠 Fix](usage/fix.md)
+    * [📄 List](usage/list.md)
 
-* ✅Checks
-    * [Duplicated Key](checks/duplicated_key.md)
-    * [Ending Blank Line](checks/ending_blank_line.md)
-    * [Extra Blank Line](checks/extra_blank_line.md)
-    * [Incorrect Delimiter](checks/incorrect_delimiter.md)
-    * [Key Without Value](checks/key_without_value.md)
-    * [Leading Character](checks/leading_character.md)
-    * [Lowercase Key](checks/lowercase_key.md)
-    * [Quote Character](checks/quote_character.md)
-    * [Space Character](checks/space_character.md)
-    * [Substitution Key](checks/substitution_key.md)
+* ✅ Checks
+    * [Duplicated key](checks/duplicated_key.md)
+    * [Ending blank line](checks/ending_blank_line.md)
+    * [Extra blank line](checks/extra_blank_line.md)
+    * [Incorrect delimiter](checks/incorrect_delimiter.md)
+    * [Key without value](checks/key_without_value.md)
+    * [Leading character](checks/leading_character.md)
+    * [Lowercase key](checks/lowercase_key.md)
+    * [Quote character](checks/quote_character.md)
+    * [Space character](checks/space_character.md)
+    * [Substitution key](checks/substitution_key.md)
     * [Trailing whitespace](checks/trailing_whitespace.md)
-    * [Unordered Key](checks/unordered_key.md)
+    * [Unordered key](checks/unordered_key.md)
+    * [Value without quotes](checks/value_without_quotes.md)
 
-* 🔄Integrations
+* 🔄 Integrations
     * [CircleCI](integrations/circleci.md)
     * [GitHub Actions](integrations/github_actions.md)
     * [Mega-Linter](integrations/mega_linter.md)
     * [Reviewdog](integrations/reviewdog.md)
     * [Super-Linter](integrations/super_linter.md)
 
-* [🚧Benchmark](benchmark.md)
-* [✌️Mentorship](mentorship.md)
-* [🤝Contributing](contributing.md)
-* [❤️Sponsors](sponsors.md)
+* [🚧 Benchmark](benchmark.md)
+* [✌️ Mentorship](mentorship.md)
+* [🤝 Contributing](contributing.md)
+* [❤️ Sponsors](sponsors.md)
diff --git a/docs/checks/duplicated_key.md b/docs/checks/duplicated_key.md
@@ -1,4 +1,4 @@
-# Duplicated Key
+# Duplicated key
 
 Detects if a key is not unique:
 
diff --git a/docs/checks/ending_blank_line.md b/docs/checks/ending_blank_line.md
@@ -1,4 +1,4 @@
-# Ending Blank Line
+# Ending blank line
 
 Detects if a file doesn't have a blank line at the end:
 
diff --git a/docs/checks/extra_blank_line.md b/docs/checks/extra_blank_line.md
@@ -1,4 +1,4 @@
-# Extra Blank Line
+# Extra blank line
 
 Detects if a file contains more than one blank line in a row:
 
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 is multi-line, contains whitespaces, newline characters or hash-signs:
 
diff --git a/docs/checks/space_character.md b/docs/checks/space_character.md
@@ -1,6 +1,6 @@
-# Space Character
+# Space character
 
-Detects lines with a whitespace around equal sign character `=`:
+Detects a line with a whitespace around equal sign character `=`:
 
 ```env
 ❌ Wrong
diff --git a/docs/checks/substitution_key.md b/docs/checks/substitution_key.md
@@ -1,4 +1,4 @@
-# Substitution Key
+# Substitution key
 
 Detects if a substitution is not properly performed on key assignment:
 
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/checks/unordered_key.md b/docs/checks/unordered_key.md
@@ -1,4 +1,4 @@
-# Unordered Key
+# Unordered key
 
 Detects if a key is not alphabetically ordered:
 
diff --git a/docs/checks/value_without_quotes.md b/docs/checks/value_without_quotes.md
@@ -0,0 +1,11 @@
+# Value without quotes
+
+Detects if a value contains whitespaces and at the same time doesn't contain quote characters (`'` / `"`):
+
+```env
+❌ Wrong
+FOO=BAR BAZ
+
+✅ Correct
+FOO="BAR BAR"
+```
diff --git a/docs/whats_new/v320.md b/docs/whats_new/v320.md
@@ -1,4 +1,4 @@
-# What's new in v3.2.0 (latest)?
+# What's new in v3.2.0?
 
 Here's an overview of the key changes included in this release.
 
diff --git a/docs/whats_new/v330.md b/docs/whats_new/v330.md
@@ -0,0 +1,58 @@
+# What's new in v3.3.0?
+
+Here's an overview of the key changes included in this release.
+
+### 1. Checking for values without quotes 🆕
+
+Now `dotenv-linter` can find and fix values with whitespaces and which are not wrapped in quotes:
+
+```bash
+# .env
+FOO=BAR BAZ
+```
+
+The output will be like that:
+
+```bash
+$ dotenv-linter 
+Checking .env
+.env:1 ValueWithoutQuotes: This value needs to be surrounded in quotes
+
+Found 1 problem
+```
+
+PR: [#521](https://github.com/dotenv-linter/dotenv-linter/pull/521) ([@tabfugnic](https://github.com/tabfugnic))
+
+### 2. Improving checks 👍
+
+Usually `dotenv-linter` prints a warning if it finds values wrapped in quotes:
+
+```bash
+# .env
+FOO='#comment'
+```
+
+If the value contains the hash-sign, then after correction, this value will become a comment:
+
+```bash
+# .env
+FOO=#comment
+```
+
+In the new version, we fixed this problem and added an exceptions for the hash-sign.
+
+PR: [#560](https://github.com/dotenv-linter/dotenv-linter/pull/560) ([@95jonpet](https://github.com/95jonpet))
+
+### 3. Adding Docker `arm64` image 🚀
+
+PR: [#533](https://github.com/dotenv-linter/dotenv-linter/pull/533) ([@mgrachev](https://github.com/mgrachev), [@mstruebing](https://github.com/mstruebing))
+
+These are all the key changes that are included in the new [v3.3.0](https://github.com/dotenv-linter/dotenv-linter/releases/tag/v3.3.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`		`-# Duplicated Key`
	`1`	`+# Duplicated key`
`2`	`2`
`3`	`3`	`Detects if a key is not unique:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Ending Blank Line`
	`1`	`+# Ending blank line`
`2`	`2`
`3`	`3`	`Detects if a file doesn't have a blank line at the end:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Extra Blank Line`
	`1`	`+# Extra blank line`
`2`	`2`
`3`	`3`	`Detects if a file contains more than one blank line in a row:`
`4`	`4`
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 is multi-line, contains whitespaces, newline characters or hash-signs:
`4`	`4`