Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. #353

akaihola · 2022-04-03T19:51:17Z

By default, highlighting is now enabled if outputting to a terminal and pygments is installed.

Highlighting can now be force enabled for non-terminal output or force disabled for terminal output using:

color = {true|false} in pyproject.toml,
the PY_COLORS={0|1} environment variables (overrides pyproject.toml), or
the --color/--no-color command line options (override both pyproject.toml and the environment variable)

Remaining tasks:

Document the new configuration options
Update command line help in documentation
Change log
Verify that this works for real in Try out Darker GitHub Action pgtricks#18
Install Pygments in the GitHub Action
Use --color by default in the GitHub Action
Allow installing Darker from a branch in the GitHub Action (to enable testing of feature branches)
Decide whether to include this in 1.5.0 with or without Add support for the NO_COLOR environment variable #355, or to postpone this for 1.5.1 (see discussion)

Fixes #263.

See also #355 as a follow-up issue (possible support for the NO_COLOR environment variable).

akaihola · 2022-04-05T19:24:22Z

It works in akaihola/pgtricks#18!

akaihola · 2022-04-05T19:40:54Z

@mayk0gan, good news, you can see syntax highlighting in action for Darker output in akaihola/pgtricks build #24 (see screenshot in earlier comment).

Could you review this pull request and approve it for merging if it looks good to you?

akaihola · 2022-04-09T19:41:17Z

Looking for a reviewer for this, pinging contributors previously interested in the GitHub Action:
@jenshnielsen @cclauss @brtknr @yoursvivek

roniemartinez

LGTM

README.rst

src/darker/tests/test_highlighting.py

MatthijsBurgh

I think we should allow true and false for color.

src/darker/config.py

src/darker/help.py

src/darker/highlighting/__init__.py

src/darker/tests/test_command_line.py

src/darker/tests/test_highlighting.py

The environment variable `PY_COLORS` overrides `color =` from `pyproject.toml`, and the command line options override both of those.

This helps in testing feature branches like this one in actual GitHub workflows of other repositories.

@roniemartinez

Thanks @roniemartinez Co-authored-by: Ronie Martinez <ronmarti18@gmail.com>

So lower case `true` and `false`.

If `pygments` isn't installed, highlighting should never be used. So these test cases can be easily parameterized as a test matrix. Also simplified the other half of `should_use_color()` tests a bit.

src/darker/highlighting/__init__.py

@MatthijsBurgh

Thanks @MatthijsBurgh! Co-authored-by: Matthijs van der Burgh <MatthijsBurgh@outlook.com>

akaihola added the enhancement New feature or request label Apr 3, 2022

akaihola added this to the 1.5.0 milestone Apr 3, 2022

akaihola requested a review from mayk0gan April 3, 2022 19:51

akaihola self-assigned this Apr 3, 2022

akaihola added this to In progress in Akaihola's Open source work via automation Apr 3, 2022

akaihola changed the title ~~Make force highlighting configurable~~ Allow user to force highlighting using config file, env var or command line Apr 4, 2022

akaihola force-pushed the force-colors branch from 45230b0 to 3d77739 Compare April 5, 2022 16:55

akaihola changed the title ~~Allow user to force highlighting using config file, env var or command line~~ Allow user to force highlighting using config file, env var or command line. Use in GitHub Action. Apr 5, 2022

akaihola changed the title ~~Allow user to force highlighting using config file, env var or command line. Use in GitHub Action.~~ Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. Apr 5, 2022

akaihola added help wanted Extra attention is needed review needed Please volunteer for code review to speed up merging this pull request. Thank you! labels Apr 6, 2022

akaihola force-pushed the force-colors branch from e59d663 to 1274232 Compare April 7, 2022 19:55

akaihola requested a review from MatthijsBurgh April 9, 2022 19:37

akaihola requested a review from roniemartinez April 9, 2022 19:41

roniemartinez approved these changes Apr 9, 2022

View reviewed changes

README.rst Outdated Show resolved Hide resolved

src/darker/tests/test_highlighting.py Show resolved Hide resolved

Akaihola's Open source work automation moved this from In progress to Reviewer approved Apr 9, 2022

MatthijsBurgh requested changes Apr 10, 2022

View reviewed changes

Akaihola's Open source work automation moved this from Reviewer approved to Review in progress Apr 10, 2022

akaihola mentioned this pull request Apr 10, 2022

Add support for the NO_COLOR environment variable #355

Closed

akaihola added 8 commits April 10, 2022 10:11

Add --color/--no-color and PY_COLORS=

5775f2b

The environment variable `PY_COLORS` overrides `color =` from `pyproject.toml`, and the command line options override both of those.

Improve option descriptions in --help

4eb1966

Fix --options-for-readme for recent Pythons

20a84ce

Update --help output in README

92b0691

Update change log

fe48b2a

Document highlighting config in README

d1453a8

Allow Darker branch in GitHub Action

ea66e0a

This helps in testing feature branches like this one in actual GitHub workflows of other repositories.

Add the darker[color] extra install option

a763899

akaihola and others added 10 commits April 10, 2022 13:11

Install Pygments in GitHub action

30f3044

Syntax highlighting in GitHub Action by default

8355788

Update change log

9ff34e4

Fix highlighting tests, Pygments>=2.4.0

bf8a1d3

Update tests for GitHub Action

d3a6e5d

Black formatting in test module

52d151a

Simplify English in README a bit

53057fd

Thanks @roniemartinez Co-authored-by: Ronie Martinez <ronmarti18@gmail.com>

Spell true/false in test case as in pyproject.toml

e78793c

So lower case `true` and `false`.

Matrix parameterize color test without pygments

ff80559

If `pygments` isn't installed, highlighting should never be used. So these test cases can be easily parameterized as a test matrix. Also simplified the other half of `should_use_color()` tests a bit.

Fix typing in test

2200bdd

akaihola force-pushed the force-colors branch from f38e5e2 to 2200bdd Compare April 10, 2022 10:12

MatthijsBurgh reviewed Apr 10, 2022

View reviewed changes

src/darker/highlighting/__init__.py Outdated Show resolved Hide resolved

Add blank line to clarify highlighting usage logic

a39b339

Thanks @MatthijsBurgh! Co-authored-by: Matthijs van der Burgh <MatthijsBurgh@outlook.com>

akaihola mentioned this pull request Apr 10, 2022

Support the NO_COLOR environment variable #356

Merged

7 tasks

akaihola merged commit ad6cde1 into master Apr 10, 2022

Akaihola's Open source work automation moved this from Review in progress to Done Apr 10, 2022

akaihola deleted the force-colors branch April 10, 2022 12:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. #353

Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. #353

akaihola commented Apr 3, 2022 •

edited

akaihola commented Apr 5, 2022

akaihola commented Apr 5, 2022

akaihola commented Apr 9, 2022

roniemartinez left a comment

MatthijsBurgh left a comment

Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. #353

Allow user to force syntax highlighting using config file, env var or command line. Enable syntax highlighting in GitHub Action. #353

Conversation

akaihola commented Apr 3, 2022 • edited

akaihola commented Apr 5, 2022

akaihola commented Apr 5, 2022

akaihola commented Apr 9, 2022

roniemartinez left a comment

Choose a reason for hiding this comment

MatthijsBurgh left a comment

Choose a reason for hiding this comment

akaihola commented Apr 3, 2022 •

edited