Merge pull request #2 from macabeus/feat/review

Improve code sanity

Author: macabeus

example/assets/locales/pt-br/translations.ftl.d.ts

@@ -1,12 +1,11 @@
 // This file is automatically generated.
 // Please do not change this file!
 
-import { ComplexPattern } from '@fluent/bundle/esm/ast'
-import { FluentBundle } from '@fluent/bundle'
+import { FluentBundle, FluentArgument } from '@fluent/bundle'
 
-type Pattern<T> = T | ComplexPattern
+type Pattern<T extends MessagesKey> = T | Parameters<FluentBundle['formatPattern']>[0]
 
-type Message<T> = {
+type Message<T extends MessagesKey> = {
   id: T
   value: Pattern<T>
   attributes: Record<string, Pattern<T>>
@@ -15,7 +14,7 @@ type Message<T> = {
 declare global {
   interface FluentBundleTyped extends FluentBundle {
     getMessage<T extends MessagesKey>(id: T): Message<T>
-    formatPattern<T extends MessagesKey>(pattern: Pattern<T>, args?: PatternArguments<T>, errors?: Array<Error> | null): string
+    formatPattern: <T extends MessagesKey>(pattern: Pattern<T>, ...args: PatternArguments<T>) => string
   }
 }
 
@@ -24,10 +23,10 @@ type MessagesKey = 'hello' |
 'bye'
 type PatternArguments<T extends MessagesKey> = (
   T extends 'hello'
-  ? { 'name': string | number }:
+  ? [{ 'name': FluentArgument }]:
 T extends 'how-are-you'
-  ? undefined:
+  ? []:
 T extends 'bye'
-  ? undefined
+  ? []
   : never
 )

package-lock.json

@@ -17,7 +17,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@fluent/bundle": "0.15.1",
+    "@fluent/syntax": "0.15.0",
     "chokidar": "3.4.0",
     "dedent-js": "1.0.1",
     "loader-utils": "2.0.0"

package.json

@@ -5,12 +5,11 @@ const bannerMessage = (
 )
 
 const header = dedent`
-  import { ComplexPattern } from '@fluent/bundle/esm/ast'
-  import { FluentBundle } from '@fluent/bundle'
+  import { FluentBundle, FluentArgument } from '@fluent/bundle'
   
-  type Pattern<T> = T | ComplexPattern
+  type Pattern<T extends MessagesKey> = T | Parameters<FluentBundle['formatPattern']>[0]
   
-  type Message<T> = {
+  type Message<T extends MessagesKey> = {
     id: T
     value: Pattern<T>
     attributes: Record<string, Pattern<T>>
@@ -19,7 +18,7 @@ const header = dedent`
   declare global {
     interface FluentBundleTyped extends FluentBundle {
       getMessage<T extends MessagesKey>(id: T): Message<T>
-      formatPattern<T extends MessagesKey>(pattern: Pattern<T>, args?: PatternArguments<T>, errors?: Array<Error> | null): string
+      formatPattern: <T extends MessagesKey>(pattern: Pattern<T>, ...args: PatternArguments<T>) => string
     }
   }
 `

src/build-header.js

@@ -1,6 +1,9 @@
-const buildTypeMessagesKey = (resource) => {
-  const interfaceFields = resource
-    .map(message => `'${message.id}'`)
+const buildTypeMessagesKey = (ast) => {
+  const messages = ast.body
+    .filter(node => node.type === 'Message')
+
+  const interfaceFields = messages
+    .map(message => `'${message.id.name}'`)
     .join(' |\n')
 
   return `type MessagesKey = ${interfaceFields}`

src/build-type-messages-key.js

@@ -1,39 +1,31 @@
 import dedent from 'dedent-js'
 
-const messageVariables = (message) => {
-  if (typeof message.value === 'string') {
-    return []
-  }
-
-  const variables = message.value.reduce(
-    (acc, current) => current.type === 'var'
-      ? [...acc, current.name]
-      : acc
-    , []
-  )
-
-  return variables
-}
+const messageVariablesName = (message) =>
+  message.value.elements
+    .filter(element => element.type === 'Placeable')
+    .filter(placeable => placeable.expression.type === 'VariableReference')
+    .map(placeable => placeable.expression.id.name)
 
-const wrapVariables = variables => variables.map(i => `'${i}': string | number`)
+const wrapVariables = variables => variables.map(i => `'${i}': FluentArgument`)
 
 const hasVariables = variables => variables.length > 0
 
-const buildTypePatternArguments = (resource) => {
-  const options = resource
+const buildTypePatternArguments = (ast) => {
+  const messages = ast.body
+  const options = messages
     .map(message => {
-      const variables = messageVariables(message)
+      const variablesName = messageVariablesName(message)
 
-      if (hasVariables(variables)) {
+      if (hasVariables(variablesName)) {
         return dedent`
-          T extends '${message.id}'
-            ? { ${wrapVariables(messageVariables(message)).join(',')} }
+          T extends '${message.id.name}'
+            ? [{ ${wrapVariables(variablesName).join(',')} }]
         `
       }
 
       return dedent`
-        T extends '${message.id}'
-          ? undefined
+        T extends '${message.id.name}'
+          ? []
       `
     }).join(':\n')
 

src/build-type-pattern-arguments.js

@@ -1,15 +1,17 @@
-import { FluentResource } from '@fluent/bundle'
+import { FluentParser } from '@fluent/syntax'
 import dedent from 'dedent-js'
 import buildHeader from './build-header'
 import buildTypeMessagesKey from './build-type-messages-key'
 import buildTypePatternArguments from './build-type-pattern-arguments'
 
 const buildFluentTypeModule = (content) => {
-  const resource = (new FluentResource(content)).body
+  const parser = new FluentParser({ withSpans: false })
+  const ast = parser.parse(content)
+
   const fluentTypeModule = dedent`
     ${buildHeader()}
-    ${buildTypeMessagesKey(resource)}
-    ${buildTypePatternArguments(resource)}
+    ${buildTypeMessagesKey(ast)}
+    ${buildTypePatternArguments(ast)}
   `
 
   return fluentTypeModule

src/index.js

@@ -14,12 +14,11 @@ test('Should match the types definitions', async () => {
     // This file is automatically generated.
     // Please do not change this file!
 
-    import { ComplexPattern } from '@fluent/bundle/esm/ast'
-    import { FluentBundle } from '@fluent/bundle'
+    import { FluentBundle, FluentArgument } from '@fluent/bundle'
 
-    type Pattern<T> = T | ComplexPattern
+    type Pattern<T extends MessagesKey> = T | Parameters<FluentBundle['formatPattern']>[0]
 
-    type Message<T> = {
+    type Message<T extends MessagesKey> = {
       id: T
       value: Pattern<T>
       attributes: Record<string, Pattern<T>>
@@ -28,7 +27,7 @@ test('Should match the types definitions', async () => {
     declare global {
       interface FluentBundleTyped extends FluentBundle {
         getMessage<T extends MessagesKey>(id: T): Message<T>
-        formatPattern<T extends MessagesKey>(pattern: Pattern<T>, args?: PatternArguments<T>, errors?: Array<Error> | null): string
+        formatPattern: <T extends MessagesKey>(pattern: Pattern<T>, ...args: PatternArguments<T>) => string
       }
     }
 
@@ -37,11 +36,11 @@ test('Should match the types definitions', async () => {
     'bye'
     type PatternArguments<T extends MessagesKey> = (
       T extends 'hello'
-      ? { 'name': string | number }:
+      ? [{ 'name': FluentArgument }]:
     T extends 'how-are-you'
-      ? undefined:
+      ? []:
     T extends 'bye'
-      ? undefined
+      ? []
       : never
     )
   `)