mirror of
https://github.com/nushell/nushell.git
synced 2025-05-01 00:24:29 +02:00
926b0407c5
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> This PR seeks to generalize the `seq date` command so that it can receive any duration as an `--increment`. Whereas the current command can only output a list of dates spaced at least 1 day apart, the new command can output a list of datetimes that are spaced apart by any duration. For example: ``` > seq date --begin-date 2025-01-01 --end-date 2025-01-02 --increment 6hr --output-format "%Y-%m-%d %H:%M:%S" ╭───┬─────────────────────╮ │ 0 │ 2025-01-01 00:00:00 │ │ 1 │ 2025-01-01 06:00:00 │ │ 2 │ 2025-01-01 12:00:00 │ │ 3 │ 2025-01-01 18:00:00 │ │ 4 │ 2025-01-02 00:00:00 │ ╰───┴─────────────────────╯ ``` Note that the default behavior remains unchanged: ``` > seq date --begin-date 2025-01-01 --end-date 2025-01-02 ╭───┬────────────╮ │ 0 │ 2025-01-01 │ │ 1 │ 2025-01-02 │ ╰───┴────────────╯ ``` The default output format also remains unchanged: ``` > seq date --begin-date 2025-01-01 --end-date 2025-01-02 --increment 6hr ╭───┬────────────╮ │ 0 │ 2025-01-01 │ │ 1 │ 2025-01-01 │ │ 2 │ 2025-01-01 │ │ 3 │ 2025-01-01 │ │ 4 │ 2025-01-02 │ ╰───┴────────────╯ ``` # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> ## Breaking Changes * The `--increment` argument no longer accepts just an integer and requires a duration ``` # NEW BEHAVIOR > seq date --begin-date 2025-01-01 --end-date 2025-01-02 --increment 1 Error: nu::parser::parse_mismatch × Parse mismatch during operation. ╭─[entry #13:1:68] 1 │ seq date --begin-date 2025-01-01 --end-date 2025-01-02 --increment 1 · ┬ · ╰── expected duration with valid units ╰──── ``` EDIT: Break Change is mitigated. `--increment` accepts either an integer or duration. ## Bug Fix * The `--days` argument had an off-by-one error and would print 1 too many elements in the output. For example, ``` # OLD BEHAVIOR > seq date -b 2025-01-01 --days 5 --increment 1 ╭───┬────────────╮ │ 0 │ 2025-01-01 │ │ 1 │ 2025-01-02 │ │ 2 │ 2025-01-03 │ │ 3 │ 2025-01-04 │ │ 4 │ 2025-01-05 │ │ 5 │ 2025-01-06 │ <-- Extra element ╰───┴────────────╯ # NEW BEHAVIOR > seq date -b 2025-01-01 --days 5 --increment 1day ╭───┬────────────╮ │ 0 │ 2025-01-01 │ │ 1 │ 2025-01-02 │ │ 2 │ 2025-01-03 │ │ 3 │ 2025-01-04 │ │ 4 │ 2025-01-05 │ ╰───┴────────────╯ ``` ## New Argument * A `--periods` argument is introduced to indicate the number of output elements, regardless of the `--increment` value. Importantly, the `--days` argument is ignored when `--periods` is set. ``` # NEW BEHAVIOR > seq date -b 2025-01-01 --days 5 --periods 10 --increment 1day ╭───┬────────────╮ │ 0 │ 2025-01-01 │ │ 1 │ 2025-01-02 │ │ 2 │ 2025-01-03 │ │ 3 │ 2025-01-04 │ │ 4 │ 2025-01-05 │ │ 5 │ 2025-01-06 │ │ 6 │ 2025-01-07 │ │ 7 │ 2025-01-08 │ │ 8 │ 2025-01-09 │ │ 9 │ 2025-01-10 │ ╰───┴────────────╯ ``` Note that the `--days` and `--periods` arguments differ in their functions. The `--periods` value determines the number of elements in the output that are always spaced `--increment` apart. The `--days` value determines the bookends `--begin-date` and `--end-date` when only one is set, though the number of elements may differ based on the `--increment` value. ``` # NEW BEHAVIOR > seq date -e 2025-01-01 --days 2 --increment 5hr --output-format "%Y-%m-%d %H:%M:%S" ╭───┬─────────────────────╮ │ 0 │ 2025-01-23 22:25:05 │ │ 1 │ 2025-01-24 03:25:05 │ │ 2 │ 2025-01-24 08:25:05 │ │ 3 │ 2025-01-24 13:25:05 │ │ 4 │ 2025-01-24 18:25:05 │ ╰───┴─────────────────────╯ ``` # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> I added several examples for each user-facing change in `generators/seq_date.rs` and some tests in `tests/commands/seq_date.rs`. # 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. --> |
||
|---|---|---|
| .. | ||
| assignment | ||
| base | ||
| bytes | ||
| conversions | ||
| database | ||
| date | ||
| debug | ||
| hash_ | ||
| math | ||
| move_ | ||
| network | ||
| path | ||
| platform | ||
| query | ||
| random | ||
| skip | ||
| str_ | ||
| take | ||
| url | ||
| alias.rs | ||
| all.rs | ||
| any.rs | ||
| append.rs | ||
| break_.rs | ||
| cal.rs | ||
| cd.rs | ||
| chunk_by.rs | ||
| chunks.rs | ||
| compact.rs | ||
| complete.rs | ||
| config_env_default.rs | ||
| config_nu_default.rs | ||
| continue_.rs | ||
| debug_info.rs | ||
| def.rs | ||
| default.rs | ||
| detect_columns.rs | ||
| do_.rs | ||
| drop.rs | ||
| du.rs | ||
| each.rs | ||
| echo.rs | ||
| empty.rs | ||
| error_make.rs | ||
| every.rs | ||
| exec.rs | ||
| export_def.rs | ||
| fill.rs | ||
| filter.rs | ||
| find.rs | ||
| first.rs | ||
| flatten.rs | ||
| for_.rs | ||
| format.rs | ||
| generate.rs | ||
| get.rs | ||
| glob.rs | ||
| griddle.rs | ||
| group_by.rs | ||
| headers.rs | ||
| help.rs | ||
| histogram.rs | ||
| ignore.rs | ||
| insert.rs | ||
| inspect.rs | ||
| interleave.rs | ||
| into_datetime.rs | ||
| into_filesize.rs | ||
| into_int.rs | ||
| join.rs | ||
| last.rs | ||
| length.rs | ||
| let_.rs | ||
| lines.rs | ||
| loop_.rs | ||
| ls.rs | ||
| match_.rs | ||
| merge_deep.rs | ||
| merge.rs | ||
| mktemp.rs | ||
| mod.rs | ||
| mut_.rs | ||
| nu_check.rs | ||
| open.rs | ||
| par_each.rs | ||
| parse.rs | ||
| prepend.rs | ||
| print.rs | ||
| redirection.rs | ||
| reduce.rs | ||
| reject.rs | ||
| rename.rs | ||
| return_.rs | ||
| reverse.rs | ||
| rm.rs | ||
| roll.rs | ||
| rotate.rs | ||
| run_external.rs | ||
| save.rs | ||
| select.rs | ||
| semicolon.rs | ||
| seq_char.rs | ||
| seq_date.rs | ||
| seq.rs | ||
| slice.rs | ||
| sort_by.rs | ||
| sort.rs | ||
| source_env.rs | ||
| split_column.rs | ||
| split_row.rs | ||
| start.rs | ||
| table.rs | ||
| tee.rs | ||
| terminal.rs | ||
| to_text.rs | ||
| transpose.rs | ||
| try_.rs | ||
| ucp.rs | ||
| ulimit.rs | ||
| umkdir.rs | ||
| uname.rs | ||
| uniq_by.rs | ||
| uniq.rs | ||
| update.rs | ||
| upsert.rs | ||
| use_.rs | ||
| utouch.rs | ||
| where_.rs | ||
| which.rs | ||
| while_.rs | ||
| window.rs | ||
| with_env.rs | ||
| wrap.rs | ||
| zip.rs | ||