Add api for managing locale messages

packages/fluent-vue-cli/README.md

@@ -0,0 +1,6 @@
+fluent-vue-cli
+=================
+
+fluent-vue tool for managing locale messages
+
+WIP

packages/fluent-vue-cli/__tests__/fixtures/Multiple.vue

@@ -0,0 +1,24 @@
+<template>
+  <div>
+    {{ $t('greeting', { name: 'World' }) }}
+  </div>
+</template>
+
+<script>
+export default {
+}
+</script>
+
+<fluent locale="en">
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+</fluent>
+
+<fluent locale="uk">
+user-name = Світ
+aria-key = Значення aria
+greeting = Привіт, {$name}
+  .aria-label = Значення мітки
+</fluent>

packages/fluent-vue-cli/__tests__/fixtures/Simple.vue

@@ -0,0 +1,17 @@
+<template>
+  <div>
+    {{ $t('greeting', { name: 'World' }) }}
+  </div>
+</template>
+
+<script>
+export default {
+}
+</script>
+
+<fluent locale="en">
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+</fluent>

packages/fluent-vue-cli/__tests__/getFtlMessages.spec.ts

@@ -0,0 +1,52 @@
+import { getFtlMessages } from '../src'
+
+describe('getVueMessages', () => {
+  it('extracts messages from ftl file', async () => {
+    // Arrange
+    const source = `
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+`
+
+    // Act
+    const messages = getFtlMessages(source)
+
+    // Assert
+    expect(messages).toMatchInlineSnapshot(`
+Object {
+  "aria-key": "Aria value",
+  "greeting": "Hello, { $name }
+    .aria-label = Label value",
+  "user-name": "World",
+}
+`)
+  })
+
+  it('ignores comments', async () => {
+    // Arrange
+    const source = `
+## Group comment
+
+# Inline comment
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+`
+
+    // Act
+    const messages = getFtlMessages(source)
+
+    // Assert
+    expect(messages).toMatchInlineSnapshot(`
+Object {
+  "aria-key": "Aria value",
+  "greeting": "Hello, { $name }
+    .aria-label = Label value",
+  "user-name": "World",
+}
+`)
+  })
+})

packages/fluent-vue-cli/__tests__/getVueMessages.spec.ts

@@ -0,0 +1,113 @@
+import { readFile } from 'fs/promises'
+import { resolve } from 'path'
+
+import { getVueMessages, MessagesWithLocale } from '../src'
+
+describe('getVueMessages', () => {
+  it('extracts locale messages from SFC', async () => {
+    // Arrange
+    const source = await readFile(resolve(__dirname, 'fixtures', './Simple.vue'))
+
+    // Act
+    const messages = getVueMessages(source.toString())
+
+    // Assert
+    expect(messages).toHaveLength(1)
+    expect(messages).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "locale": "en",
+    "messages": Object {
+      "aria-key": "Aria value",
+      "greeting": "Hello, { $name }
+    .aria-label = Label value",
+      "user-name": "World",
+    },
+  },
+]
+`)
+  })
+
+  it('extracts multiple SFC blocks', async () => {
+    // Arrange
+    const source = await readFile(resolve(__dirname, 'fixtures', './Multiple.vue'))
+
+    // Act
+    const messages = getVueMessages(source.toString())
+
+    // Assert
+    expect(messages).toHaveLength(2)
+    expect(messages).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "locale": "en",
+    "messages": Object {
+      "aria-key": "Aria value",
+      "greeting": "Hello, { $name }
+    .aria-label = Label value",
+      "user-name": "World",
+    },
+  },
+  Object {
+    "locale": "uk",
+    "messages": Object {
+      "aria-key": "Значення aria",
+      "greeting": "Привіт, { $name }
+    .aria-label = Значення мітки",
+      "user-name": "Світ",
+    },
+  },
+]
+`)
+  })
+
+  it('throws if fluent block does not have locale', () => {
+    // Arrange
+    const source = `
+<fluent>
+key = value
+</fluent>
+`
+
+    // Act
+    const func = (): MessagesWithLocale[] => getVueMessages(source)
+
+    // Assert
+    expect(func).toThrowError('fluent custom block does not have locale specified')
+  })
+
+  it('ignores non-fluent blocks', () => {
+    // Arrange
+    const source = `
+<fluent locale="en">
+key = value
+fluent-key = fluent value
+</fluent>
+
+<i18n>
+{
+  "en": {
+    "key": "value",
+    "i18n-key": "i18n value"
+  }
+}
+</i18n>
+`
+
+    // Act
+    const messages = getVueMessages(source)
+
+    // Assert
+    expect(messages).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "locale": "en",
+    "messages": Object {
+      "fluent-key": "fluent value",
+      "key": "value",
+    },
+  },
+]
+`)
+  })
+})

packages/fluent-vue-cli/__tests__/mergeFtl.spec.ts

@@ -0,0 +1,80 @@
+import { mergeFtl } from '../src'
+
+describe('mergeFtl', () => {
+  it('adds new key/values', () => {
+    // Arrange
+    const source = `
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+`
+    const newTranslation = { hello: 'Hello' }
+
+    // Act
+    const newSource = mergeFtl(source, newTranslation)
+
+    // Assert
+    expect(newSource).toMatchInlineSnapshot(`
+"user-name = World
+aria-key = Aria value
+greeting = Hello, { $name }
+    .aria-label = Label value
+hello = Hello
+"
+`)
+  })
+
+  it('preserves comments', () => {
+    // Arrange
+    const source = `
+## Group comment
+
+# Inline comment
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+`
+    const newTranslation = { 'user-name': 'John Doe' }
+
+    // Act
+    const newSource = mergeFtl(source, newTranslation)
+
+    // Assert
+    expect(newSource).toMatchInlineSnapshot(`
+"## Group comment
+
+# Inline comment
+user-name = John Doe
+aria-key = Aria value
+greeting = Hello, { $name }
+    .aria-label = Label value
+"
+`)
+  })
+
+  it('changes value if key is already present', () => {
+    // Arrange
+    const source = `
+user-name = World
+aria-key = Aria value
+greeting = Hello, {$name}
+  .aria-label = Label value
+`
+
+    const existingTranslation = { 'user-name': 'Jorn Doe' }
+
+    // Act
+    const newSource = mergeFtl(source, existingTranslation)
+
+    // Assert
+    expect(newSource).toMatchInlineSnapshot(`
+"user-name = Jorn Doe
+aria-key = Aria value
+greeting = Hello, { $name }
+    .aria-label = Label value
+"
+`)
+  })
+})