Add custom datetime format through `strftime` strings #9500

fnordpig · 2023-06-21T21:32:52Z

improves usability of datetime's in displayed text

Description

Creates a config point for specifying long / short date time formats. Defaults to humanized as we have today.

Provides for adding strftime formats into config.nu such as:

  datetime_format: {
    normal: "%Y-%m-%d %H:%M:%S"
    table: "%Y-%m-%d"
  }

Example:

> $env.config.datetime_format                                                                                                                         
┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ normal ┃ %a, %d %b %Y %H:%M:%S %z ┃
┃ table  ┃ %m/%d/%y %I:%M:%S%p      ┃
┗━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━┛
> let a = (date now)                                                                                                                                  
> echo $a                                                                                                                                             
Thu, 22 Jun 2023 10:21:23 -0700
> echo [$a]                                                                                                                                           
┏━━━┳━━━━━━━━━━━━━━━━━━━━━┓
┃ 0 ┃ 06/22/23 10:21:23AM ┃
┗━━━┻━━━━━━━━━━━━━━━━━━━━━┛

User-Facing Changes

Any place converting a datetime to a user displayed value should be impacted.

Tests + Formatting

cargo fmt --all -- --check Done
cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err Done
cargo test --workspace Done
cargo run -- crates/nu-std/tests/run.nu Not done - doesn't seem to work

