diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/docs/README.md b/docs/README.md index 3aed286..f19c1e4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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**:

diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 2b78f2e..0501111 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -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) @@ -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) @@ -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) diff --git a/docs/checks/schema_violation.md b/docs/checks/schema_violation.md new file mode 100644 index 0000000..1333ed7 --- /dev/null +++ b/docs/checks/schema_violation.md @@ -0,0 +1 @@ +TODO diff --git a/docs/usage/check.md b/docs/usage/check.md index daf1aa4..4ec1fad 100644 --- a/docs/usage/check.md +++ b/docs/usage/check.md @@ -1,4 +1,4 @@ -# ✅ Check +# ✅ Check TODO By default, `dotenv-linter` checks all `.env` files in the current directory: diff --git a/docs/usage/compare.md b/docs/usage/diff.md similarity index 96% rename from docs/usage/compare.md rename to docs/usage/diff.md index ede2915..f9aeecb 100644 --- a/docs/usage/compare.md +++ b/docs/usage/diff.md @@ -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`): diff --git a/docs/usage/fix.md b/docs/usage/fix.md index d7b842c..3a53092 100644 --- a/docs/usage/fix.md +++ b/docs/usage/fix.md @@ -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" @@ -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 @@ -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. @@ -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) diff --git a/docs/usage/list.md b/docs/usage/list.md deleted file mode 100644 index d0faee6..0000000 --- a/docs/usage/list.md +++ /dev/null @@ -1,19 +0,0 @@ -# 📄 List - -If you need to view all available checks, you can use the `list` command (or its short version `l`): - -```bash -$ dotenv-linter list -DuplicatedKey -EndingBlankLine -ExtraBlankLine -IncorrectDelimiter -KeyWithoutValue -LeadingCharacter -LowercaseKey -QuoteCharacter -SpaceCharacter -SubstitutionKey -TrailingWhitespace -UnorderedKey -``` diff --git a/docs/whats_new/v400.md b/docs/whats_new/v400.md new file mode 100644 index 0000000..ebb8210 --- /dev/null +++ b/docs/whats_new/v400.md @@ -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.
+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) ⚙️