Skip to content

CLI: Add missing pad and truncate output formatting functions #22384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2025
Merged

CLI: Add missing pad and truncate output formatting functions #22384

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
746372c
CLI: Add missing `pad` and `truncate` output formatting functions
stevenlele Apr 8, 2025
0733ffe
Apply suggestions from code review
usha-mandya Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/manuals/engine/cli/formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,26 @@
$ docker inspect --format "{{upper .Name}}" container
```

## pad

Check warning on line 93 in content/manuals/engine/cli/formatting.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingSentenceCase] Use sentence case for headings: 'pad'.

Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'pad'.", "location": {"path": "content/manuals/engine/cli/formatting.md", "range": {"start": {"line": 93, "column": 4}}}, "severity": "WARNING"}

`pad` adds whitespace padding to a string. You can specify the number of spaces to add before and after the string.

```console
$ docker image list --format '{{pad .Repository 5 10}}'
```

This example adds 5 spaces before the image repository name and 10 spaces after.

## truncate

`truncate` shortens a string to a specified length. If the string is shorter than the specified length, it remains unchanged.

```console
$ docker image list --format '{{truncate .Repository 15}}'
```

This example displays the image repository name, truncating it to the first 15 characters if it's longer.

## println

`println` prints each value on a new line.
Expand Down