Merge pull request #3 from nutgaard/feat/inject-timezone

feat(tz): inject timezone into datetime skeletons
nutgaard · Jan 25, 2024 · 0732761 · 0732761
2 parents c512c99 + e343704
commit 0732761
Show file tree

Hide file tree

Showing 9 changed files with 111 additions and 9 deletions.
diff --git a/.github/workflows/master.yaml b/.github/workflows/master.yaml
@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 16, 18, 19 ]
+        node: [ 16, 18, 20 ]
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v3
@@ -42,7 +42,7 @@ jobs:
 #        env:
 #          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Publish package
-        if: ${{ matrix.node == '18' }}
+        if: ${{ matrix.node == '20' }}
         run: npx semantic-release
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

diff --git a/example/compiled/bundle_en.compiled.json b/example/compiled/bundle_en.compiled.json
@@ -33,7 +33,8 @@
         "parsedOptions": {
           "hour": "2-digit",
           "hourCycle": "h23",
-          "minute": "2-digit"
+          "minute": "2-digit",
+          "timeZone": "Europe/Oslo"
         },
         "pattern": "HHmm",
         "type": 1
@@ -49,7 +50,8 @@
       "style": {
         "parsedOptions": {
           "day": "2-digit",
-          "month": "short"
+          "month": "short",
+          "timeZone": "Europe/Oslo"
         },
         "pattern": "ddMMM",
         "type": 1

diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "prepare": "husky install",
     "commit": "git-cz",
     "test": "vitest --coverage",
-    "test-local": "node lib/index.js build example/messages example/compiled -f formatjs --ast --lut --strict --typescript",
+    "test-local": "node lib/index.js build example/messages example/compiled -f formatjs --ast --lut --strict --typescript --timeZone Europe/Oslo",
     "build": "rm -rf lib && tsc -p ."
   },
   "author": "Nicklas Utgaard",

diff --git a/src/builder/compile-formatjs-bundle.ts b/src/builder/compile-formatjs-bundle.ts
@@ -4,12 +4,19 @@
  */
 import { Opts } from '@formatjs/cli-lib/src/compile';
 import { resolveBuiltinFormatter } from '@formatjs/cli-lib/src/formatters';
-import { MessageFormatElement } from '@formatjs/icu-messageformat-parser/types';
-import { parse } from '@formatjs/icu-messageformat-parser';
+import {
+    parse,
+    isDateElement,
+    isTimeElement,
+    isDateTimeSkeleton,
+    MessageFormatElement,
+} from '@formatjs/icu-messageformat-parser';
 import stringify from 'json-stable-stringify';
 import { getFilesystem } from '../utils/get-filesystem';
 
