Browser and install GUI for cookiecutter templates

βŒˆβŒ‹ βŽ‡ branch:  cookiedough


Artifact [156a7174cd]

Artifact 156a7174cd93a62d1a7543828f4c37a5edcb52902eaf33c1669f07259e286a93:

Wiki page [settings] by mario 2021-03-22 06:16:24.
D 2021-03-22T06:16:24.814
L settings
N text/x-markdown
U mario
W 3326

Use →File→Settings to access the cookiedough options menu.

 * Options are grouped by modules there.
 * Some may only take effect after a restart (e.g. hook_prompt).
 * Stored in ~/.config/cookiedough/settings.json.
 * There is no plugin handling in CD, so ticking the modules has no effect.


## Options

| name          | description                                                    |
|---------------|----------------------------------------------------------------|
| colorize      | Colorize the readme preview a bit                              |
| sort          | Primary scoring/sorting property                               |
| show_counts   | Show number of entries per language/api category               |
| editor        | Text editor (only used for cookiecutters config editing)       |
| no_params     | Don't prompt for template vars. Use terminal prompts instead.  |
| update_ccjson | Update parameters from cookiecutter.json files                 |
| hook_prompt   | Display any additional prompts as GUI inputs                   |


### Sort

 Influences how templates are listed in the left pane. Normally they're
 ordered by "all" (a virtual score). But there's more fields internally:

| name          |avg/weight| description                                                    |
|---------------|----------------------------------------------------------------|
| all           | = 5.0   | cumulative weighted score                            |
| -             | -       | -                                                    |
| size          | 64      | overall size of repository (in kb)                   |
| stars         | 20      | project watchers/stars                               |
| forks         | 5       | number of github forsk                               |
| tickets       | 10      | number of open tickets in repo                       |
| vars          | raw     | number of templating variables                       |
| files         | 32      | number of templating variables                       |
| readme        | 2048    | length of README                                     |
| lang          | -1      | non-english text                                     |
| age           | 9 months| age of last release                                  |
| -             | -       | -                                                    |
| bonus         | +2.5    | tree listing, keywords, curated, descriptions        |
| curated       | +0.8    | previously listed in CC README                       |
| keywords      | +0.5    | has a _keywords field                                |
| descriptions  | +1.25   | contains field descriptions in README                |
| score.find    | +0.5*1  | additional content/filenames to reward               |


Note that alphabetically sorting works best with the "short" project name,
while the "name" represents the vnd/pkg title, so won't look very sorted at
first.

Not all fields are selectable in the config window.


### no_params / hook_prompt

Enabling **no_params** will avoid the input window when rolling out a
teplate.

If disabled, **hook_prompt** will keep input fields pop up as GUI windows.
Else you would get CLI prompts from cookiecutter directly.


Z 8e70daf2152ac5f87a6070ae413ba34f