h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-30 11:21:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

string pad: handle padding characters of width > 1

Browse Source 
If the padding is not divisible by the char's width without remainder,
we pad the remainder with spaces, so the total width of the output is correct.

Also add completions, changelog entry, adjust documentation, add examples
with emoji and some tests.  Apply some minor style nitpicks and avoid extra
allocations of the input strings.
This commit is contained in:
Johannes Altmanninger
2020-09-27 21:51:20 +02:00
parent 5ae03414d7
commit f758d39535
5 changed files with 66 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc_src/cmds/string-pad.rst
View File

@@ -1,5 +1,5 @@
string-pad - pad characters before and after string
===================================================
string-pad - pad strings to a fixed width
=========================================
Synopsis
--------
@@ -17,15 +17,13 @@ Description
.. BEGIN DESCRIPTION
``string pad`` pads each STRING with CHAR to the given width.
``string pad`` extends each STRING to the given width by adding CHAR to the left.
The default behavior is left padding with spaces and default width is the length of string (hence, no padding).
If ``-r`` or ``--right`` is given, add the padding after a string.
If ``-r`` or ``--right`` is given, only pad after string.
If ``-c`` or ``--char`` is given, pad with CHAR instead of whitespace.
The ``-c`` or ``--char`` switch causes padding with the character CHAR instead of default whitespace character.
If ``-w`` or ``--width`` is given, pad the string to given width. Width less than the string width will result in an unchanged string.
The output is padded to the maximum width of all input strings. If ``-w`` or ``--width`` is given, use at least that.
.. END DESCRIPTION
@@ -36,15 +34,17 @@ Examples
::
>_ string pad -w 10 -c ' ' 'abc'
>_ string pad -w 10 abc
abc
>_ string pad --right --width 12 --char=z foo barbaz
foozzzzzzzzz
barbazzzzzzz
>_ string pad --right --char=🐟 "fish are pretty" "rich. "
fish are pretty
rich. 🐟🐟🐟🐟
>_ string pad -w 6 --char=- foo | string pad --right -w 9 --char=-
---foo---
>_ string pad -w 6 -c- " | " "|||" " | " | string pad -r -w 9 -c-
--- | ---
---|||---
--- | ---
.. END EXAMPLES