-export async function compile(inputFiles: string[], opts: Opts = {}): Promise<string> {
+export type TZOpts = Opts & { timeZone?: string };
+
+export async function compile(inputFiles: string[], opts: TZOpts = {}): Promise<string> {
     const fs = getFilesystem();
     const { ast, format, skipErrors } = opts;
     const formatter = await resolveBuiltinFormatter(format);
@@ -36,7 +43,7 @@ Message from ${inputFile}: ${compiled[id]}
 `);
             }
             try {
-                const msgAst = parse(compiled[id]);
+                const msgAst = injectTimeZone(opts.timeZone, parse(compiled[id]));
                 messages[id] = compiled[id];
                 messageAsts[id] = msgAst;
                 idsWithFileName[id] = inputFile;
@@ -54,3 +61,13 @@ Message from ${inputFile}: ${compiled[id]}
         cmp: formatter.compareMessages || undefined,
     });
 }
+
+function injectTimeZone(timeZone: string | undefined, parts: MessageFormatElement[]): MessageFormatElement[] {
+    if (!timeZone) return parts;
+    return parts.map((part) => {
+        if ((isDateElement(part) || isTimeElement(part)) && isDateTimeSkeleton(part.style)) {
+            part.style.parsedOptions.timeZone = timeZone;
+        }
+        return part;
+    });
+}
diff --git a/src/commands/build.ts b/src/commands/build.ts
@@ -44,6 +44,7 @@ export default class Build {
                 const compiledFilename = path.join(config.outDir, `bundle_${locale}.compiled.json`);
                 const compiledBundle = await compile([filename], {
                     ast: true,
+                    timeZone: config.timeZone,
                 });
                 fs.writeFileSync(compiledFilename, compiledBundle, { encoding: 'utf-8' });
             }

diff --git a/src/config.ts b/src/config.ts
@@ -9,6 +9,7 @@ export interface BuildOptions {
     strict: boolean;
     ast: boolean;
     lut: boolean;
+    timeZone?: string;
     exitOnError?: boolean;
     hasFixerListener?: boolean;
 }

diff --git a/src/index.ts b/src/index.ts
@@ -16,6 +16,7 @@ program
     .option('--strict', 'Run validation before bundling', { default: false })
     .option('--ast', 'Compile generated bundles (only availble with formatjs)', { default: false })
     .option('--lut', 'Generate look-up-table', { default: false })
+    .option('-t, --timeZone <timezone>', 'Inject timezone into date/time skeletons')
     .action(({ logger, args, options }) => {
         BuildCmd.run(logger, { ...args, ...options } as unknown as BuildOptions);
     });

diff --git a/test/commands/__snapshots__/build.test.ts.snap b/test/commands/__snapshots__/build.test.ts.snap
@@ -521,3 +521,62 @@ export function createIntlLUT(intl: IntlShape<React.ReactNode>) {
 }",
 }
 `;
+
+exports[`build command > should should inject timezone into skeletons 1`] = `
+{
+  "/app/compiled/bundle_en.compiled.json": "{
+  \\"date\\": [
+    {
+      \\"type\\": 0,
+      \\"value\\": \\"starts \\"
+    },
+    {
+      \\"style\\": {
+        \\"parsedOptions\\": {
+          \\"day\\": \\"2-digit\\",
+          \\"month\\": \\"short\\",
+          \\"timeZone\\": \\"Europe/Oslo\\"
+        },
+        \\"pattern\\": \\"ddMMM\\",
+        \\"type\\": 1
+      },
+      \\"type\\": 3,
+      \\"value\\": \\"date\\"
+    },
+    {
+      \\"type\\": 0,
+      \\"value\\": \\" at \\"
+    },
+    {
+      \\"style\\": {
+        \\"parsedOptions\\": {
+          \\"hour\\": \\"2-digit\\",
+          \\"hourCycle\\": \\"h23\\",
+          \\"minute\\": \\"2-digit\\",
+          \\"timeZone\\": \\"Europe/Oslo\\"
+        },
+        \\"pattern\\": \\"HHmm\\",
+        \\"type\\": 1
+      },
+      \\"type\\": 3,
+      \\"value\\": \\"date\\"
+    }
+  ]
+}",
+  "/app/compiled/bundle_en.json": "{
+  \\"date\\": {
+    \\"defaultMessage\\": \\"starts { date, date, ::ddMMM } at { date, date, ::HHmm }\\"
+  }
+}",
+  "/app/compiled/lut.ts": "import React from \\"react\\";
+import {IntlShape} from \\"@formatjs/intl\\";
+// @ts-ignore
+import {FormatXMLElementFn} from \\"intl-messageformat\\";
+
+export function createIntlLUT(intl: IntlShape<React.ReactNode>) {
+  return {
+    \\"date\\": (args: { date: Date }) => intl.formatMessage({ id: 'date' }, {date: args.date}),
+  }
+}",
+}
+`;
diff --git a/test/commands/build.test.ts b/test/commands/build.test.ts
@@ -145,6 +145,27 @@ describe('build command', () => {
         expect(vol.toJSON('/app/compiled')).toMatchSnapshot();
     });
 
+    it('should should inject timezone into skeletons', async () => {
+        vol.fromNestedJSON(
+            {
+                'date_en.txt': 'starts { date, date, ::ddMMM } at { date, date, ::HHmm }',
+            },
+            '/app/messages',
+        );
+
+        await Build.run(createLogger(), {
+            ...defaultConfig,
+            strict: true,
+            typescript: true,
+            ast: true,
+            lut: true,
+            format: 'formatjs',
+            timeZone: 'Europe/Oslo',
+        });
+
+        expect(vol.toJSON('/app/compiled')).toMatchSnapshot();
+    });
+
     it('should throw error if validation is enabled and texts mismatch', async () => {
         vol.fromNestedJSON(
             {