nushell/crates
Darren Schroeder 00601f1835
A fill command to replace str lpad and str rpad (#7846)
# Description

The point of this command is to allow you to be able to format ints,
floats, filesizes, and strings with an alignment, padding, and a fill
character, as strings. It's meant to take the place of `str lpad` and
`str rpad`.

```
> help fill
Fill and Align

Search terms: display, render, format, pad, align

Usage:
  > fill {flags}

Flags:
  -h, --help - Display the help message for this command
  -w, --width <Int> - The width of the output. Defaults to 1
  -a, --alignment <String> - The alignment of the output. Defaults to Left (Left(l), Right(r), Center(c/m), MiddleRight(cr/mr))
  -c, --character <String> - The character to fill with. Defaults to ' ' (space)

Signatures:
  <number> | fill -> <string>
  <string> | fill -> <string>

Examples:
  Fill a string on the left side to a width of 15 with the character '─'
  > 'nushell' | fill -a l -c '─' -w 15

  Fill a string on the right side to a width of 15 with the character '─'
  > 'nushell' | fill -a r -c '─' -w 15

  Fill a string on both sides to a width of 15 with the character '─'
  > 'nushell' | fill -a m -c '─' -w 15

  Fill a number on the left side to a width of 5 with the character '0'
  > 1 | fill --alignment right --character 0 --width 5

  Fill a filesize on the left side to a width of 5 with the character '0'
  > 1kib | fill --alignment middle --character 0 --width 10
```

![image](https://user-images.githubusercontent.com/343840/214133752-6fc93fa7-4003-4eb4-96ed-cd967312e244.png)

# User-Facing Changes

Deprecated `str lpad` and `str rpad`.

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-02-09 14:56:52 -06:00
..
nu_plugin_custom_values Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu_plugin_example Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu_plugin_gstat Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu_plugin_inc Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu_plugin_python Fix typos by codespell (#7600) 2022-12-26 02:31:26 -05:00
nu_plugin_query Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu-cli fix completions PATH vs Path (#8003) 2023-02-08 20:53:46 -06:00
nu-color-config Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-command A fill command to replace str lpad and str rpad (#7846) 2023-02-09 14:56:52 -06:00
nu-engine Fix $nu path separators on Windows (#7996) 2023-02-07 11:50:39 -08:00
nu-explore Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-glob Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-json Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-parser Make ++ operator work with strings and binary values (#8017) 2023-02-10 07:52:10 +13:00
nu-path Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-plugin Make plugin commands support examples. (#7984) 2023-02-08 16:14:18 -06:00
nu-pretty-hex Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-protocol explain command (#7957) 2023-02-09 13:59:38 -06:00
nu-system Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-table Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-term-grid Bump to 0.75.1 development version (#7930) 2023-01-31 23:55:29 +01:00
nu-test-support Fix: dst error on cp command (#7895) 2023-02-01 21:48:21 +01:00
nu-utils Clarify two config fields (#7969) 2023-02-06 00:01:23 +01:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.