feat: i18n resource fully pre-compilation (#141)

* feat: i18n resource pre-compilation

* WIP: json pre-compilation

* fix: format errors

* done

* fix jest timeout

Author: kazupon

.eslintrc.js

@@ -29,6 +29,7 @@ module.exports = {
     'object-curly-spacing': 'off',
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/member-delimiter-style': 'off',
-    '@typescript-eslint/no-use-before-define': 'off'
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off'
   }
 }

README.md

@@ -16,13 +16,13 @@
 <br/>
 
 ## :star: Features
+- i18n resource pre-compilation
 - `i18n` custom block
   - i18n resource definition
   - i18n resource importing
   - Locale of i18n resource definition
   - Locale of i18n resource definition for global scope
   - i18n resource formatting
-- i18n resource optimaization
 
 
 ## :cd: Installation
@@ -39,9 +39,84 @@ $ npm i --save-dev @intlify/vue-i18n-loader@next
 $ yarn add -D @intlify/vue-i18n-loader@next
 ```
 
+## :rocket: i18n resource pre-compilation
+
+### Why do we need to require the configuration?
+
+Since [email protected], The locale messages are handled with message compiler, which converts them to javascript functions after compiling. After compiling, message compiler converts them into javascript functions, which can improve the performance of the application.
+
+However, with the message compiler, the javascript function conversion will not work in some environments (e.g. CSP). For this reason, [email protected] and later offer a full version that includes compiler and runtime, and a runtime only version.
+
+If you are using the runtime version, you will need to compile before importing locale messages by managing them in a file such as `.json`.
+
+You can pre-commpile by configuring vue-i18n-loader as the webpack loader.
+
+### Webpack configration
+
+As an example, if your project has the locale messagess in `src/locales`, your webpack config will look like this:
+
+```
+├── dist
+├── index.html
+├── package.json
+├── src
+│   ├── App.vue
+│   ├── locales
+│   │   ├── en.json
+│   │   └── ja.json
+│   └── main.js
+└── webpack.config.js
+```
+
+```js
+import { createApp } from 'vue'
+import { createI18n } from 'vue-i18n' // import from runtime only
+import App from './App.vue'
+
+// import i18n resources
+import en from './locale/en.json'
+import ja from './locale/ja.json'
+
+const i18n = createI18n({
+  locale: 'ja',
+  messages: {
+    en,
+    ja
+  }
+})
+
+const app = createApp(App)
+app.use(i18n)
+app.mount('#app')
+```
+
+In the case of the above project, you can use vue-i18n with webpack configuration to the following for runtime only:
+
+```javascript
+module.exports = {
+  module: {
+    rules: [
+      // ...
+      {
+        test: /\.(json5?|ya?ml)$/, // target json, json5, yaml and yml files
+        type: 'javascript/auto',
+        loader: '@intlify/vue-i18n-loader',
+        include: [ // Use `Rule.include` to specify the files of locale messages to be pre-compiled
+          path.resolve(__dirname, 'src/locales')
+        ]
+      },
+      // ...
+    ]
+  }
+}
+```
+
+The above uses webpack's `Rule.include` to specify the i18n resources to be precompiled. You can also use [`Rule.exclude`](https://webpack.js.org/configuration/module/#ruleexclude) to set the target.
+
+
 ## :rocket: `i18n` custom block
 
-the below example that`App.vue` have `i18n` custom block:
+The below example that`App.vue` have `i18n` custom block:
 
 ### i18n resource definition
 
@@ -89,7 +164,7 @@ The locale messages defined at `i18n` custom blocks are **json format default**.
 
 ### i18n resource importing
 
-you also can use `src` attribute:
+You also can use `src` attribute:
 
 ```vue
 <i18n src="./myLang.json"></i18n>
