Proposal: Fix for multilines and composite scripts listing

[noirbizarre]

Pull Request Check List

• A news fragment is added in news/ describing what is new.
• Test cases added for changed code.

Describe what you have changed in this PR.

While the current script listing is working fine when your command are short one-liners, it was broken for multilines scripts on main (where this PR was initially implemented).
Now that dev switched on a rich table display, I'm not sure whether it is improvement or not so I submit it anyway,

This PR improvement proposal was to merge the Script and Description column into a single Description column displaying the help if available and if not:

• display the sequence of calls for composite
• display the first line of script with a ⮨ ellipsis if it has been truncated

Also, the list is now sorted.

Example

Here the same output for main, dev and this PR for this given tool.pdm.scripts:

[tool.pdm.scripts]
all = {composite = ["format", "lint", "cover"]}
test = "pytest better/ tests/"
format = { shell = """\
isort better/
black better/
""" }
doc = "sphinx-build docs docs/_build/html"
"doc:watch" = "sphinx-autobuild docs docs/_build/html"

[tool.pdm.scripts.lint]
shell = """\
  echo "Flakes"
  flake8 better
  echo "isort"
  isort --check better
  echo "black"
  black --check better
  echo "MyPy"
  mypy better
"""

[tool.pdm.scripts.cover]
help = "Run tests with coverage"
cmd = """
pytest
  --cov-report=term
  --cov=better
  --cov-report=html:reports/coverage
  --cov-report=xml:reports/coverage.xml
  --junitxml=reports/tests.xml
"""

Main

Note: the composite task has been removed to be able to run the command

Dev

Proposal

[frostming]

The ⮨ ellipsis doesn't look good on my machine(M1 Mac with WezTerm, Rec Mono). It doesn't even render on Chrome.

Better to choose another character.

[noirbizarre]

Ok then let's change that. It was ⮨, here a list of alternatives (so you can test it and validate it is working before i update the PR) I see:

1. The classical ellipsis: …
2. Same arrow but thinner: ↵
3. Same but a bit curvier: ⤶
4. The fat one: ⮰

Or if you have any other suggestion or preference.
I can render the porposal with each to choose if you want.

[frostming]

I prefer the classical ellipsis and fallback to three dots ... on Windows cmd. 😞

I have to say this is a great UI improvement, well done @noirbizarre

[noirbizarre]

Updated with a classical ellipsis and a fallback on 3 dots for legacy windows terminals.

@frostming it's why I love open-source: you find an awesome tool, open source gives you the opportunity to make more awesome to you by contributing. Given I'm a full time developer, and Python packaging have been so painful those last year, I'm glad PDM exists solving my main Python irritation point and I even more glad to contribute to make it more awesome !!! (And BTW, I apologize in advance because I know I will be flooding this repository with pull requests for some time)

[frostming]

(And BTW, I apologize in advance because I know I will be flooding this repository with pull requests for some time)

Oh great, what big would you like to propose? BTW, would you like an alpha release or are you using the dev version already?

[noirbizarre]

And it's updated 👍🏼

An alpha release would be great (I can use the dev version but I prefer a released version, easier issue tracking)

Between others, I'd like to submit PRs for:

• yarn-like root script (in progress): make scripts available as root cmd as long as they don't conflict with an existing one (aka. the test script should be available as pdm test
• a bit of documentation about possible usages with direnv, writing plugins...
• some plugins idea:
  • pdm-create: bootstrap projects using templates (like cookie-cutter or copier but builtin, same as yarn create, should bring more value than a simple pdm new = mkdir + cd + pdm init
  • pdm-releaser: like go-releaser but for and based on pdm
  • pdm-vscode: create/update vscode workspace/directory settings automatically
  • pdm-watch: define some glob pattern to watch and the scripts to run on change in your pyproject.toml (basically format,
    lint and test on change)
• and contribute on the remaining tasks on the path to 2.0 (edtiables management, XDG dirs...)

I don't know in which order and when, yarn-like root scripts is already started so it might be the next one but after that I think I will help for the 2.0 critical path, plugins can wait

[frostming]

and contribute on the remaining tasks on the path to 2.0 (editables management, XDG dirs...)

I've updated the meta issue #743 about the remaining tasks, FYI edtiable management has been finished.

[noirbizarre]

OK, I'll do the XDG/standard dirs as soon as I fnished with Yarn-like root scripts then

[codecov-commenter]

Codecov Report

Merging #1151 (ec041d8) into dev (aa8e650) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              dev    #1151      +/-   ##
==========================================
+ Coverage   84.44%   84.49%   +0.05%     
==========================================
  Files          80       80              
  Lines        7089     7100      +11     
  Branches     1684     1687       +3     
==========================================
+ Hits         5986     5999      +13     
+ Misses        736      735       -1     
+ Partials      367      366       -1     

Flag	Coverage Δ
unittests	84.26% <100.00%> (+0.05%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pdm/cli/commands/run.py	91.17% <100.00%> (+0.31%)	⬆️
pdm/termui.py	89.23% <100.00%> (+0.34%)	⬆️
pdm/cli/actions.py	79.55% <0.00%> (+0.49%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa8e650...ec041d8. Read the comment docs.