psf / psf/black

Represent links to bad linecodes as clickable links (like flake8 does)

Open
#2,811 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

S: needs discussion T: enhancement
Dominant language
Python
Stars
41.8k
Forks
2.9k
Avg merge
5d 6h
Merged PRs (30d)
9

Description

Hi,
we use black in our CI in pre-commit with --check and --diff options

If there are bad from black point of view lines it report them like something like
...
would reformat source\models\customer.py
Oh no! \U0001f4a5 \U0001f494 \U0001f4a5
1 file would be reformatted.
flake8...................................................................Failed
...
I suggest to make source\models\customer.py linkable to have an ability to walk to this file in one click. Flake8 works this way and this is much more convenient.

Additional enhancement if use links instead of raw text is to visually mark bad files if more then one file reported by black (it is hard to find them now in our usage case)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating Black's reporting code for files reformatted during --check and --diff, then compare its output with the clickable file links produced by flake8. Verify the behavior using the pre-commit-style command described in the issue, including multiple bad files; done means reported paths are clickable and clearly distinguish each affected file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.