feat: add support for lowercase localizable formats (l, ll, lll, llll) #546

mariomc · 2019-03-28T11:37:48Z

This PR tries to bridge the gap between dayjs and moment by implementing lowecase/short localizable formats, already present in moment, since 2.0.0

iamkun · 2019-03-28T11:41:23Z

Thanks, will consider this PR.

mariomc · 2019-03-28T11:52:43Z

Thanks!
If you wish to keep the localizableFormat plugin slim, I can write another plugin just for this.

codecov-io · 2019-03-28T12:47:19Z

Codecov Report

Merging #546 into dev will not change coverage.
The diff coverage is 100%.

@@         Coverage Diff         @@
##            dev   #546   +/-   ##
===================================
  Coverage   100%   100%           
===================================
  Files       151    152    +1     
  Lines       942    954   +12     
  Branches    123    127    +4     
===================================
+ Hits        942    954   +12

Impacted Files	Coverage Δ
src/locale/ko.js	`100% <ø> (ø)`	⬆️
src/locale/sv.js	`100% <ø> (ø)`	⬆️
src/locale/lt.js	`100% <ø> (ø)`	⬆️
src/locale/zh-tw.js	`100% <ø> (ø)`	⬆️
src/locale/cs.js	`100% <ø> (ø)`	⬆️
src/locale/ca.js	`100% <ø> (ø)`	⬆️
src/locale/ja.js	`100% <ø> (ø)`	⬆️
src/index.js	`100% <ø> (ø)`	⬆️
src/locale/fi.js	`100% <ø> (ø)`	⬆️
src/locale/zh-cn.js	`100% <ø> (ø)`	⬆️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 71e4bff...8c6e1b8. Read the comment docs.

iamkun · 2019-03-28T13:20:37Z

It's not about the size of this plugin, but the size of all other locale files.

If we introduce some more localizable formats, all the locale files will be updated and added these format. That's a huge increase in the total size of our locale files.

That's why I'd like to keep this PR pending until more feature requests.

mariomc · 2019-03-28T14:28:45Z

I see your worry. However, in the case of moment, there's only a few like zh-cn and sv who set (some) of their own short localized formats.
The big majority of locales don't even define short localized formats and fallback to the default behavior/configuration.

dayjs is well designed and this funcionality can be implemented easily with a plugin (and, for my case, I did just that). I just thought that, by having the current locale plugin with this capacity (hence the PR), it could ease the transition for those who, like me, are migrating from moment to dayjs.

In any case, thank you for the reply and awesome work on dayjs!

iamkun · 2019-03-28T15:58:46Z

You are right, only a few have this. Is there a full list of locales that have lowercase localizable formats instead of checking every locale files on GitHub one by one?

I'm willing to merge this if it's not that much. 😬

mariomc · 2019-03-28T16:53:41Z

On moment/locale, doing a grep -e ' l :' -e ' ll : ' -e ' lll :' -e ' llll :' *.js | awk '{print $1}' | sed "s/.js://" | uniq -ci outputs the locale list that use a short-hand localised formats, with the number of different formats each of those use (l, ll, lll, llll):

   3 ca
   1 cs
   4 eu
   4 fi
   4 he
   4 ja
   4 ko
   4 lt
   2 sv
   4 vi
   4 zh-cn
   4 zh-hk
   4 zh-tw

It's a bit more than 10% (13 locales out of 127 total), but still not too many. That should represent roughly 46 new lines total.

iamkun · 2019-03-29T03:09:31Z

Great!

Skipped locales (fi, he, lt) without (yet) a current format setting in dayjs

ghost · 2019-03-29T11:10:41Z

We should update the docs accordinglly

mariomc · 2019-03-29T11:17:18Z

Will do. Adding current locales as well as fixing current tests to contain those key additions. Noticed an issue with localizedFormats. Will keep in touch and open accordingly.

src/plugin/localizedFormat/index.js

mariomc · 2019-03-29T14:48:19Z

Added fix. Will review and add the missing localized formats for fi, he, lt.
Didn't add them previously because the interpolation issue.

ghost · 2019-03-29T14:49:02Z

/(\[[^\]]+])| looks nice compare to the original version in core index.js format method.

Maybe we could update the index.js file to make it size smaller?

Hopefully this will make the bundle smaller

mariomc · 2019-03-29T15:22:04Z

Well thought @xxyuk, thanks! We managed to bring the package size down a notch 😄
Should we consider adding final bundle size metrics alongside codecov?

ghost · 2019-03-29T15:23:37Z

Not sure, can codecov do this?

mariomc · 2019-03-29T15:25:13Z

I don't know about codecov. The only one I do know is bundlesize and it looks great!

ghost · 2019-03-29T15:26:58Z

Oh I see, we already have such size limit tool during our CI build. You could find them in package.json.

ghost · 2019-03-29T16:57:48Z

Maybe update doc here as well ?
https://github.com/iamkun/dayjs/blob/dev/docs/en/Plugin.md#localizedformat

2.45kb package size

mariomc · 2019-03-29T17:25:20Z

Done. I also took a dabble at the regex previously mentioned and managed to shave a few more bytes off of it.
Thanks for the heads-up @xxyuk !

