Add SMART_NUMBER formatter and make it default

[kristw]

Motivation

From apache/superset#6916 and past encounters with number formatting, Superset's default D3's SI formatter works ok most of the time but have some too scientific outputs which confuses general users such as

• Format billions as xxxG (G = Giga) instead of B which people associate with billions and are more familiar with.
  1,000,000,000 => '1G'
  P.S. Luckily, millions and Mega have the same M abbreviation.
• Format floating point using micro (m) which can be confused with m for minutes when the users are unaware of the context.
  0.01 => '10m'
• The SI formatter requires number of precision point as parameter. The default is 3. This cause unnecessary rounding for small numbers.
  123.45 => '123'

Superset users therefore often have to define custom formatting or in the billion case, have to tolerate it.

Changes

This PR addresses the issues above and provide more humanized outputs for these edge cases, so the default number formatter should work most of the time out-of-the-box. It will reduce the amount of custom formatting need and improve user experience.

• 1,000,000,000 => '1B'
• 0.01 => '0.01'
• 123.45 => '123.45'

💔 Breaking Changes

• Rename constants in NumberFormats changing _CHANGE to _SIGNED.
• Default number format is now SMART_NUMBER instead of D3 .3~s.

🏆 Enhancements

• Add new number format factory createSmartNumberFormatter.

[codecov]

Codecov Report

Merging #109 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #109   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          72     73    +1     
  Lines         861    888   +27     
  Branches      195    204    +9     
=====================================
+ Hits          861    888   +27

Impacted Files	Coverage Δ
...ges/superset-ui-number-format/src/NumberFormats.ts	100% <100%> (ø)	⬆️
...et-ui-number-format/src/NumberFormatterRegistry.ts	100% <100%> (ø)	⬆️
...format/src/factories/createSmartNumberFormatter.ts	100% <100%> (ø)

---

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 fc6d31e...e31d54d. Read the comment docs.

[mistercrunch]

We should add a note to UPDATING.md when we bump this on the Superset side.

[williaster]

we could move these outside the function so they aren't created every call? looks like they don't ever change so no reason not to?

[williaster]

Solid change! one suggestion 💬

[ghost]

There were the following issues with this Pull Request

• Commit: 5dccdad
  • ✖ message may not be empty
  • ✖ type may not be empty
• Commit: e48cfa5
  • ✖ message may not be empty
  • ✖ type may not be empty
• Commit: db083e9
  • ✖ message may not be empty
  • ✖ type may not be empty

You may need to change the commit messages to comply with the repository contributing guidelines.

---

🤖 This comment was generated by commitlint[bot]. Please report issues here.

Happy coding!