Todo-list

Todo

Should we switch to --color=<auto|never|always> as GNU tools does?

Also see how the isatty property defaults with this option, and how it can be implemented in Python.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.colorize.ColorOption, line 7.)

Todo

Support the TERM environment variable convention?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.colorize.ColorOption, line 16.)

Todo

Propose addition of meta keyword upstream to Click.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.commands.ExtraContext, line 7.)

Todo

Pretty print JSON output (easier to read in bug reports)?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.version.ExtraVersionOption.print_debug_message, line 3.)

Todo

Tweak colors to make them more readable.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.colorize.HelpExtraTheme.light, line 3.)

Todo

Allow passing extra parameters to the self.lazy_subcommands so we can registered commands with custom settings like Cloup’s section or fallback_to_default_section:

• section: Optional[Section] = None,

• fallback_to_default_section: bool = True,

See: https://github.com/janluke/cloup/blob/master/cloup/_sections.py#L169

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.commands.LazyGroup.get_command, line 3.)

Todo

Evaluates the possibility of replacing all key-based access to the tree-like structure by a Box object, as it provides lots of utilities to merge its content.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/__init__.py:docstring of click_extra.parameters.ParamStructure, line 8.)

Todo

Maybe this shouldn’t be in Click Extra because it is a legacy inheritance from one of my other project.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of cloup._util.identity, line 7.)

Todo

Tweak colors to make them more readable.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.HelpExtraTheme.light, line 3.)

Todo

Should we switch to --color=<auto|never|always> as GNU tools does?

Also see how the isatty property defaults with this option, and how it can be implemented in Python.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.ColorOption, line 7.)

Todo

Support the TERM environment variable convention?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.ColorOption, line 16.)

Todo

Support case-foldeing, so we can have the Straße string matching the Strasse content.

This could be tricky as it messes with string length and characters index, which our logic relies on.

Danger

Danger

Roundtrip through lower-casing/upper-casing is a can of worms, because some characters change length when their case is changed:

• Unicode roundtrip-unsafe characters

• Unicode codepoints expanding or contracting on case changes

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.highlight, line 6.)

Todo

Propose addition of meta keyword upstream to Click.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.ExtraContext, line 7.)

Todo

For bullet-proof handling of edge-cases, we should probably add an indirection layer to have the processing order of options (the one below) different from the presentation order of options in the help screen.

This is probably something that has been requested in issue #544.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.default_extra_params, line 47.)

Todo

Allow passing extra parameters to the self.lazy_subcommands so we can registered commands with custom settings like Cloup’s section or fallback_to_default_section:

• section: Optional[Section] = None,

• fallback_to_default_section: bool = True,

See: https://github.com/janluke/cloup/blob/master/cloup/_sections.py#L169

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.LazyGroup.get_command, line 3.)

Todo

Add a --dump-config or --export-config option to write down the current configuration (or a template) into a file or <stdout>.

Help message would be: you can use this option with other options or environment variables to have them set in the generated configuration.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 3.)

Todo

Allow the --config option to walk-up the filesystem (up until the filesystem root) to discover configuration files. See: https://github.com/kdeldycke/click-extra/issues/651

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 10.)

Todo

Add a ParameterSource.CONFIG_FILE entry to the ParameterSource enum? Also see: https://github.com/pallets/click/issues/2879

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 15.)

Todo

Add support for JWCC / hujson format?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config.Formats, line 10.)

Todo

Evaluates the possibility of replacing all key-based access to the tree-like structure by a Box object, as it provides lots of utilities to merge its content.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/parameters.py:docstring of click_extra.parameters.ParamStructure, line 8.)

Todo

Allow multiple token_type to be configured for colorization (if traditions are changed on Pygments’ side).

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/pygments.py:docstring of click_extra.pygments.AnsiFilter, line 7.)

Todo

Pretty print JSON output (easier to read in bug reports)?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/version.py:docstring of click_extra.version.ExtraVersionOption.print_debug_message, line 3.)

