fix(errors): return errors

Author: philibea

packages/validate-icu-locales/README.md

@@ -15,7 +15,7 @@ We can parse JSON, TS and JS if theses files use default export.
 
 
 ```
-@scaleway/validate-icu-locales "../**/en.json"
+validate-icu "../**/en.json"
 ```
 
 If there is an error on a local, the CLI will throw an Error and print all errors.
@@ -27,22 +27,22 @@ export default from:  ../src/__tests__/locales/en-1.js  is not an object
 {
   errors: [
     {
-      err: [SyntaxError],
+      message: 'EXPECT_ARGUMENT_CLOSING_BRACE',
       value: '{count, plural, =0 {Minute} =1 {Minute} other {Minutes',
       key: 'units.minutes.label',
-      filePath: '../src/__tests__/locales/en.js'
+      filePath: '../../packages/validate-icu-locales/src/__tests__/locales/en.js'
     },
     {
-      err: [SyntaxError],
+      message: 'EXPECT_ARGUMENT_CLOSING_BRACE',
       value: '{count, plural, =0 {Minute} =1 {Minute} other {Minutes',
       key: 'units.minutes.label',
-      filePath: '../src/__tests__/locales/en.json'
+      filePath: '../../packages/validate-icu-locales/src/__tests__/locales/en.json'
     },
     {
-      err: [SyntaxError],
+      message: 'EXPECT_ARGUMENT_CLOSING_BRACE',
       value: '{count, plural, =0 {Minute} =1 {Minute} other {Minutes',
       key: 'units.minutes.label',
-      filePath: '../src/__tests__/locales/en.ts'
+      filePath: '../../packages/validate-icu-locales/src/__tests__/locales/en.ts'
     }
   ]
 }

packages/validate-icu-locales/package.json

@@ -8,7 +8,9 @@
     "cli"
   ],
   "type": "module",
-  "bin": "dist/index.js",
+  "bin": {
+    "validate-icu": "dist/index.js"
+   },
   "publishConfig": {
     "access": "public"
   },

packages/validate-icu-locales/src/__tests__/locales/en-no-default.ts

@@ -0,0 +1,9 @@
+export const toto = {
+  //  error on this one missing bracket
+
+  'units.minutes.label':
+    '{count, plural, =0 {Minute} =1 {Minute} other {Minutes',
+  'units.hours.label': '{count, plural, =0 {Hour} =1 {Hour} other {Hours}}',
+  'units.days.label': '{count, plural, =0 {Day} =1 {Day} other {Days}}',
+  'units.months.label': '{count, plural, =0 {Month} =1 {Month} other {Months}}',
+} as const

packages/validate-icu-locales/src/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { parse } from '@formatjs/icu-messageformat-parser'
-import { info } from 'console'
+import { ParserError } from '@formatjs/icu-messageformat-parser/error'
 import { readFile } from 'fs/promises'
 import { globby } from 'globby'
 import { importFromString } from 'module-from-string'
@@ -10,27 +10,51 @@ const args = process.argv.slice(2)
 const pattern = args[0]
 const { error, table } = console
 
-let isICUError = false
-
-const findICUError = (locales: { [key: string]: string }, filePath: string) => {
-  Object.keys(locales).forEach(key => {
-    const value = locales[key]
-
-    try {
-      parse(value)
-    } catch (err) {
-      isICUError = true
-      error({
-        err,
-        value,
-        key,
-        filePath,
-      })
-    }
-  })
+type Locales = Record<string, string>
+type ErrorICU = {
+  message: ParserError['message']
+  value: string
+  key: string
+  filePath: string
+}
+
+type ErrorsICU = (ErrorICU | undefined)[]
+
+const isObject = (obj: unknown) => obj === Object(obj)
+
+const findICUErrors = (
+  locales: { [key: string]: string },
+  filePath: string,
+): ErrorsICU => {
+  const keys = Object.keys(locales)
+
+  const errors = keys
+    .map(key => {
+      const value = locales[key]
+
+      try {
+        parse(value)
+
+        return undefined
+      } catch (err) {
+        const { message } = err as ParserError
+
+        return {
+          message,
+          value,
+          key,
+          filePath,
+        }
+      }
+    })
+    .filter(x => x)
+
+  return errors
 }
 
-const readFiles = async (files: string[]) => {
+const readFiles = async (files: string[]): Promise<ErrorsICU> => {
+  const errors = []
+
   for await (const file of files) {
     const extension = file.split('.').pop()
 
@@ -39,9 +63,10 @@ const readFiles = async (files: string[]) => {
         const data = await readFile(file)
         const jsonFile = data.toString()
 
-        const locales = JSON.parse(jsonFile) as Record<string, string>
+        const locales = JSON.parse(jsonFile) as Locales
 
-        findICUError(locales, file)
+        const ICUErrors = findICUErrors(locales, file)
+        errors.push(...ICUErrors)
       } catch (err) {
         error({ file, err })
       }
@@ -52,37 +77,44 @@ const readFiles = async (files: string[]) => {
         const data = await readFile(file)
         const javascriptFile = data.toString()
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const d: { default: Record<string, string> } = await importFromString(
-          javascriptFile,
-          { transformOptions: { loader: 'ts' } },
-        )
-
-        if (typeof d.default === 'object') {
-          findICUError(d.default, file)
+        const mod: unknown = await importFromString(javascriptFile, {
+          transformOptions: { loader: 'ts' },
+        })
+
+        if (isObject(mod)) {
+          if ('default' in Object(mod)) {
+            const { default: locales } = mod as { default: Locales }
+            const ICUErrors = findICUErrors(locales, file)
+            errors.push(...ICUErrors)
+          } else {
+            error('export default from: ', file, ' is not an object')
+          }
         } else {
-          error('export default from: ', file, ' is not an object')
+          error(file, ' is not an object')
         }
       } catch (err) {
         error({ err, file })
       }
     }
   }
+
+  return errors
 }
 
 const files = await globby(pattern)
 
-if (files.length > 0) {
-  table(files)
-  await readFiles(files)
-}
-
 if (files.length === 0) {
-  info('There is no files matching this pattern', pattern)
+  error('There is no files matching this pattern', pattern)
+  process.exit(1)
 }
 
-if (isICUError) {
+table(files)
+
+const errors = await readFiles(files)
+
+if (errors.length > 0) {
+  error({
+    errors,
+  })
   process.exit(1)
-} else {
-  process.exit(0)
 }

rollup.config.mjs

@@ -74,7 +74,7 @@ export default async () => {
   const doesAlsoTargetBrowser = 'browser' in pkg
 
   return [
-    getConfig(pkg, false),
+    getConfig(pkg),
     doesAlsoTargetBrowser && getConfig(pkg, true),
     {
       input: './src/index.ts',