From 3c1c9ce6636c48229b03285ba511d5db1a8f67e7 Mon Sep 17 00:00:00 2001 From: hasundue Date: Fri, 2 Aug 2024 19:27:28 +0900 Subject: [PATCH] docs(cli): inform `--changelog` requires `--unstable-kv` --- cli/README.md | 30 ++++++++++++++---------------- cli/main.ts | 2 +- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/cli/README.md b/cli/README.md index 0188c3a3..60903240 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,5 +1,3 @@ -# @molt/cli - ## Installation (optional) The molt CLI can be installed globally with the following command, for example: @@ -32,20 +30,20 @@ Description: Options: - -h, --help - Show this help. - -v, --version - Print version info. - -w, --write - Write changes to the local files. (Conflicts: --commit) - -c, --commit - Commit changes to the local git repository. (Conflicts: --write) - --changelog [types] - Print a curated changelog for each update. - --config - Specify the Deno configuration file. - --dry-run - See what would happen without actually doing it. - --ignore - Specify dependencies to ignore. - --only - Specify dependencies to check. - --lock - Specify the lock file. - --no-config - Disable automatic loading of the configuration file. - --no-lock - Disable automatic loading of the lock file. - --pre-commit - Run tasks before each commit (Depends: --commit) - --prefix - Prefix for commit messages (Depends: --commit) + -h, --help - Show this help. + -v, --version - Print version info. + -w, --write - Write changes to the local files. (Conflicts: --commit) + -c, --commit - Commit changes to the local git repository. (Conflicts: --write) + --changelog [types] - Print commits for each update. (requires --unstable-kv) + --config - Specify the Deno configuration file. + --dry-run - See what would happen without actually doing it. + --ignore - Specify dependencies to ignore. + --only - Specify dependencies to check. + --lock - Specify the lock file. + --no-config - Disable automatic loading of the configuration file. + --no-lock - Disable automatic loading of the lock file. + --pre-commit - Run tasks before each commit (Depends: --commit) + --prefix - Prefix for commit messages (Depends: --commit) --referrer - Print files that import the dependency. ``` diff --git a/cli/main.ts b/cli/main.ts index ca2cbb27..85558c7c 100644 --- a/cli/main.ts +++ b/cli/main.ts @@ -20,7 +20,7 @@ const main = new Command() }) .option( "--changelog=[types:string[]]", - "Print a curated changelog for each update.", + "Print commits for each update. (requires --unstable-kv)", ) .option("--config ", "Specify the Deno configuration file.") .option("--dry-run", "See what would happen without actually doing it.")