Skip to content

Date: Add formatDateToParts - #700

Merged
rxaviers merged 3 commits into
globalizejs:masterfrom
rxaviers:date-to-parts-2
Apr 12, 2017
Merged

Date: Add formatDateToParts#700
rxaviers merged 3 commits into
globalizejs:masterfrom
rxaviers:date-to-parts-2

Conversation

@rxaviers

@rxaviers rxaviers commented Mar 3, 2017 •
edited
Loading

Copy link
Copy Markdown
Member

Supersedes #697, Fixes #678

List of part types, its respective CLDR date fields, and comparison with Intl DateTimeFormat formatToParts.

Globalize CLDR date fields Intl formatToParts
era era era
year year year
quarter quarter -
month month month
week week -
day day day
weekday weekday weekday
dayperiod dayperiod dayPeriod
hour hour hour
minute minute minute
second second second
zone zone timeZoneName
literal literal literal

List of part types and the corresponding CLDR date field patterns.

part type CLDR date field CLDR date field patterns
era era G
year year yY
quarter quarter qQ
month month ML
week week wW
day day dDF
weekday weekday ecE
dayperiod dayperiod a
hour hour hHkK
minute minute m
second second sSA
zone zone zOxX
literal literal

Checklist:
Checklist

  • Implementation
    • Functionality
    • Coding style (build passes)
    • formatDateToParts and dateToPartsFormatter.
  • Unit tests
    • Update test/unit/date/format.js
    • Update test/unit/date/format-properties.js
  • Functional tests
    • Update test/functional/date/format-date.js
    • move from test/functional/date/format-date.js into formatDateToParts and dateToPartsFormatter.
  • Runtime code
    • Update src/date-runtime.js
  • Documentation
    • Update doc/api/date/date-to-parts-formatter.md
  • Examples

@rxaviers rxaviers mentioned this pull request Mar 3, 2017
Closed
@rxaviers rxaviers mentioned this pull request Mar 8, 2017
Closed
13 tasks
@rxaviers
rxaviers force-pushed the date-to-parts-2 branch 2 times, most recently from 9a1b387 to 1cd9bd4 Compare March 14, 2017 21:46
@jsf-clabot

jsf-clabot commented Mar 14, 2017 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@rxaviers rxaviers added this to the 1.3.0 milestone Mar 17, 2017
@rxaviers
rxaviers force-pushed the date-to-parts-2 branch 2 times, most recently from ff349bd to c11b38a Compare April 11, 2017 13:35
jzaefferer
jzaefferer reviewed Apr 11, 2017
View reviewed changes

@jzaefferer jzaefferer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started reviewing, then got dragged into a meeting. Didn't get very far, but hopefully the existing comments will help.

Comment thread doc/api/date/date-formatter.md

enFormatter( new Date( 2010, 10, 30, 17, 55 ) );
// > "11/30/2010, 5:55 PM"
// > "11/30/2010"

@jzaefferer jzaefferer Apr 11, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the line above still pass the time to the Date constructor? Probably applies to various other examples in this file (and others?) as well.

@rxaviers rxaviers Apr 11, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The time part of the Date constructor is irrelevant and could be removed. 👍

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d19ee55

Comment thread doc/api/date/date-to-parts-formatter.md

### Example

Prior to using any date methods, you must load

@jzaefferer jzaefferer Apr 11, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do all docs have this note in the example section? Seems like important information that could be pulled up.

@rxaviers rxaviers Apr 11, 2017 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeap, other modules/fns have the same statement.

Comment thread doc/api/date/date-to-parts-formatter.md Outdated
formatter( new Date( 2010, 10, 30, 17, 55 ) ).map(({type, value}) => {
switch ( type ) {
case "year": return `<strong>${value}</strong>`;
default : return value;

@jzaefferer jzaefferer Apr 11, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

misplaced space in front of the colon

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx a9bc0b5

Comment thread doc/api/date/date-to-parts-formatter.md

- `day`

The string used for the day, e.g., `"17"`, `"١٦"`.

@jzaefferer jzaefferer Apr 11, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could compress this section a lot by putting the type of description on one line.

- `day`: The string used for the day, e.g., `"17"`, `"١٦"`.

@rxaviers rxaviers Apr 11, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeap, I think it needs overall improvement. I dislike the current format of the API, I am wondering if we had something like https://github.com/rxaviers/relative-time#formatdate-options instead.

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's track overall docs improvement in a separate PR.

Comment thread doc/api/date/date-to-parts-formatter.md
Globalize.locale( "en" );
formatter = Globalize.dateToPartsFormatter();

formatter( new Date( 2010, 10, 30, 17, 55 ) ).map(({type, value}) => {

@jzaefferer jzaefferer Apr 11, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great example, but it doesn't output the time, which seems harder to implement, since a join("") wouldn't be enough. Would be great to have an example including time.

@rxaviers rxaviers Apr 11, 2017 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since a join("") wouldn't be enough

Why? Check the parts output of a date and time case https://github.com/globalizejs/globalize/pull/700/files#diff-5e625c00d307f2b886e1b33225953053R165

Having said that, I think it's valid to include a date and time example.

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

d19ee55

@rxaviers

rxaviers commented Apr 12, 2017

Copy link
Copy Markdown
Member Author

@jzaefferer thanks for your review

@rxaviers
rxaviers force-pushed the date-to-parts-2 branch 2 times, most recently from d9b8c40 to 9408bff Compare April 12, 2017 22:55
rxaviers
rxaviers commented Apr 12, 2017
View reviewed changes
Comment thread examples/app-npm-webpack/messages/es.json
"number-label": "Número",
"currency-label": "Moneda",
"date-label": "Fecha",
"date-to-parts-label": "Fecha (note el mes destacado en negro, el marcador de html se agregó utilizando dateToPartsFormatter)",

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lwelti

rxaviers
rxaviers commented Apr 12, 2017
View reviewed changes
Comment thread examples/app-npm-webpack/messages/de.json
"number-label": "Zahl",
"currency-label": "Währung",
"date-label": "Datum",
"date-to-parts-label": "Datum (beachten Sie den hervorgehobenen Monat, das Markup wurde mit dateToPartsFormatter hinzugefügt)",

@rxaviers rxaviers Apr 12, 2017

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jzaefferer

@rxaviers
rxaviers merged commit 8eed86d into globalizejs:master Apr 12, 2017
@rxaviers
rxaviers deleted the date-to-parts-2 branch April 12, 2017 23:37
rxaviers added a commit to rxaviers/globalize that referenced this pull request May 17, 2017
@rxaviers
Date: Fix dateFormatter runtime
ee74907 
When dateToPartsFormatter was added, dateFormatter became an alias to
it. Although globalize-compiler can handle it by using
`.compileExtracts()`, it doesn't by using `.compile()` and passing
`formattersAndParsers` argument. This update fixed that.

Amends e4234a7
Ref globalizejs#678
Ref globalizejs#697
Ref globalizejs#700
@rxaviers rxaviers mentioned this pull request May 17, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jzaefferer jzaefferer jzaefferer left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

1.3.0

Development

Successfully merging this pull request may close these issues.

4 participants

@rxaviers @jsf-clabot @jzaefferer @rpayami