@formatjs/icu-skeleton-parser 1.3.8 → 1.3.11

package/tests/__snapshots__/index.test.ts.snap

@@ -0,0 +1,389 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`[parseNumberSkeleton] case: "% .##" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "%x100" 1`] = `
+Object {
+  "scale": 100,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "()!" 1`] = `
+Object {
+  "currencySign": "accounting",
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "()" 1`] = `
+Object {
+  "currencySign": "accounting",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "()?" 1`] = `
+Object {
+  "currencySign": "accounting",
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "+!" 1`] = `
+Object {
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "+?" 1`] = `
+Object {
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "+_" 1`] = `
+Object {
+  "signDisplay": "never",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "." 1`] = `
+Object {
+  "maximumFractionDigits": 0,
+}
+`;
+
+exports[`[parseNumberSkeleton] case: ".##" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+}
+`;
+
+exports[`[parseNumberSkeleton] case: ".##/@##r" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "maximumSignificantDigits": 3,
+  "minimumSignificantDigits": 1,
+  "roundingPriority": "morePrecision",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: ".##/@##s" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "maximumSignificantDigits": 3,
+  "minimumSignificantDigits": 1,
+  "roundingPriority": "lessPrecision",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: ".##/w" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "trailingZeroDisplay": "stripIfInteger",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: ".00/w currency/CAD" 1`] = `
+Object {
+  "currency": "CAD",
+  "maximumFractionDigits": 2,
+  "minimumFractionDigits": 2,
+  "style": "currency",
+  "trailingZeroDisplay": "stripIfInteger",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "000" 1`] = `
+Object {
+  "minimumIntegerDigits": 3,
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "E+!00" 1`] = `
+Object {
+  "minimumIntegerDigits": 2,
+  "notation": "scientific",
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "E0" 1`] = `
+Object {
+  "minimumIntegerDigits": 1,
+  "notation": "scientific",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "EE+?000" 1`] = `
+Object {
+  "minimumIntegerDigits": 3,
+  "notation": "engineering",
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "compact-long" 1`] = `
+Object {
+  "compactDisplay": "long",
+  "notation": "compact",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "compact-short" 1`] = `
+Object {
+  "compactDisplay": "short",
+  "notation": "compact",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "currency/CAD ." 1`] = `
+Object {
+  "currency": "CAD",
+  "maximumFractionDigits": 0,
+  "style": "currency",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "currency/GBP .0*/@@@" 1`] = `
+Object {
+  "currency": "GBP",
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 1,
+  "minimumSignificantDigits": 3,
+  "style": "currency",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "currency/GBP .00##/@@@ unit-width-full-name" 1`] = `
+Object {
+  "currency": "GBP",
+  "currencyDisplay": "name",
+  "maximumFractionDigits": 4,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 3,
+  "style": "currency",
+  "unitDisplay": "long",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "currency/GBP .00##/@@@" 1`] = `
+Object {
+  "currency": "GBP",
+  "maximumFractionDigits": 4,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 3,
+  "style": "currency",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "engineering" 1`] = `
+Object {
+  "notation": "engineering",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "engineering/sign-except-zero" 1`] = `
+Object {
+  "notation": "engineering",
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "integer-width/*000" 1`] = `
+Object {
+  "minimumIntegerDigits": 3,
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "measure-unit/length-meter .00##/@@@ unit-width-full-name" 1`] = `
+Object {
+  "currencyDisplay": "name",
+  "maximumFractionDigits": 4,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 3,
+  "style": "unit",
+  "unit": "meter",
+  "unitDisplay": "long",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "measure-unit/length-meter .00##/@@@" 1`] = `
+Object {
+  "maximumFractionDigits": 4,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 3,
+  "style": "unit",
+  "unit": "meter",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "notation-simple" 1`] = `
+Object {
+  "notation": "standard",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .##" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .0###" 1`] = `
+Object {
+  "maximumFractionDigits": 4,
+  "minimumFractionDigits": 1,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .00/@##" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 1,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .00/@@@" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "maximumSignificantDigits": 3,
+  "minimumFractionDigits": 2,
+  "minimumSignificantDigits": 3,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .00/@@@@*" 1`] = `
+Object {
+  "maximumFractionDigits": 2,
+  "minimumFractionDigits": 2,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent .000*" 1`] = `
+Object {
+  "minimumFractionDigits": 3,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "percent scale/0.01" 1`] = `
+Object {
+  "scale": 0.01,
+  "style": "percent",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "scientific" 1`] = `
+Object {
+  "notation": "scientific",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "scientific/+ee/sign-always" 1`] = `
+Object {
+  "notation": "scientific",
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "scientific/sign-always" 1`] = `
+Object {
+  "notation": "scientific",
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-accounting" 1`] = `
+Object {
+  "currencySign": "accounting",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-accounting-always" 1`] = `
+Object {
+  "currencySign": "accounting",
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-accounting-except-zero" 1`] = `
+Object {
+  "currencySign": "accounting",
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-always" 1`] = `
+Object {
+  "signDisplay": "always",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-auto" 1`] = `
+Object {
+  "signDisplay": "auto",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-except-zero" 1`] = `
+Object {
+  "signDisplay": "exceptZero",
+}
+`;
+
+exports[`[parseNumberSkeleton] case: "sign-never" 1`] = `
+Object {
+  "signDisplay": "never",
+}
+`;
+
+exports[`case: "" 1`] = `Object {}`;
+
+exports[`case: "EEE, MMM d, ''yy" 1`] = `
+Object {
+  "day": "numeric",
+  "month": "short",
+  "weekday": "short",
+  "year": "2-digit",
+}
+`;
+
+exports[`case: "h:mm a" 1`] = `
+Object {
+  "hour": "numeric",
+  "hour12": true,
+  "hourCycle": "h12",
+  "minute": "2-digit",
+}
+`;
+
+exports[`case: "yyyy.MM.dd G 'at' HH:mm:ss zzzz" 1`] = `
+Object {
+  "day": "2-digit",
+  "era": "short",
+  "hour": "2-digit",
+  "hourCycle": "h23",
+  "minute": "2-digit",
+  "month": "2-digit",
+  "second": "2-digit",
+  "timeZoneName": "long",
+  "year": "numeric",
+}
+`;

