chore(pre-commit): linting

anaconda · May 10, 2024 · b3a1acf · b3a1acf
1 parent 494ed90
commit b3a1acf
Showing 1 changed file with 52 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -40,19 +40,49 @@ from generate_cli_output import main
 main(command="generate-renovate-annotations --help")
 ]]] -->
 ```shell
-Usage: generate-renovate-annotations [OPTIONS] ENV_FILES...
-
-╭─ Arguments ──────────────────────────────────────────────────────────────────╮
-│ *    env_files      ENV_FILES...  [default: None] [required]                 │
-╰──────────────────────────────────────────────────────────────────────────────╯
-╭─ Options ────────────────────────────────────────────────────────────────────╮
-│ --internal-pip-package                TEXT  [default: None]                  │
-│ --internal-pip-index-url              TEXT                                   │
-│ --create-command                      TEXT  [default: make setup]            │
-│ --environment-selector                TEXT  [default: -p ./env]              │
-│ --disable-environment-creation                                               │
-│ --help                                      Show this message and exit.      │
-╰──────────────────────────────────────────────────────────────────────────────╯
+[1m                                                                                [0m
+[1m [0m[1;33mUsage: [0m[1mgenerate-renovate-annotations [OPTIONS] ENV_FILES... COMMAND [ARGS]...[0m[1m [0m[1m [0m
+[1m                                                                                [0m
+ Generate Renovate comments for a list of [1;36;40mconda[0m environment files.
+ [2mFor each file, we:[0m
+
+ [1;33m • [0m[2mRun a command to ensure the environment is created/updated[0m[2m                 [0m
+ [1;33m • [0m[2mExtract a list of installed packages in that environment, including pip[0m[2m    [0m
+ [1;33m • [0m[2mGenerate a Renovate annotation comment, including the package name and [0m[2m    [0m
+ [1;33m   [0m[2mchannel.[0m[2m [0m[2mThis step also allows for overriding the index of pip packages.[0m[2m   [0m
+ [1;33m • [0m[2mPin the exact installed version of each dependency.[0m[2m                        [0m
+
+[2m╭─[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
+[2m│[0m [31m*[0m    env_files      [1;33mENV_FILES...[0m  A list of conda environment files,         [2m│[0m
+[2m│[0m                                   typically passed in from pre-commit        [2m│[0m
+[2m│[0m                                   automatically                              [2m│[0m
+[2m│[0m                                   [2m[default: None]                           [0m [2m│[0m
+[2m│[0m                                   [2;31m[required]                                [0m [2m│[0m
+[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
+[2m╭─[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
+[2m│[0m [1;36m-[0m[1;36m-internal[0m[1;36m-pip-package[0m                [1;33mTEXT[0m  One or more packages to pull     [2m│[0m
+[2m│[0m                                             from the                         [2m│[0m
+[2m│[0m                                             --internal-pip-index-url         [2m│[0m
+[2m│[0m                                             [2m[default: None]                 [0m [2m│[0m
+[2m│[0m [1;36m-[0m[1;36m-internal[0m[1;36m-pip-index-url[0m              [1;33mTEXT[0m  An optional extra pip index URL, [2m│[0m
+[2m│[0m                                             used in conjunction with the     [2m│[0m
+[2m│[0m                                             --internal-pip-package option    [2m│[0m
+[2m│[0m [1;36m-[0m[1;36m-create[0m[1;36m-command[0m                      [1;33mTEXT[0m  A command to invoke at each      [2m│[0m
+[2m│[0m                                             parent directory of all          [2m│[0m
+[2m│[0m                                             environment files to ensure the  [2m│[0m
+[2m│[0m                                             conda environment is created and [2m│[0m
+[2m│[0m                                             updated                          [2m│[0m
+[2m│[0m                                             [2m[default: make setup]           [0m [2m│[0m
+[2m│[0m [1;36m-[0m[1;36m-environment[0m[1;36m-selector[0m                [1;33mTEXT[0m  A string used to select the      [2m│[0m
+[2m│[0m                                             conda environment, either        [2m│[0m
+[2m│[0m                                             prefix-based (recommended) or    [2m│[0m
+[2m│[0m                                             named                            [2m│[0m
+[2m│[0m                                             [2m[default: -p ./env]             [0m [2m│[0m
+[2m│[0m [1;36m-[0m[1;36m-disable[0m[1;36m-environment-creation[0m        [1;33m    [0m  If set, environment will not be  [2m│[0m
+[2m│[0m                                             created/updated before           [2m│[0m
+[2m│[0m                                             annotations are added.           [2m│[0m
+[2m│[0m [1;36m-[0m[1;36m-help[0m                                [1;33m    [0m  Show this message and exit.      [2m│[0m
+[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
 ```
 <!-- [[[end]]] -->
 
@@ -116,15 +146,15 @@ import os, sys; sys.path.insert(0, os.path.join(os.getcwd(), "dev"))
 from generate_makefile_targets_table import main; main()
 ]]] -->
 <!-- THE FOLLOWING CODE IS GENERATED BY COG VIA PRE-COMMIT. ANY MANUAL CHANGES WILL BE LOST. -->
-| Target          | Description                                         |
-|-----------------|-----------------------------------------------------|
-| `help`          | Display help on all Makefile targets                |
-| `setup`         | Setup local conda environment for development       |
-| `install-hooks` | Download + install all pre-commit hooks             |
-| `pre-commit`    | Run pre-commit against all files                    |
-| `type-check`    | Run static type checks                              |
-| `test`          | Run all the unit tests                              |
-| `cog-readme`    | Run cog on the README.md to generate command output |
+| Target          | Description                                                              |
+|-----------------|--------------------------------------------------------------------------|
+| `help`          | Display help on all Makefile targets                                     |
+| `setup`         | Setup local conda environment for development                            |
+| `install-hooks` | Download + install all pre-commit hooks                                  |
+| `pre-commit`    | Run pre-commit against all files                                         |
+| `type-check`    | Run static type checks                                                   |
+| `test`          | Run all the unit tests                                                   |
+| `cog-readme`    | Run cog on the README.md to generate command output                      |
 <!-- [[[end]]] -->
 
 > **Note:** Interestingly, the table above is generated by the `cog` hook defined in this repo :smile: