Skip to content

Commit dae1dae

Browse files
adamluiadamlui
committed
Added --debug mode to README
1 parent ffed94e commit dae1dae

2 files changed

Lines changed: 27 additions & 25 deletions

File tree

‎remove-json-keys/docs/README.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,17 @@ _Note: Key/values can span multiple lines and have any amount of whitespace betw
3939

4040
Options can be set by using command-line arguments:
4141

42-
| Option | Description | Example
43-
| ---------------------- | ------------------------------------------------------------------------------- | -----------------------------
44-
| `-d`, `--json-dir` | Name of the folder containing JSON files (default: `_locales`) | `--json-dir=data`
45-
| `-k`, `--keys` | Comma-separated list of keys to remove | `--keys=app_DESC,err_NOT_FOUND`
46-
| `--config` | Use custom config file | `--config=path/to/file`
47-
| `init`, `-i`, `--init` | Create .remove-json.config.json5 in project root to store default settings |
48-
| `-n`, `--no-wizard` | Skip interactive prompts during start-up |
49-
| `-h`, `--help` | Show help screen |
50-
| `-v`, `--version` | Show version |
51-
| `--docs` | Open docs URL |
42+
| Option | Description | Example
43+
| --------------------------------- | ------------------------------------------------------------------------------- | -----------------------------
44+
| `-d`, `--json-dir` | Name of the folder containing JSON files (default: `_locales`) | `--json-dir=data`
45+
| `-k`, `--keys` | Comma-separated list of keys to remove | `--keys=app_DESC,err_NOT_FOUND`
46+
| `--config` | Use custom config file | `--config=path/to/file`
47+
| `init`, `-i`, `--init` | Create .remove-json.config.json5 in project root to store default settings |
48+
| `-n`, `--no-wizard` | Skip interactive prompts during start-up |
49+
| `-h`, `--help` | Show help screen |
50+
| `-v`, `--version` | Show version |
51+
| `-V`, `--debug [targetConfigKey]` | Show debug logs |
52+
| `--docs` | Open docs URL |
5253

5354
## Examples
5455

‎translate-messages/docs/README.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,22 @@ _Note: Any messages.json in the [`chrome.i18n`](https://developer.chrome.com/doc
3939

4040
Options can be set by using command-line arguments:
4141

42-
| Option | Description | Example
43-
| ---------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------
44-
| `-d`, `--locales-dir` | Name of the folder containing locale files (default: `_locales`) | `--locales-dir=_messages`
45-
| `-t`, `--target-langs` | Comma-separated list of languages to translate to (default: all 100+ [`stable_locales`][stable-locales]) | `--target-langs=es,fr`
46-
| `-k`, `--keys` | Comma-separated list of keys to translate (default: all found src keys missing in target files) | `--keys=app_DESC,err_NOT_FOUND`
47-
| `--exclude-langs` | Comma-separated list of languages to exclude | `--exclude-langs=es,zh`
48-
| `--exclude-keys` | Comma-separated list of keys to ignore | `--exclude-keys=app_NAME,author`
49-
| `--only-stable` | Only use stable locales (skip auto-discovery) |
50-
| `--config` | Use custom config file | `--config=path/to/file`
51-
| `init`, `-i`, `--init` | Create `.translate-msgs.config.json5` in project root to store default options |
52-
| `-f`, `--force` | Force overwrite of existing config file when using `init` |
53-
| `-n`, `--no-wizard` | Skip interactive prompts during start-up |
54-
| `-h`, `--help` | Show help screen |
55-
| `-v`, `--version` | Show version |
56-
| `--docs` | Open docs URL |
42+
| Option | Description | Example
43+
| --------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------
44+
| `-d`, `--locales-dir` | Name of the folder containing locale files (default: `_locales`) | `--locales-dir=_messages`
45+
| `-t`, `--target-langs` | Comma-separated list of languages to translate to (default: all 100+ [`stable_locales`][stable-locales]) | `--target-langs=es,fr`
46+
| `-k`, `--keys` | Comma-separated list of keys to translate (default: all found src keys missing in target files) | `--keys=app_DESC,err_NOT_FOUND`
47+
| `--exclude-langs` | Comma-separated list of languages to exclude | `--exclude-langs=es,zh`
48+
| `--exclude-keys` | Comma-separated list of keys to ignore | `--exclude-keys=app_NAME,author`
49+
| `--only-stable` | Only use stable locales (skip auto-discovery) |
50+
| `--config` | Use custom config file | `--config=path/to/file`
51+
| `init`, `-i`, `--init` | Create `.translate-msgs.config.json5` in project root to store default options |
52+
| `-f`, `--force` | Force overwrite of existing config file when using `init` |
53+
| `-n`, `--no-wizard` | Skip interactive prompts during start-up |
54+
| `-h`, `--help` | Show help screen |
55+
| `-v`, `--version` | Show version |
56+
| `-V`, `--debug [targetConfigKey]` | Show debug logs |
57+
| `--docs` | Open docs URL |
5758

5859
## Examples
5960

0 commit comments

Comments
 (0)