package/tests/index.test.ts

@@ -0,0 +1,65 @@
+import {parseDateTimeSkeleton, parseNumberSkeleton} from '..'
+import {parseNumberSkeletonFromString} from '../number'
+
+test.each([
+  `yyyy.MM.dd G 'at' HH:mm:ss zzzz`,
+  `EEE, MMM d, ''yy`,
+  `h:mm a`,
+  ``,
+])('case: %p', skeleton => {
+  expect(parseDateTimeSkeleton(skeleton)).toMatchSnapshot()
+})
+
+test.each([
+  'percent .##',
+  '.##',
+  '.##/w',
+  '.',
+  '% .##',
+  '.##/@##r',
+  '.##/@##s',
+  'percent .000*',
+  'percent .0###',
+  'percent .00/@##',
+  'percent .00/@@@',
+  'percent .00/@@@@*',
+  'percent scale/0.01',
+  'currency/CAD .',
+  '.00/w currency/CAD',
+  'currency/GBP .0*/@@@',
+  'currency/GBP .00##/@@@',
+  'currency/GBP .00##/@@@ unit-width-full-name',
+  'measure-unit/length-meter .00##/@@@',
+  'measure-unit/length-meter .00##/@@@ unit-width-full-name',
+  'compact-short',
+  'compact-long',
+  'scientific',
+  'scientific/sign-always',
+  'scientific/+ee/sign-always',
+  'engineering',
+  'engineering/sign-except-zero',
+  'notation-simple',
+  'sign-auto',
+  'sign-always',
+  '+!',
+  'sign-never',
+  '+_',
+  'sign-accounting',
+  '()',
+  'sign-accounting-always',
+  '()!',
+  'sign-except-zero',
+  '+?',
+  'sign-accounting-except-zero',
+  '()?',
+  '000',
+  'integer-width/*000',
+  'E0',
+  'E+!00',
+  'EE+?000',
+  '%x100',
+])('[parseNumberSkeleton] case: %p', skeleton => {
+  expect(
+    parseNumberSkeleton(parseNumberSkeletonFromString(skeleton))
+  ).toMatchSnapshot()
+})

package/tsconfig.json

@@ -0,0 +1,5 @@
+// @generated
+{
+  // This is purely for IDE, not for compilation
+  "extends": "../../tsconfig.json"
+}

package/date-time.d.ts

@@ -1,8 +0,0 @@
-/**
- * Parse Date time skeleton into Intl.DateTimeFormatOptions
- * Ref: https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
- * @public
- * @param skeleton skeleton string
- */
-export declare function parseDateTimeSkeleton(skeleton: string): Intl.DateTimeFormatOptions;
-//# sourceMappingURL=date-time.d.ts.map

package/date-time.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"date-time.d.ts","sourceRoot":"","sources":["../../../../../packages/icu-skeleton-parser/date-time.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,GACf,IAAI,CAAC,qBAAqB,CA+H5B"}

package/date-time.js