> use toolkit.nu  # or use an `env_change` hook to activate it automatically
> toolkit check pr
``` - Done

fnordpig · 2023-06-21T22:13:11Z

I don't really understand what test is failing above - looks like some sort of virtualenv test?

fdncred · 2023-06-21T23:52:43Z

I don't really understand what test is failing above - looks like some sort of virtualenv test?

The venv issue is not related to your PR. It's crashing everyone's PR. We're trying to look into it.

fdncred · 2023-06-22T00:05:48Z

If we move forward with this PR we'll need the config point in the default_config.nu file with comments that help explain how to set the values.

I put this in my config. Is this appropriate?

  datetime_format: {
    normal: "%Y-%m-%d %H:%M:%S"
    abbreviated: "%Y-%m-%d"
  }

I'm not sure where normal and abbreviated show up in nushell. Any ideas?

fnordpig · 2023-06-22T01:30:06Z

If we move forward with this PR we'll need the config point in the default_config.nu file with comments that help explain how to set the values.

I put this in my config. Is this appropriate?
  datetime_format: {
    normal: "%Y-%m-%d %H:%M:%S"
    abbreviated: "%Y-%m-%d"
  }

Yep that's precisely right! I'll add the default_config.nu changes to this PR

I'm not sure where normal and abbreviated show up in nushell. Any ideas?

Normal shows up wherever value.into_string/nonerror_into_string are called - it's a bit of a nest, because value::record/lazyrecord/list also defer to these types so it's tough for me to understand everywhere it shows up. I wish I had a better answer than that...

fnordpig · 2023-06-22T04:10:02Z

I'm not sure where normal and abbreviated show up in nushell. Any ideas?

Normal shows up wherever value.into_string/nonerror_into_string are called - it's a bit of a nest, because value::record/lazyrecord/list also defer to these types so it's tough for me to understand everywhere it shows up. I wish I had a better answer than that...

So, normal shows up if you do something like:

let a = (date now)
echo $a

Abbreviated appears to be generally when rendering a table that tries to fit on the screen, such as:

let a = [(date now)]
echo $a

fnordpig · 2023-06-22T04:12:39Z

Added default_config.nu

sholderbach · 2023-06-22T08:45:49Z

I am gonna be the pedantic party pooper for just a moment:

Can you update your PR description and title to make clear what changes and how one can use it, as soon as your design is ready for review. Both to help folks that want to play with it before it gets merged and also to have a good record in the commit history. Furthermore good examples in the PR descriptions make the life so much easier when we have to compile the release notes.

fdncred · 2023-06-22T11:26:37Z

Thanks for adding the default_config.nu!

I have one more request, instead of "normal" and "abbreviated" can we have "normal" and "ls" (or maybe "table")? I understand where abbreviated came from but I think it would be more intuitive for future users to intuitively understand which one shows up in ls.

amtoine · 2023-06-22T16:49:48Z

i think this should solve #8549, can you confirm that @fnordpig? 😋

amtoine

to wrap this up by a review 😌

i love the feature, it looks great thanks @fnordpig 🥳

i agree with the remarks of @fdncred and @sholderbach, and i'll approve this with great pleasure once

the default_config.nu has been upated
the PR description has been completed with what the changes do and examples
change the name of the config items
the linked issue (into datetime only gets last part of date in output when on list/table #8549) has been confirmed to be solved by this PR

fnordpig · 2023-06-22T17:32:27Z

the default_config.nu has been upated
the PR description has been completed with what the changes do and examples
change the name of the config items
the linked issue (into datetime only gets last part of date in output when on list/table #8549) has been confirmed to be solved by this PR

I can confirm, it does resolve this. Obviously you have to do something like this:

> let-env config = ($env.config | upsert datetime_format.table '%m/%d/%y') 
> [1649203200000000000,1649289600000000000] | into datetime 
┏━━━┳━━━━━━━━━━┓
┃ 0 ┃ 04/06/22 ┃
┃ 1 ┃ 04/07/22 ┃
┗━━━┻━━━━━━━━━━┛

But assuming that's sufficient, it does indeed work.

fdncred

Thanks for making the changes I requested. I'm ready.

fdncred · 2023-06-23T00:52:35Z

I went ahead and made one change to the default_config.nu. Since this is the config file that most people start nushell with, I thought it was appropriate to leave our default human readable datetime in place. So, I left the table: setting in there but commented it out for people to experiment. Hope that's ok.

This is what I changed.

  datetime_format: {
    normal: '%a, %d %b %Y %H:%M:%S %z'  # shows up in displays of variables or other datetime's outside of tables
    # table: '%m/%d/%y %I:%M:%S%p'        # generally shows up in tabular outputs such as ls. commenting this out will change it to the default human readable datetime format
  }

Also, I'm not sure the default is appropriate for locales that use day/month/year vs month/day/year.

fdncred · 2023-06-23T11:29:35Z

sorry, i broke your PR by landing another PR. would you mind fixing the merge conflicts?

related to - nushell#9404 # Description to support our cratification effort and moving non-1.0 commands outside of the main focus, this PR - creates a new `nu-cmd-base` crate to hold the common structs, traits and functions used by all command-related crates - to start the transition, moves the `input_handler` module from `nu-command` to `nu-cmd-base` # User-Facing Changes ``` $nothing ``` # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - ⚫ `toolkit test` - ⚫ `toolkit test stdlib` # After Submitting ``` $nothing ```

# Description make history.max_size bigger so it doesn't eat history closes nushell#9493 # User-Facing Changes  # Tests + Formatting  # After Submitting

This PR cleans up the deprecated legacy config options that were deprecated in nushell version 0.72.0. These are the config points that were in the root of the config but also duplicated in the nested structures. For instance `use_ls_colors` was in the root of the config and also in the `ls.use_ls_colors` nested structure. This was originally done to preserve backwards compatibility when nested structures were introduced in the config file. Here's a list of the legacy config points that were removed. - `use_ls_colors` - previously replaced with `ls.use_ls_colors` - `rm_always_trash` - previously replaced with `rm.always_trash` - `history_file_format` - previously replaced with `history.file_format` - `sync_history_on_enter` - previously replaced with `history.sync_on_enter` - `max_history_size` - previously replaced with `history.max_size` - `quick_completions` - previously replaced with `completions.quick` - `partial_completions` - previously replaced with `completions.partial` - `max_external_completion_results` - previously replaced with `completions.external.max_results` - `completion_algorithm` - previously replaced with `completions.algorithm` - `case_sensitive_completions` - previously replaced with `completions.case_sensitive` - `enable_external_completion` - previously replaced with `completions.external.enable` - `external_completer` - previously replaced with `completions.external.completer` - `table_mode` - previously replaced with `table.mode` - `table_index_mode` - previously replaced with `table.index_mode` - `table_trim` - previously replaced with `table.trim` - `show_clickable_links_in_ls` - previously replaced with `ls.clickable_links` - `cd_with_abbreviations` - previously replaced with `cd.abbreviations` - `filesize_metric` - previously replaced with `filesize.metric` - `filesize_format` - previously replaced with `filesize.format` - `cursor_shape_vi_insert` - previously replaced with `cursor_shape.vi_insert` - `cursor_shape_vi_normal` - previously replaced with `cursor_shape.vi_normal` - `cursor_shape_emacs` - previously replaced with `cursor_shape.emacs` Removes log_level from the config since it doesn't do anything any longer. We moved log-level to a nushell parameter some time ago. Renames history_isolation to isolation in the config.nu for consistency. Fixes a couple bugs where values weren't being set in the "// Reconstruct" sections (history_isolation, table_show_empty). Reorganized/Moved things around a tiny bit and added a few comments. history.histor_isolation is now history.isolation. If anyone is still using the legacy config points, deprecated since 0.72.0 2022-11-29, their config will break.

fnordpig · 2023-06-23T15:02:59Z

Gah I've gotten into some sort of git hell

fdncred · 2023-06-23T15:04:39Z

been there, done that. don't worry too much about the amount of commits as they are all squashed anyway.

fnordpig · 2023-06-23T15:42:58Z

Ok I seem to have navigated git hell successfully

fdncred · 2023-06-23T15:57:12Z

nice work, just some small fmt-clippy items to deal with and it should be good.

fnordpig · 2023-06-23T16:15:26Z

Doh, merge artifacts. Fixed.

fdncred · 2023-06-23T20:05:00Z

Thanks!

amtoine · 2023-06-25T12:09:25Z

this is really quite cool, thanks @fnordpig 👌

related to nushell/nushell#9500

- improves usability of datetime's in displayed text - # Description Creates a config point for specifying long / short date time formats. Defaults to humanized as we have today. Provides for adding strftime formats into config.nu such as: ```nu datetime_format: { normal: "%Y-%m-%d %H:%M:%S" table: "%Y-%m-%d" } ``` Example: ```bash > $env.config.datetime_format ┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ normal ┃ %a, %d %b %Y %H:%M:%S %z ┃ ┃ table ┃ %m/%d/%y %I:%M:%S%p ┃ ┗━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━┛ > let a = (date now) > echo $a Thu, 22 Jun 2023 10:21:23 -0700 > echo [$a] ┏━━━┳━━━━━━━━━━━━━━━━━━━━━┓ ┃ 0 ┃ 06/22/23 10:21:23AM ┃ ┗━━━┻━━━━━━━━━━━━━━━━━━━━━┛ ``` # User-Facing Changes Any place converting a datetime to a user displayed value should be impacted. # Tests + Formatting - `cargo fmt --all -- --check` Done - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` Done - `cargo test --workspace` Done - `cargo run -- crates/nu-std/tests/run.nu` Not done - doesn't seem to work ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr ``` - Done --------- Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: Antoine Stevan <44101798+amtoine@users.noreply.github.com>

