From f8910ae232ecc9c0e47122126e37d74c4a2b7a1a Mon Sep 17 00:00:00 2001 From: Shuhei Aoyama Date: Sun, 17 Mar 2024 20:43:32 +0900 Subject: [PATCH] docs: add config option to README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 51b6bbf..efecb97 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,12 @@ Option for [`workspace` option](https://docs.npmjs.com/cli/v8/commands/npm-query Specify which package manager to use `npm` or `pnpm`. Automatically detected if you are running the command with `npm run`, `npx`, or `pnpm run`. +#### `-c`, `--config` + +**default: (./license-manager.config.js)** + +Config file path. + ### Options for `analyze` command #### `-l`, `--allowLicense` @@ -132,6 +138,7 @@ Based on the results of npm query, and some fields be added. You can write all settings to `license-manager.config.js`. If `license-manager.config.js` exists in the current directory, it is automatically loaded. +You can change the file path with the --config option. CLI options take precedence, but license and package specifications are merged. And you can also specify a override function in case the license and license text cannot be detected.