src/constant.js

added tests for to cover .format() interpolation

test/parse.test.js

## [1.8.12](v1.8.11...v1.8.12) (2019-04-02) ### Bug Fixes * Add .get API ([7318797](7318797)) * Add 79 locales ([#541](#541)) ([f75a125](f75a125)) * Add Calendar plugin ([d1b9cf9](d1b9cf9)) * Add isoWeeksInYear plugin ([2db8631](2db8631)) * Add Occitan (oc-lnc) locale file ([#551](#551)) ([c30b715](c30b715)) * Add plugin minMax to sopport .max .min ([2870a23](2870a23)) * Fix set Month Year error in last day of the month ([d058f4a](d058f4a)) * Update ko locale weekdaysShort ([#543](#543)) ([317fd3e](317fd3e)) * Update localizedFormat plugin to support lowercase localizable formats (l, ll, lll, llll) ([#546](#546)) ([f2b5ebf](f2b5ebf))

iamkun · 2019-04-02T10:09:44Z

🎉 This PR is included in version 1.8.12 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [1.8.12](iamkun/dayjs@v1.8.11...v1.8.12) (2019-04-02) ### Bug Fixes * Add .get API ([7318797](iamkun/dayjs@7318797)) * Add 79 locales ([#541](iamkun/dayjs#541)) ([f75a125](iamkun/dayjs@f75a125)) * Add Calendar plugin ([d1b9cf9](iamkun/dayjs@d1b9cf9)) * Add isoWeeksInYear plugin ([2db8631](iamkun/dayjs@2db8631)) * Add Occitan (oc-lnc) locale file ([#551](iamkun/dayjs#551)) ([c30b715](iamkun/dayjs@c30b715)) * Add plugin minMax to sopport .max .min ([2870a23](iamkun/dayjs@2870a23)) * Fix set Month Year error in last day of the month ([d058f4a](iamkun/dayjs@d058f4a)) * Update ko locale weekdaysShort ([#543](iamkun/dayjs#543)) ([317fd3e](iamkun/dayjs@317fd3e)) * Update localizedFormat plugin to support lowercase localizable formats (l, ll, lll, llll) ([#546](iamkun/dayjs#546)) ([f2b5ebf](iamkun/dayjs@f2b5ebf))

feat: add support for lowercase localizable formats (l, ll, lll, llll)

392bc9b

Added lowercase formats to locales that already have a format defined

e8a599c

Skipped locales (fi, he, lt) without (yet) a current format setting in dayjs

mariomc added 2 commits March 29, 2019 13:28

Extended local key tests to support lowercase localised formats

af5d4f2

Added documentation for i18n (pt-br and en)

e2369c5

mariomc mentioned this pull request Mar 29, 2019

localizedFormat plugin is interpolating content inside square brackets #550

Closed

fix: fixes issue iamkun#550

058a9fd

mariomc commented Mar 29, 2019

View reviewed changes

src/plugin/localizedFormat/index.js Show resolved Hide resolved

mariomc added 2 commits March 29, 2019 14:54

Added missing locale short formats (fi, he, lt)

06e4b0a

feat: change format method regex to use grouping

c543b2d

Hopefully this will make the bundle smaller

mariomc added 2 commits March 29, 2019 17:09

feat: further optimise the main regex formats

80dc483

2.45kb package size

docs: Add lowercase locale formats docs

9f679d6

iamkun reviewed Apr 1, 2019

View reviewed changes

src/constant.js Outdated Show resolved Hide resolved

feat: reduced regex for .format()

28379f0

added tests for to cover .format() interpolation

iamkun reviewed Apr 1, 2019

View reviewed changes

test/parse.test.js Outdated Show resolved Hide resolved

tests: moved multi-interpolation .format() test to display.test.js

8c6e1b8

iamkun merged commit f2b5ebf into iamkun:dev Apr 1, 2019

iamkun added the released label Apr 2, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for lowercase localizable formats (l, ll, lll, llll) #546

feat: add support for lowercase localizable formats (l, ll, lll, llll) #546

mariomc commented Mar 28, 2019

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019

codecov-io commented Mar 28, 2019 •

edited

Loading

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019 •

edited

Loading

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019 •

edited

Loading

iamkun commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019 •

edited

Loading

iamkun commented Apr 2, 2019

feat: add support for lowercase localizable formats (l, ll, lll, llll) #546

feat: add support for lowercase localizable formats (l, ll, lll, llll) #546

Conversation

mariomc commented Mar 28, 2019

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019

codecov-io commented Mar 28, 2019 • edited Loading

Codecov Report

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019 • edited Loading

iamkun commented Mar 28, 2019

mariomc commented Mar 28, 2019 • edited Loading

iamkun commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019

ghost commented Mar 29, 2019

ghost commented Mar 29, 2019

mariomc commented Mar 29, 2019 • edited Loading

iamkun commented Apr 2, 2019

codecov-io commented Mar 28, 2019 •

edited

Loading

mariomc commented Mar 28, 2019 •

edited

Loading

mariomc commented Mar 28, 2019 •

edited

Loading

mariomc commented Mar 29, 2019 •

edited

Loading