Todo

Write examples and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/colorize.md, line 29.)

Todo

Write examples and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/colorize.md, line 49.)

Todo

Write examples and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/colorize.md, line 55.)

Todo

Maybe this shouldn’t be in Click Extra because it is a legacy inheritance from one of my other project.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of cloup._util.identity, line 7.)

Todo

Tweak colors to make them more readable.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.HelpExtraTheme.light, line 3.)

Todo

Should we switch to --color=<auto|never|always> as GNU tools does?

Also see how the isatty property defaults with this option, and how it can be implemented in Python.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.ColorOption, line 7.)

Todo

Support the TERM environment variable convention?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.ColorOption, line 16.)

Todo

Support case-foldeing, so we can have the Straße string matching the Strasse content.

This could be tricky as it messes with string length and characters index, which our logic relies on.

Danger

Danger

Roundtrip through lower-casing/upper-casing is a can of worms, because some characters change length when their case is changed:

• Unicode roundtrip-unsafe characters

• Unicode codepoints expanding or contracting on case changes

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/colorize.py:docstring of click_extra.colorize.highlight, line 6.)

Todo

Propose addition of meta keyword upstream to Click.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.ExtraContext, line 7.)

Todo

For bullet-proof handling of edge-cases, we should probably add an indirection layer to have the processing order of options (the one below) different from the presentation order of options in the help screen.

This is probably something that has been requested in issue #544.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.default_extra_params, line 47.)

Todo

Allow passing extra parameters to the self.lazy_subcommands so we can registered commands with custom settings like Cloup’s section or fallback_to_default_section:

• section: Optional[Section] = None,

• fallback_to_default_section: bool = True,

See: https://github.com/janluke/cloup/blob/master/cloup/_sections.py#L169

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/commands.py:docstring of click_extra.commands.LazyGroup.get_command, line 3.)

Todo

Write example.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/config.md, line 333.)

Todo

Write example.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/config.md, line 343.)

Todo

Write example.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/config.md, line 353.)

Todo

Write example.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/config.md, line 361.)

Todo

Write example.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/config.md, line 371.)

Todo

Add a --dump-config or --export-config option to write down the current configuration (or a template) into a file or <stdout>.

Help message would be: you can use this option with other options or environment variables to have them set in the generated configuration.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 3.)

Todo

Allow the --config option to walk-up the filesystem (up until the filesystem root) to discover configuration files. See: https://github.com/kdeldycke/click-extra/issues/651

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 10.)

Todo

Add a ParameterSource.CONFIG_FILE entry to the ParameterSource enum? Also see: https://github.com/pallets/click/issues/2879

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config, line 15.)

Todo

Add support for JWCC / hujson format?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/config.py:docstring of click_extra.config.Formats, line 10.)

Todo

Propose the raw_args feature upstream to Click.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/parameters.md, line 105.)

Todo

Write example and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/parameters.md, line 135.)

Todo

Evaluates the possibility of replacing all key-based access to the tree-like structure by a Box object, as it provides lots of utilities to merge its content.

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/parameters.py:docstring of click_extra.parameters.ParamStructure, line 8.)

Todo

Write example and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/pygments.md, line 215.)

Todo

Allow multiple token_type to be configured for colorization (if traditions are changed on Pygments’ side).

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/pygments.py:docstring of click_extra.pygments.AnsiFilter, line 7.)

Todo

Write example and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/pytest.md, line 13.)

Todo

Write example and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/pytest.md, line 19.)

Todo

Explain extra parameters supported by print_table() for each category of formats.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/table.md, line 128.)

Todo

Write example and tutorial.

(The original entry is located in /home/runner/work/click-extra/click-extra/docs/testing.md, line 3.)

Todo

Pretty print JSON output (easier to read in bug reports)?

(The original entry is located in /home/runner/work/click-extra/click-extra/click_extra/version.py:docstring of click_extra.version.ExtraVersionOption.print_debug_message, line 3.)