@@ -1,125 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseDateTimeSkeleton = void 0;
-/**
- * https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
- * Credit: https://github.com/caridy/intl-datetimeformat-pattern/blob/master/index.js
- * with some tweaks
- */
-var DATE_TIME_REGEX = /(?:[Eec]{1,6}|G{1,5}|[Qq]{1,5}|(?:[yYur]+|U{1,5})|[ML]{1,5}|d{1,2}|D{1,3}|F{1}|[abB]{1,5}|[hkHK]{1,2}|w{1,2}|W{1}|m{1,2}|s{1,2}|[zZOvVxX]{1,4})(?=([^']*'[^']*')*[^']*$)/g;
-/**
- * Parse Date time skeleton into Intl.DateTimeFormatOptions
- * Ref: https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
- * @public
- * @param skeleton skeleton string
- */
-function parseDateTimeSkeleton(skeleton) {
-    var result = {};
-    skeleton.replace(DATE_TIME_REGEX, function (match) {
-        var len = match.length;
-        switch (match[0]) {
-            // Era
-            case 'G':
-                result.era = len === 4 ? 'long' : len === 5 ? 'narrow' : 'short';
-                break;
-            // Year
-            case 'y':
-                result.year = len === 2 ? '2-digit' : 'numeric';
-                break;
-            case 'Y':
-            case 'u':
-            case 'U':
-            case 'r':
-                throw new RangeError('`Y/u/U/r` (year) patterns are not supported, use `y` instead');
-            // Quarter
-            case 'q':
-            case 'Q':
-                throw new RangeError('`q/Q` (quarter) patterns are not supported');
-            // Month
-            case 'M':
-            case 'L':
-                result.month = ['numeric', '2-digit', 'short', 'long', 'narrow'][len - 1];
-                break;
-            // Week
-            case 'w':
-            case 'W':
-                throw new RangeError('`w/W` (week) patterns are not supported');
-            case 'd':
-                result.day = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'D':
-            case 'F':
-            case 'g':
-                throw new RangeError('`D/F/g` (day) patterns are not supported, use `d` instead');
-            // Weekday
-            case 'E':
-                result.weekday = len === 4 ? 'short' : len === 5 ? 'narrow' : 'short';
-                break;
-            case 'e':
-                if (len < 4) {
-                    throw new RangeError('`e..eee` (weekday) patterns are not supported');
-                }
-                result.weekday = ['short', 'long', 'narrow', 'short'][len - 4];
-                break;
-            case 'c':
-                if (len < 4) {
-                    throw new RangeError('`c..ccc` (weekday) patterns are not supported');
-                }
-                result.weekday = ['short', 'long', 'narrow', 'short'][len - 4];
-                break;
-            // Period
-            case 'a': // AM, PM
-                result.hour12 = true;
-                break;
-            case 'b': // am, pm, noon, midnight
-            case 'B': // flexible day periods
-                throw new RangeError('`b/B` (period) patterns are not supported, use `a` instead');
-            // Hour
-            case 'h':
-                result.hourCycle = 'h12';
-                result.hour = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'H':
-                result.hourCycle = 'h23';
-                result.hour = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'K':
-                result.hourCycle = 'h11';
-                result.hour = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'k':
-                result.hourCycle = 'h24';
-                result.hour = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'j':
-            case 'J':
-            case 'C':
-                throw new RangeError('`j/J/C` (hour) patterns are not supported, use `h/H/K/k` instead');
-            // Minute
-            case 'm':
-                result.minute = ['numeric', '2-digit'][len - 1];
-                break;
-            // Second
-            case 's':
-                result.second = ['numeric', '2-digit'][len - 1];
-                break;
-            case 'S':
-            case 'A':
-                throw new RangeError('`S/A` (second) patterns are not supported, use `s` instead');
-            // Zone
-            case 'z': // 1..3, 4: specific non-location format
-                result.timeZoneName = len < 4 ? 'short' : 'long';
-                break;
-            case 'Z': // 1..3, 4, 5: The ISO8601 varios formats
-            case 'O': // 1, 4: miliseconds in day short, long
-            case 'v': // 1, 4: generic non-location format
-            case 'V': // 1, 2, 3, 4: time zone ID or city
-            case 'X': // 1, 2, 3, 4: The ISO8601 varios formats
-            case 'x': // 1, 2, 3, 4: The ISO8601 varios formats
-                throw new RangeError('`Z/O/v/V/X/x` (timeZone) patterns are not supported, use `z` instead');
-        }
-        return '';
-    });
-    return result;
-}
-exports.parseDateTimeSkeleton = parseDateTimeSkeleton;

package/index.d.ts

@@ -1,3 +0,0 @@
-export * from './date-time';
-export * from './number';
-//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/icu-skeleton-parser/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA"}

package/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./date-time"), exports);
-(0, tslib_1.__exportStar)(require("./number"), exports);

package/lib/date-time.d.ts

@@ -1,8 +0,0 @@
-/**
- * Parse Date time skeleton into Intl.DateTimeFormatOptions
- * Ref: https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
- * @public
- * @param skeleton skeleton string
- */
-export declare function parseDateTimeSkeleton(skeleton: string): Intl.DateTimeFormatOptions;
-//# sourceMappingURL=date-time.d.ts.map

package/lib/date-time.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"date-time.d.ts","sourceRoot":"","sources":["../../../../../../packages/icu-skeleton-parser/date-time.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,GACf,IAAI,CAAC,qBAAqB,CA+H5B"}