Skip to content
This repository was archived by the owner on Jul 4, 2021. It is now read-only.

experimental: intlify meta info injection plugin #71

Merged
merged 1 commit into from
Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions src/injection.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import { debug as Debug } from 'debug'
import MagicString from 'magic-string'
import { isObject, isFunction, isRegExp, isString } from '@intlify/shared'

import type { Plugin, ResolvedConfig } from 'vite'

const debug = Debug('vite-plugin-vue-i18n:intlify-vue')

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type InjectionValues = Record<string, any>

console.warn(
`[@intlify/vite-i18n-vue-i18n] IntlifyVue plugin is experimental! This plugin is used for Intlify tools. Don't use this plugin to enhancement Component options of your application.`
)

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function stringifyObj(obj: Record<string, any>): string {
return `Object({${Object.keys(obj)
.map(key => {
const code = obj[key]
return `${JSON.stringify(key)}:${toCode(code)}`
})
.join(',')}})`
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function toCode(code: any): string {
if (code === null) {
return 'null'
}

if (code === undefined) {
return 'undefined'
}

if (isString(code)) {
return JSON.stringify(code)
}

if (isRegExp(code) && code.toString) {
return code.toString()
}

if (isFunction(code) && code.toString) {
return '(' + code.toString() + ')'
}

if (isObject(code)) {
return stringifyObj(code)
}

return code + ''
}

function generateCode(
values: InjectionValues,
indentifier: string,
id: string,
config: ResolvedConfig
): string {
const injectionCodes = ['']
Object.keys(values).forEach(key => {
const code = values[key]
if (isFunction(code)) {
injectionCodes.push(
`${indentifier}.${key} = ${JSON.stringify(code(id, config))}`
)
} else {
injectionCodes.push(`${indentifier}.${key} = ${toCode(code)}`)
}
})

const ret = injectionCodes.join('\n')
return ret.length > 0 ? `\n${ret}\n` : ''
}

export default function IntlifyVue(values: InjectionValues = {}): Plugin {
let config: ResolvedConfig | null = null

return {
enforce: 'post',
name: 'vite-plugin-vue-i18n:intlify-vue',
configResolved(_config: ResolvedConfig) {
config = _config
},
transform(code: string, id: string) {
debug('transform', id)
if (id.endsWith('.vue')) {
const magic = new MagicString(code)
const indentifier = '_sfc_main'
const index = code.indexOf(`export default ${indentifier}`)
magic.appendLeft(index, generateCode(values, indentifier, id, config!))
return {
code: magic.toString(),
map: magic.generateMap()
}
}
}
}
}
11 changes: 11 additions & 0 deletions test/fixtures/injections/basic.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
export default {
name: 'Meta'
}
</script>

<i18n>
{
"ja": "hello"
}
</i18n>
26 changes: 26 additions & 0 deletions test/injection.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { bundleAndRun } from './utils'

const values = {
a: 1,
b: 'hello',
c: {
a: 1,
nest: {
foo: 'hello'
}
},
d: () => {
return 'hello'
}
}

test('basic', async () => {
const { module } = await bundleAndRun('./injections/basic.vue', {
intlify: values
})
expect(module.a).toEqual(1)
expect(module.b).toEqual('hello')
expect(module.c.a).toEqual(1)
expect(module.c.nest.foo).toEqual('hello')
expect(module.d).toEqual('hello')
})
10 changes: 9 additions & 1 deletion test/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import vue from '@vitejs/plugin-vue'
import { JSDOM, VirtualConsole } from 'jsdom'
import vueI18n from '../src/index'

import type { InjectionValues } from '../src/injection'

async function bundle(fixture: string, options: Record<string, unknown> = {}) {
const input = (options.input as string) || './fixtures/entry.ts'
const target = (options.target as string) || './fixtures'
Expand All @@ -24,12 +26,18 @@ async function bundle(fixture: string, options: Record<string, unknown> = {}) {
alias['~target'] = path.resolve(__dirname, target, fixture)
}

const plugins = [vue(), vueI18n({ include })]
if (options.intlify) {
const intlifyVue = (await import('../src/injection')).default
plugins.push(intlifyVue(options.intlify as InjectionValues))
}

const result = await build({
logLevel: silent,
resolve: {
alias
},
plugins: [vue(), vueI18n({ include })],
plugins,
build: {
write: false,
minify: false,
Expand Down