From 21fc19d86668ed77480b5ff9dd0010e035e57b90 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 17 Oct 2023 21:42:44 -0600 Subject: [PATCH] doc(dotenv-linter): reword some sections --- dotenv-linter/README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/dotenv-linter/README.md b/dotenv-linter/README.md index f34725a..a9db8c3 100644 --- a/dotenv-linter/README.md +++ b/dotenv-linter/README.md @@ -25,9 +25,12 @@ install: ``` This will also attempt to install the -[Microsoft Visual C++ Redistributable](/vcruntime) via `webi vcruntime`. If it -fails and you get the error _`vcruntime140.dll` was not found_, you'll need to -[install it manually](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170). +[Microsoft Visual C++ Redistributable](../vcruntime/) via `webi vcruntime`. If +it fails and you get the error _`vcruntime140.dll` was not found_, you'll need +to [install it manually](msvc-learn). + +[msvc-learn]: + https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170 ## Cheat Sheet @@ -63,15 +66,22 @@ Use the `fix` subcommand. dotenv-linter fix ``` -Backup files in the format of `.env_0000000000` will be created by default. You -can use `--no-backup` to skip this. +Backup files in the format of `.env_0000000000` will be created by default. \ +You can use `--no-backup` to skip this. -### How to compare two files +### How to compare keys between environements Use the `compare` subcommand ```sh -dotenv-linter compare .env1 .env2 +dotenv-linter compare ./my-dev.env ./my-prod.env +``` + +```text +Comparing my-dev.env +Comparing my-prod.env +my-dev.env is missing keys: FOO_API_TOKEN +my-prod.env is missing keys: BAR_ID, BAR_SECRET ``` ### How to toggle linter rules