@@ -219,6 +294,36 @@ module.exports = {
 }
 ```
 
+## :rocket: loader options
+
+### forceStringify
+
+Whether pre-compile number and boolean values as message functions that return the string value, default `false`
+
+```javascript
+module.exports = {
+  module: {
+    rules: [
+      // ...
+      {
+        test: /\.(json5?|ya?ml)$/,
+        type: 'javascript/auto',
+        include: [path.resolve(__dirname, './src/locales')],
+        use: [
+          {
+            loader: '@intlify/vue-i18n-loader',
+            options: {
+              forceStringify: true
+            }
+          }
+        ]
+      },
+      // ...
+    ]
+  }
+}
+```
+
 ## :rocket: i18n resource optimization
 
 You can optimize your localization performance with pre-compiling the i18n resources.

e2e/composition.test.js

@@ -0,0 +1,23 @@
+describe('composition', () => {
+  beforeAll(async () => {
+    await page.goto(`http://localhost:8080/composition/`)
+  })
+
+  test('initial rendering', async () => {
+    await expect(page).toMatch('言語')
+    await expect(page).toMatch('こんにちは、世界！')
+    await expect(page).toMatch('バナナが欲しい？')
+    await expect(page).toMatch('バナナ 0 個')
+  })
+
+  test('change locale', async () => {
+    await page.select('#app select', 'en')
+    await expect(page).toMatch('Language')
+    await expect(page).toMatch('hello, world!')
+  })
+
+  test('change banana select', async () => {
+    await page.select('#fruits select', '3')
+    await expect(page).toMatch('バナナ 3 個')
+  })
+})

e2e/example.test.js

@@ -0,0 +1,16 @@
+describe.skip(`global`, () => {
+  beforeAll(async () => {
+    await page.goto(`http://localhost:8080/global/`)
+  })
+
+  test('initial rendering', async () => {
+    await expect(page).toMatch('言語')
+    await expect(page).toMatch('こんにちは、世界！')
+  })
+
+  test('change locale', async () => {
+    await page.select('#app select', 'en')
+    await expect(page).toMatch('Language')
+    await expect(page).toMatch('hello, world!')
+  })
+})

e2e/global.test.js

@@ -0,0 +1,26 @@
+describe('legacy', () => {
+  beforeAll(async () => {
+    await page.goto(`http://localhost:8080/legacy/`)
+  })
+
+  test('initial rendering', async () => {
+    await expect(page).toMatch('言語')
+    await expect(page).toMatch('こんにちは、世界！')
+    await expect(page).toMatch('バナナが欲しい？')
+    await expect(page).toMatch('バナナ 0 個')
+  })
+
+  test('change locale', async () => {
+    await page.select('#app select', 'en')
+    await expect(page).toMatch('Language')
+    await expect(page).toMatch('hello, world!')
+    await expect(page).toMatch('no bananas')
+  })
+
+  test('change banana select', async () => {
+    await page.select('#fruits select', '3')
+    await expect(page).toMatch('3 bananas')
+    await page.select('#app select', 'ja')
+    await expect(page).toMatch('バナナ 3 個')
+  })
+})

e2e/legacy.test.js

@@ -7,16 +7,22 @@
     </select>
   </form>
   <p>{{ t('hello') }}</p>
+  <Banana />
 </template>
 
 <script>
 import { useI18n } from 'vue-i18n'
+import Banana from './Banana.vue'
 
 export default {
   name: 'App',
+  components: {
+    Banana
+  },
   setup() {
     const { t, locale } = useI18n({
-      locale: 'ja'
+      inheritLocale: true,
+      useScope: 'local'
     })
     return { t, locale }
   }

example/composable/App.vue renamed to example/composition/App.vue

@@ -0,0 +1,26 @@
+<template>
+  <form id="fruits">
+    <label>{{ t('select') }}</label>
+    <select v-model.number="select">
+      <option value="0">0</option>
+      <option value="1">1</option>
+      <option value="2">2</option>
+      <option value="3">3</option>
+    </select>
+  </form>
+  <p>{{ t('fruits.banana', select, { n: select }) }}</p>
+</template>
+
+<script>
+import { ref } from 'vue'
+import { useI18n } from 'vue-i18n'
+
+export default {
+  name: 'Banana',
+  setup() {
+    const { t } = useI18n({ useScope: 'global' })
+    const select = ref(0)
+    return { t, select }
+  }
+}
+</script>

example/composition/Banana.vue

@@ -0,0 +1,3 @@
+select: What do you want banana?
+fruits:
+  banana: 'no bananas | {n} banana | {n} bananas'

example/composition/en.yaml

@@ -8,6 +8,6 @@
     <div id="app">
       <App />
     </div>
-    <script src="/dist/composable.js"></script>
+    <script src="/dist/composition.js"></script>
   </body>
 </html>