feat: replace dateFormatString with a more generic splitDateFormat method

Author: danielkaradachki

src/cldr.d.ts

@@ -20,7 +20,7 @@ export interface DateFormatNameOptions {
     /**
      * Specifies whether the standalone names should be returned.
      */
-    standAlone?: string;
+    standAlone?: boolean;
 }
 
 /**

src/dates.d.ts

@@ -1,3 +1,5 @@
+import { DateFormatNameOptions } from './cldr';
+
 /**
  * Settings for the formatDate and parseDate functions.
  */
@@ -7,6 +9,11 @@ export interface DateFormatOptions {
      */
     skeleton?: string;
 
+    /**
+     * Defines exact pattern to be used to format the date.
+     */
+    pattern?: string;
+
     /**
      * Specifies which of the locale `dateFormats` should be used to format the value.
      */
@@ -93,12 +100,28 @@ export function formatDate(value: Date, format: string|DateFormatOptions, locale
  */
 export function parseDate(value: string, format?: string | DateFormatOptions | string[] | DateFormatOptions[], locale?: string): Date;
 
+export interface DateFormatPart {
+    /**
+     * Specifies the type of the format part.
+     */
+    type?: 'era' | 'year' | 'quarter' | 'month' | 'day' | 'weekday' | 'hour' | 'minute' | 'second' | 'dayperiod' | 'zone' | 'literal';
+
+    /**
+     * Specifies the pattern of the format part.
+     */
+    pattern?: string;
+
+    /**
+     * Specifies the format names options.
+     */
+    names?: DateFormatNameOptions;
+}
+
 /**
- * Returns the full format based on the Date object and the specified format. If no format is provided, the default short date format is used.
+ * Splits the date format into objects containing information about each part of the pattern.
  *
- * @param value The date to format.
  * @param format The format string or options.
  * @param locale The optional locale id. If not specified, the `"en"` locale id is used.
- * @returns The full date format.
+ * @returns The date format parts.
  */
-export function dateFormatString(value: Date, format: string|DateFormatOptions, locale?: string): string;
+export function splitDateFormat(format: string|DateFormatOptions, locale?: string): DateFormatPart[];

src/dates/constants.js

@@ -5,25 +5,25 @@ const WEEKDAY = 'weekday';
 const QUARTER = 'quarter';
 
 const DATE_FIELD_MAP = {
+    'G': 'era',
     'y': 'year',
+    'q': QUARTER,
+    'Q': QUARTER,
     'M': MONTH,
     'L': MONTH,
     'd': 'day',
-    'E': 'weekday',
+    'E': WEEKDAY,
+    'c': WEEKDAY,
+    'e': WEEKDAY,
     'h': HOUR,
     'H': HOUR,
     'm': 'minute',
     's': 'second',
-    'a': 'dayPeriod',
+    'a': 'dayperiod',
     'x': ZONE,
     'X': ZONE,
     'z': ZONE,
-    'Z': ZONE,
-    'G': 'era',
-    'c': WEEKDAY,
-    'e': WEEKDAY,
-    'q': QUARTER,
-    'Q': QUARTER
+    'Z': ZONE
 };
 
 const dateFormatRegExp = /d{1,2}|E{1,6}|e{1,6}|c{3,6}|c{1}|M{1,5}|L{1,5}|y{1,4}|H{1,2}|h{1,2}|m{1,2}|a{1,5}|s{1,2}|S{1,3}|z{1,4}|Z{1,5}|x{1,5}|X{1,5}|G{1,5}|q{1,5}|Q{1,5}|"[^"]*"|'[^']*'/g;

src/dates/split-date-format.js

@@ -19,7 +19,7 @@ const NAME_TYPES = {
         minLength: 0
     },
 
-    dayPeriod: {
+    dayperiod: {
         nameType: 'dayPeriods',
         minLength: 0
     },
@@ -28,8 +28,20 @@ const NAME_TYPES = {
         nameType: 'eras',
         minLength: 0
     }
-
 };
+const LITERAL = 'literal';
+
+function addLiteral(parts, value) {
+    const lastPart = parts[parts.length - 1];
+    if (lastPart && lastPart.type === LITERAL) {
+        lastPart.pattern += value;
+    } else {
+        parts.push({
+            type: LITERAL,
+            pattern: value
+        });
+    }
+}
 
 export default function splitDateFormat(format, locale = 'en') {
     const info = localeInfo(locale);
@@ -42,33 +54,26 @@ export default function splitDateFormat(format, locale = 'en') {
         let value = match[0];
 
         if (lastIndex < match.index) {
-            parts.push({
-                type: 'literal',
-                pattern: pattern.substring(lastIndex, match.index)
-            });
+            addLiteral(parts, pattern.substring(lastIndex, match.index));
         }
 
         if (value.startsWith('"') || value.startsWith("'")) {
-            parts.push({
-                type: 'literal' ,
-                pattern: value
-            });
+            addLiteral(parts, value);
         } else {
             const type = DATE_FIELD_MAP[value[0]];
-            let names;
+            const part = {
+                type: type,
+                pattern: value
+            };
 
             if (NAME_TYPES[type] && value.length >= NAME_TYPES[type].minLength) {
-                names = {
+                part.names = {
                     type: NAME_TYPES[type].nameType,
                     nameType: dateNameType(value.length)
                 };
             }
 
-            parts.push({
-                type: type,
-                names: names,
-                pattern: value
-            });
+            parts.push(part);
         }
 
         lastIndex = dateFormatRegExp.lastIndex;