cli: emit type definition module on watch start

Author: macabeus

cli/index.js

@@ -3,18 +3,38 @@
 const chokidar = require('chokidar')
 const fs = require('fs')
 const glob = require('glob')
-const { start, buildFluentTypeModule } = require('../dist')
+const { start, updateContent, buildFluentTypeModule } = require('../dist')
 
 const startWatcher = (fileSystemApi, typeDefinitionFilepath) => {
   const typeDefinitionFilename = `${typeDefinitionFilepath}/translations.ftl.d.ts`
 
+  const emitFluentTypeModule = () => {
+    const fluentTypeModule = buildFluentTypeModule()
+
+    fileSystemApi.writeFile(
+      typeDefinitionFilename,
+      fluentTypeModule,
+      { encoding: 'utf-8' },
+      (err) => {
+        if (err) {
+          console.log('❌ Error')
+          console.log(err)
+          return
+        }
+
+        console.log(`🏁 Type definition updated: ${typeDefinitionFilename}`)
+      }
+    )
+  }
+
   glob('**/*.ftl', { ignore: ['node_modules/**/*', '.git/**/*'] }, (errors, matches) => {
     const files = matches.map(path => ({
       path,
       content: fileSystemApi.readFileSync(path, { encoding: 'utf-8' }),
     }))
 
     start(files)
+    emitFluentTypeModule()
   })
 
   const watcher = chokidar.watch('**/*.ftl', { ignored: ['node_modules/**/*', '.git/**/*'] })
@@ -25,22 +45,9 @@ const startWatcher = (fileSystemApi, typeDefinitionFilepath) => {
       console.log(`🔍 File was changed: ${path}`)
 
       const content = fileSystemApi.readFileSync(path, { encoding: 'utf-8' })
-      const fluentTypeModule = buildFluentTypeModule({ path, content })
-
-      fileSystemApi.writeFile(
-        typeDefinitionFilename,
-        fluentTypeModule,
-        { encoding: 'utf-8' },
-        (err) => {
-          if (err) {
-            console.log('❌ Error')
-            console.log(err)
-            return
-          }
-
-          console.log(`🏁 Type definition updated: ${typeDefinitionFilename}`)
-        }
-      )
+      updateContent({ path, content })
+
+      emitFluentTypeModule()
     })
 }
 

src/index.ts

@@ -4,12 +4,11 @@ import { updateGlobalState } from './global-state'
 const start = (files: CliFluentFile[]) =>
   files.forEach(file => updateGlobalState({ type: 'addContent', payload: file }))
 
-const buildFluentTypeModule = (file: CliFluentFile) => {
+const updateContent = (file: CliFluentFile) =>
   updateGlobalState({ type: 'updateContent', payload: file })
-  const fluentTypeModule = build()
-  return fluentTypeModule
-}
+
+const buildFluentTypeModule = build
 
 // TODO: is necessary to export as common js to be available to cli.js
 // but probably there are better approach to do that
-module.exports = { start, buildFluentTypeModule }
+module.exports = { start, updateContent, buildFluentTypeModule }

test/index.test.ts

@@ -1,8 +1,8 @@
 import dedent from 'dedent-js'
-const { buildFluentTypeModule, start } = require('../src')
+const { start, updateContent, buildFluentTypeModule } = require('../src')
 
 test('Should match the types definitions', async () => {
-  const fixturePt = dedent`
+  const fixturePtFirstVersion = dedent`
     hello = Olá { $firstName }
     how-are-you = Como você está?
     bye = Tchau
@@ -13,13 +13,12 @@ test('Should match the types definitions', async () => {
   `
 
   start([
-    { path: 'pt.ftl', content: fixturePt },
+    { path: 'pt.ftl', content: fixturePtFirstVersion },
     { path: 'jp.ftl', content: fixtureJp },
   ])
 
-  const fluentTypeModule = buildFluentTypeModule({ path: 'pt.ftl', content: fixturePt })
-
-  expect(fluentTypeModule).toBe(dedent`
+  const fluentTypeModuleFirstVersion = buildFluentTypeModule()
+  expect(fluentTypeModuleFirstVersion).toBe(dedent`
     // This file is automatically generated.
     // Please do not change this file!
 
@@ -51,4 +50,41 @@ test('Should match the types definitions', async () => {
       : never
     )
   `)
+
+  const fixturePtSecondVersion = dedent`
+    hello = Olá { $firstName }
+    how-are-you = Como você está?
+  `
+  updateContent({ path: 'pt.ftl', content: fixturePtSecondVersion })
+
+  const fluentTypeModuleSecondVersion = buildFluentTypeModule()
+  expect(fluentTypeModuleSecondVersion).toBe(dedent`
+    // This file is automatically generated.
+    // Please do not change this file!
+
+    import { FluentBundle, FluentArgument } from '@fluent/bundle'
+
+    type Message<T extends MessagesKey> = {
+      id: T
+      value: T
+      attributes: Record<string, T>
+    }
+
+    declare global {
+      interface FluentBundleTyped extends FluentBundle {
+        getMessage<T extends MessagesKey>(id: T): Message<T>
+        formatPattern: <T extends MessagesKey>(...args: PatternArguments<T>) => string
+      }
+    }
+
+    type MessagesKey = 'hello' |
+    'how-are-you'
+    type PatternArguments<T extends MessagesKey> = (
+      T extends 'hello'
+      ? [T, { 'firstName': FluentArgument,'lastName': FluentArgument }]:
+    T extends 'how-are-you'
+      ? [T]
+      : never
+    )
+  `)
 })