@fnordpig

related to a comment in #9500 > `cargo run -- crates/nu-std/tests/run.nu` Not done - doesn't seem to work this is absolutely true because the command in the PR template was obsolete... i've also updated the commands in the `CONTRIBUTING` document of the library 👍 cc/ @fnordpig

This is not perfect if the string is already illegal. See nushell#9500

fnordpig added 2 commits June 21, 2023 12:49

Add datetime formatting as config option

251795a

Add locale to the cargo crate

410fd0f

fnordpig added 2 commits June 21, 2023 21:11

Add some default config values

b83a8a3

Merge branch 'nushell:main' into datetime

c8dc914

amtoine linked an issue Jun 22, 2023 that may be closed by this pull request

into datetime only gets last part of date in output when on list/table #8549

Closed

amtoine requested changes Jun 22, 2023

View reviewed changes

Update with new name for config point

2bae286

fdncred approved these changes Jun 22, 2023

View reviewed changes

comment out default table setting

0b8c2e1

tweak comments

8c8038a

sholderbach changed the title ~~Datetime~~ Add custom datetime format through strftime strings Jun 23, 2023

amtoine and others added 6 commits June 23, 2023 07:50

Add datetime formatting as config option

f760e50

Add datetime formatting as config option

1efe364

fnordpig added 4 commits June 23, 2023 08:15

