github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-25 18:03:37 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
798d7427f7
fish-shell/doc_src/cmds/string-pad.rst

61 lines
1.7 KiB
ReStructuredText
Raw Normal View History

string pad: handle padding characters of width > 1 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.
2020-09-28 03:51:20 +08:00
string-pad - pad strings to a fixed width
=========================================
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
Synopsis
--------
.. BEGIN SYNOPSIS
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 22:09:46 +08:00
.. synopsis::
string pad [-r | --right] [(-c | --char) CHAR] [(-w | --width) INTEGER]
[STRING ...]
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
.. END SYNOPSIS
Description
-----------
.. BEGIN DESCRIPTION
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 22:22:00 +08:00
``string pad`` extends each *STRING* to the given visible width by adding *CHAR* to the left. That means the width of all visible characters added together, excluding escape sequences and accounting for :envvar:`fish_emoji_width` and :envvar:`fish_ambiguous_width`. It is the amount of columns in a terminal the *STRING* occupies.
docs
2021-07-31 02:04:38 +08:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 22:22:00 +08:00
The escape sequences reflect what fish knows about, and how it computes its output. Your terminal might support more escapes, or not support escape sequences that fish knows about.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 22:22:00 +08:00
If **-r** or **--right** is given, add the padding after a string.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 22:22:00 +08:00
If **-c** or **--char** is given, pad with *CHAR* instead of whitespace.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string docs: format options and arguments in line with other pages There are a number of items which don't fit cleanly into the styles used in the synopses, and have been left alone.
2022-03-12 22:22:00 +08:00
The output is padded to the maximum width of all input strings. If **-w** or **--width** is given, use at least that.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
.. END DESCRIPTION
Examples
--------
.. BEGIN EXAMPLES
::
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
>_ string pad -w 10 abc abcdef
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
abc
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
abcdef
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string pad: handle padding characters of width > 1 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.
2020-09-28 03:51:20 +08:00
>_ string pad --right --char=🐟 "fish are pretty" "rich. "
fish are pretty
rich. 🐟🐟🐟🐟
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
>_ string pad -w$COLUMNS (date)
# Prints the current time on the right edge of the screen.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-21 04:17:08 +08:00
.. END EXAMPLES
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
See Also
--------
docs/string: Separate "pad" and "shorten" This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
2023-04-21 04:17:08 +08:00
.. BEGIN SEEALSO
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- The :doc:`printf <printf>` command can do simple padding, for example ``printf %10s\n`` works like ``string pad -w10``.
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
2022-09-24 01:57:49 +08:00
- :doc:`string length <string-length>` with the ``--visible`` option can be used to show what fish thinks the width is.
Reference in New Issue Copy Permalink