Add datetime formatting as config option

80fb7cb

Add datetime formatting as config option

95b9f03

Add datetime formatting as config option

0d8a401

Merge remote-tracking branch 'original/main' into datetime

5576d00

fmt/fix

8c34591

fdncred merged commit 0c88848 into nushell:main Jun 23, 2023
17 of 20 checks passed

amtoine added a commit to amtoine/dotfiles that referenced this pull request Jun 26, 2023

set the date format

a15edcb

related to nushell/nushell#9500

amtoine mentioned this pull request Jun 26, 2023

fix the std test commands calls in dev documents #9535

Merged

fnordpig deleted the datetime branch July 2, 2023 03:48

sholderbach mentioned this pull request Sep 28, 2023

Customizable default date autoview format #3735

Closed

sholderbach added a commit to sholderbach/nushell that referenced this pull request Nov 2, 2023

Try to reconstruct config.datetime_format

9f5abab

This is not perfect if the string is already illegal. See nushell#9500

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom datetime format through `strftime` strings #9500

Add custom datetime format through `strftime` strings #9500

fnordpig commented Jun 21, 2023 •

edited

fnordpig commented Jun 21, 2023

fdncred commented Jun 21, 2023

fdncred commented Jun 22, 2023 •

edited

fnordpig commented Jun 22, 2023

fnordpig commented Jun 22, 2023 •

edited

fnordpig commented Jun 22, 2023

sholderbach commented Jun 22, 2023

fdncred commented Jun 22, 2023 •

edited

amtoine commented Jun 22, 2023

amtoine left a comment •

edited by fdncred

fnordpig commented Jun 22, 2023 •

edited

fdncred left a comment

fdncred commented Jun 23, 2023 •

edited

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

amtoine commented Jun 25, 2023

Add custom datetime format through strftime strings #9500

Add custom datetime format through strftime strings #9500

Conversation

fnordpig commented Jun 21, 2023 • edited

Description

User-Facing Changes

Tests + Formatting

fnordpig commented Jun 21, 2023

fdncred commented Jun 21, 2023

fdncred commented Jun 22, 2023 • edited

fnordpig commented Jun 22, 2023

fnordpig commented Jun 22, 2023 • edited

fnordpig commented Jun 22, 2023

sholderbach commented Jun 22, 2023

fdncred commented Jun 22, 2023 • edited

amtoine commented Jun 22, 2023

amtoine left a comment • edited by fdncred

Choose a reason for hiding this comment

fnordpig commented Jun 22, 2023 • edited

fdncred left a comment

Choose a reason for hiding this comment

fdncred commented Jun 23, 2023 • edited

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

fnordpig commented Jun 23, 2023

fdncred commented Jun 23, 2023

amtoine commented Jun 25, 2023

Add custom datetime format through `strftime` strings #9500

Add custom datetime format through `strftime` strings #9500

fnordpig commented Jun 21, 2023 •

edited

fdncred commented Jun 22, 2023 •

edited

fnordpig commented Jun 22, 2023 •

edited

fdncred commented Jun 22, 2023 •

edited

amtoine left a comment •

edited by fdncred

fnordpig commented Jun 22, 2023 •

edited

fdncred commented Jun 23, 2023 •

edited