@varlet/cli 1.27.10 → 1.27.11-alpha.1653989396088

package/generators/config/i18n/sfc/src/locale/__tests__/index.spec.js

@@ -0,0 +1,51 @@
+import enUS from '../en-US'
+import { useLocale } from '../index'
+
+function mockConsole(method, fn = () => {}) {
+  const originMethod = console[method]
+
+  console[method] = fn
+
+  return {
+    mockRestore() {
+      console[method] = originMethod
+    },
+  }
+}
+
+test('test add lang', () => {
+  const { add, use, pack, packs } = useLocale()
+
+  const LANG = 'custom'
+  const PACK = {
+    button: 'Custom Text',
+  }
+
+  add(LANG, PACK)
+  use(LANG)
+
+  expect(pack.value.lang).toBe(LANG)
+  expect(packs[LANG]).toBe(PACK)
+})
+
+test('test merge lang', () => {
+  const fn = jest.fn()
+  const { mockRestore } = mockConsole('warn', fn)
+  const { add, use, merge, pack } = useLocale()
+
+  const LANG = 'en-US'
+  const PACK = {
+    dialogTitle: 'Custom Text',
+  }
+
+  add(LANG, enUS)
+  use('zh_HK')
+  use(LANG)
+  merge('zh_HK', PACK)
+  merge(LANG, PACK)
+
+  expect(pack.value.button).toBe('Custom Text')
+  expect(fn).toHaveBeenCalledTimes(2)
+
+  mockRestore()
+})

package/generators/config/i18n/sfc/src/locale/docs/en-US.md

@@ -0,0 +1,32 @@
+# Locale
+
+### Intro
+Component library uses Chinese as the default language, support multi-language switch,
+built-in support for `Chinese`, `English`.
+
+### Multi-language switch
+The `Locale` component is introduced to realize multi-language switching, and `Locale.add` is used for language extension.
+
+```js
+// playground-ignore
+import { Locale } from 'packages/varlet-ui/types/index'
+import enUS from 'packages/varlet-ui/es/locale/en-US'
+
+Locale.add('en-US', enUS)
+```
+
+Use `Locale.use` to switch languages.
+
+```js
+// playground-ignore
+Locale.use('en-US')
+```
+
+Use `Locale.merge` to merge languages.
+
+```js
+// playground-ignore
+Locale.merge('en-US', {
+  button: 'Hello'
+})
+```

package/generators/config/i18n/sfc/src/locale/docs/zh-CN.md

@@ -0,0 +1,31 @@
+# 国际化
+
+### 介绍
+组件库使用中文作为默认语言，支持多语言切换，内置支持 `中文`，`英文`。
+
+### 多语言切换
+引入 `Locale` 组件实现多语言切换，使用 `Locale.add` 进行语言扩展。
+
+```js
+// playground-ignore
+import { Locale } from 'packages/varlet-ui/types/index'
+import enUS from 'packages/varlet-ui/es/locale/en-US'
+
+Locale.add('en-US', enUS)
+```
+
+使用 `Locale.use` 进行切换语言
+
+```js
+// playground-ignore
+Locale.use('en-US')
+```
+
+使用 `Locale.merge` 进行语言合并
+
+```js
+// playground-ignore
+Locale.merge('en-US', {
+  button: 'Hello'
+})
+```

package/generators/config/i18n/sfc/src/locale/en-US.d.ts

@@ -0,0 +1,5 @@
+import type { Pack } from '../../types'
+
+declare const enUS: Pack
+
+export default enUS

package/generators/config/i18n/sfc/src/locale/en-US.ts

@@ -0,0 +1,7 @@
+import { Pack } from './index'
+
+// for component's internal
+export default {
+  // Button component
+  button: 'Button'
+} as Pack

package/generators/config/i18n/sfc/src/locale/index.ts

@@ -0,0 +1,67 @@
+import { ref } from 'vue'
+import type { Ref } from 'vue'
+import zhCN from './zh-CN'
+
+export type Pack = {
+  // Button component
+  button: string
+
+  // internal
+  lang?: string
+}
+
+function useLocale<T = Pack>() {
+  const packs: Record<string, Partial<T>> = {}
+  const pack: Ref<Partial<T>> = ref({})
+
+  const add = (lang: string, pack: Partial<T> & { lang?: string }) => {
+    pack.lang = lang
+    packs[lang] = pack
+  }
+
+  const use = (lang: string) => {
+    if (!packs[lang]) {
+      console.warn(`The ${lang} does not exist. You can mount a language package using the add method`)
+      return {}
+    }
+
+    pack.value = packs[lang]
+  }
+
+  const merge = (lang: string, pack: Partial<T>) => {
+    if (!packs[lang]) {
+      console.warn(`The ${lang} does not exist. You can mount a language package using the add method`)
+      return
+    }
+
+    packs[lang] = { ...packs[lang], ...pack }
+
+    use(lang)
+  }
+
+  return {
+    packs,
+    pack,
+    add,
+    use,
+    merge,
+  }
+}
+
+const { packs, pack, add, use, merge } = useLocale()
+
+add('zh-CN', zhCN)
+use('zh-CN')
+
+export { packs, pack, add, use, merge, useLocale }
+
+export const _LocaleComponent = { packs, pack, add, use, merge, useLocale }
+
+export default {
+  packs,
+  pack,
+  add,
+  use,
+  merge,
+  useLocale,
+}

package/generators/config/i18n/sfc/src/locale/zh-CN.d.ts

@@ -0,0 +1,5 @@
+import type { Pack } from '../../types'
+
+declare const zhCN: Pack
+
+export default zhCN

package/generators/config/i18n/sfc/src/locale/zh-CN.ts

@@ -0,0 +1,7 @@
+import { Pack } from './index'
+
+// for component's internal
+export default {
+  // Button component
+  button: '按钮'
+} as Pack

package/generators/config/i18n/tsx/src/button/Button.tsx

@@ -0,0 +1,35 @@
+import { defineComponent, PropType } from 'vue'
+import './button.less'
+
+// i18n for component's internal
+// import { pack } from '../locale'
+
+export default defineComponent({
+  name: 'BButton',
+  props: {
+    color: {
+      type: String
+    },
+    onClick: {
+      type: Function as PropType<(e: Event) => void>
+    }
+  },
+  setup(props, { slots }) {
+    const handleClick = (e: Event) => props.onClick?.(e)
+
+    return () => {
+      const { color } = props
+
+      return <>
+        <button
+          class="basic-button"
+          style={{ background: color }}
+          onClick={ handleClick }
+        >
+          {/*{ pack.value.button }*/}
+          { slots.default?.() }
+        </button>
+      </>
+    }
+  }
+})

package/generators/config/i18n/tsx/src/button/__tests__/index.spec.js

@@ -0,0 +1,7 @@
+import Button from '../index'
+import { createApp } from 'vue'
+
+test('test button use', () => {
+  const app = createApp({}).use(Button)
+  expect(app.component(Button.name)).toBeTruthy()
+})

package/generators/config/i18n/tsx/src/button/button.less

@@ -0,0 +1,14 @@
+.basic-button {
+  display: flex;
+  padding: 10px;
+  background: #009688;
+  color: #fff;
+  outline: none;
+  border: none;
+  border-radius: 2px;
+  cursor: pointer;
+
+  &:active {
+    opacity: 0.9
+  }
+}

package/generators/config/i18n/tsx/src/button/docs/en-US.md

@@ -0,0 +1,39 @@
+# Button
+
+### Basic Use
+```html
+<b-button>start</b-button>
+```
+
+```vue
+import BasicUse from '../example/BasicUse'
+```
+
+### Theme Color Button
+```html
+<b-button color="#009688">start</b-button>
+```
+
+```vue
+import ModifyColor from '../example/ModifyColor'
+```
+
+## API
+
+### Props
+
+| Prop  | Description | Type | Default |
+| --- | --- | --- | --- | 
+| `color` | 按钮颜色 | _string_ | `default` |
+
+### Events
+
+| Event | Description | Arguments |
+| --- | --- | --- |
+| `click` | Triggered when the button is clicked | `event: Event` |
+
+### Slots
+
+| Slot      | Description | Arguments |
+|-----------| --- | --- |
+| `default` | Button content | `-` |

package/generators/config/i18n/tsx/src/button/docs/zh-CN.md

@@ -0,0 +1,39 @@
+# 按钮
+
+### 基本使用
+```html
+<b-button>组件库从我开始</b-button>
+```
+
+```vue
+import BasicUse from '../example/BasicUse'
+```
+
+### 主题色按钮
+```html
+<b-button color="#009688">组件库从我开始</b-button>
+```
+
+```vue
+import ModifyColor from '../example/ModifyColor'
+```
+
+## API
+
+### 属性
+
+| 参数 | 说明 | 类型 | 默认值 | 
+| --- | --- | --- | --- | 
+| `color` | 按钮颜色 | _string_ | `default` |
+
+### 事件
+
+| 事件名 | 说明 | 参数 |
+| --- | --- | --- |
+| `click` | 点击按钮时触发 | `event: Event` |
+
+### 插槽
+
+| 插槽名 | 说明 | 参数 |
+| --- | --- | --- |
+| `default` | 按钮内容 | `-` |

package/generators/config/i18n/tsx/src/button/example/BasicUse.vue

@@ -0,0 +1,11 @@
+<script setup>
+import Button from '../Button'
+import { pack, use } from './locale'
+import { watchLang } from 'packages/varlet-cli/site/utils'
+
+watchLang(use)
+</script>
+
+<template>
+  <b-button>{{ pack.start }}</b-button>
+</template>

package/generators/config/i18n/tsx/src/button/example/ModifyColor.vue

@@ -0,0 +1,11 @@
+<script setup>
+import Button from '../Button'
+import { pack, use } from './locale'
+import { watchLang } from 'packages/varlet-cli/site/utils'
+
+watchLang(use)
+</script>
+
+<template>
+  <b-button color="#03A9F4">{{ pack.start }}</b-button>
+</template>

package/generators/config/i18n/tsx/src/button/example/index.vue

@@ -0,0 +1,17 @@
+<script setup>
+import AppType from '@varlet/cli/site/mobile/components/AppType'
+import BasicUse from './BasicUse'
+import ModifyColor from './ModifyColor'
+import { pack, use } from './locale'
+import { watchLang } from 'packages/varlet-cli/site/utils'
+
+watchLang(use)
+</script>
+
+<template>
+  <app-type>{{ pack.basicUse }}</app-type>
+  <basic-use/>
+
+  <app-type>{{ pack.modifyColor }}</app-type>
+  <modify-color/>
+</template>

package/generators/config/i18n/tsx/src/button/example/locale/en-US.ts

@@ -0,0 +1,5 @@
+export default {
+  basicUse: 'Basic use',
+  modifyColor: 'Modify Color',
+  start: 'Start'
+}

package/generators/config/i18n/tsx/src/button/example/locale/index.ts

@@ -0,0 +1,23 @@
+// lib
+import _zhCN from '../../../locale/zh-CN'
+import _enCN from '../../../locale/en-US'
+// mobile example doc
+import zhCN from './zh-CN'
+import enUS from './en-US'
+import { useLocale, add as _add, use as _use } from '../../../locale'
+
+const { add, use: exampleUse, pack, packs, merge } = useLocale()
+
+const use = (lang: string) => {
+  _use(lang)
+  exampleUse(lang)
+}
+
+export { add, pack, packs, merge, use }
+
+// lib
+_add('zh-CN', _zhCN)
+_add('en-US', _enCN)
+// mobile example doc
+add('zh-CN', zhCN as any)
+add('en-US', enUS as any)

package/generators/config/i18n/tsx/src/button/example/locale/zh-CN.ts

@@ -0,0 +1,5 @@
+export default {
+  basicUse: '基本使用',
+  modifyColor: '修改颜色',
+  start: '起步'
+}

package/generators/config/i18n/tsx/src/button/index.ts

@@ -0,0 +1,10 @@
+import type { App } from 'vue'
+import Button from './Button.vue'
+
+Button.install = function (app: App) {
+  app.component(Button.name, Button)
+}
+
+export const _ButtonComponent = Button
+
+export default Button

package/generators/config/i18n/tsx/src/locale/__tests__/index.spec.js

@@ -0,0 +1,51 @@
+import enUS from '../en-US'
+import { useLocale } from '../index'
+
+function mockConsole(method, fn = () => {}) {
+  const originMethod = console[method]
+
+  console[method] = fn
+
+  return {
+    mockRestore() {
+      console[method] = originMethod
+    },
+  }
+}
+
+test('test add lang', () => {
+  const { add, use, pack, packs } = useLocale()
+
+  const LANG = 'custom'
+  const PACK = {
+    button: 'Custom Text',
+  }
+
+  add(LANG, PACK)
+  use(LANG)
+
+  expect(pack.value.lang).toBe(LANG)
+  expect(packs[LANG]).toBe(PACK)
+})
+
+test('test merge lang', () => {
+  const fn = jest.fn()
+  const { mockRestore } = mockConsole('warn', fn)
+  const { add, use, merge, pack } = useLocale()
+
+  const LANG = 'en-US'
+  const PACK = {
+    dialogTitle: 'Custom Text',
+  }
+
+  add(LANG, enUS)
+  use('zh_HK')
+  use(LANG)
+  merge('zh_HK', PACK)
+  merge(LANG, PACK)
+
+  expect(pack.value.button).toBe('Custom Text')
+  expect(fn).toHaveBeenCalledTimes(2)
+
+  mockRestore()
+})

package/generators/config/i18n/tsx/src/locale/docs/en-US.md

@@ -0,0 +1,32 @@
+# Locale
+
+### Intro
+Component library uses Chinese as the default language, support multi-language switch,
+built-in support for `Chinese`, `English`.
+
+### Multi-language switch
+The `Locale` component is introduced to realize multi-language switching, and `Locale.add` is used for language extension.
+
+```js
+// playground-ignore
+import { Locale } from 'packages/varlet-ui/types/index'
+import enUS from 'packages/varlet-ui/es/locale/en-US'
+
+Locale.add('en-US', enUS)
+```
+
+Use `Locale.use` to switch languages.
+
+```js
+// playground-ignore
+Locale.use('en-US')
+```
+
+Use `Locale.merge` to merge languages.
+
+```js
+// playground-ignore
+Locale.merge('en-US', {
+  button: 'Hello'
+})
+```

package/generators/config/i18n/tsx/src/locale/docs/zh-CN.md

@@ -0,0 +1,31 @@
+# 国际化
+
+### 介绍
+组件库使用中文作为默认语言，支持多语言切换，内置支持 `中文`，`英文`。
+
+### 多语言切换
+引入 `Locale` 组件实现多语言切换，使用 `Locale.add` 进行语言扩展。
+
+```js
+// playground-ignore
+import { Locale } from 'packages/varlet-ui/types/index'
+import enUS from 'packages/varlet-ui/es/locale/en-US'
+
+Locale.add('en-US', enUS)
+```
+
+使用 `Locale.use` 进行切换语言
+
+```js
+// playground-ignore
+Locale.use('en-US')
+```
+
+使用 `Locale.merge` 进行语言合并
+
+```js
+// playground-ignore
+Locale.merge('en-US', {
+  button: 'Hello'
+})
+```

package/generators/config/i18n/tsx/src/locale/en-US.d.ts

@@ -0,0 +1,5 @@
+import type { Pack } from '../../types'
+
+declare const enUS: Pack
+
+export default enUS

package/generators/config/i18n/tsx/src/locale/en-US.ts

@@ -0,0 +1,7 @@
+import { Pack } from './index'
+
+// for component's internal
+export default {
+  // Button component
+  button: 'Button'
+} as Pack

package/generators/config/i18n/tsx/src/locale/index.ts

@@ -0,0 +1,67 @@
+import { ref } from 'vue'
+import type { Ref } from 'vue'
+import zhCN from './zh-CN'
+
+export type Pack = {
+  // Button component
+  button: string
+
+  // internal
+  lang?: string
+}
+
+function useLocale<T = Pack>() {
+  const packs: Record<string, Partial<T>> = {}
+  const pack: Ref<Partial<T>> = ref({})
+
+  const add = (lang: string, pack: Partial<T> & { lang?: string }) => {
+    pack.lang = lang
+    packs[lang] = pack
+  }
+
+  const use = (lang: string) => {
+    if (!packs[lang]) {
+      console.warn(`The ${lang} does not exist. You can mount a language package using the add method`)
+      return {}
+    }
+
+    pack.value = packs[lang]
+  }
+
+  const merge = (lang: string, pack: Partial<T>) => {
+    if (!packs[lang]) {
+      console.warn(`The ${lang} does not exist. You can mount a language package using the add method`)
+      return
+    }
+
+    packs[lang] = { ...packs[lang], ...pack }
+
+    use(lang)
+  }
+
+  return {
+    packs,
+    pack,
+    add,
+    use,
+    merge,
+  }
+}
+
+const { packs, pack, add, use, merge } = useLocale()
+
+add('zh-CN', zhCN)
+use('zh-CN')
+
+export { packs, pack, add, use, merge, useLocale }
+
+export const _LocaleComponent = { packs, pack, add, use, merge, useLocale }
+
+export default {
+  packs,
+  pack,
+  add,
+  use,
+  merge,
+  useLocale,
+}

package/generators/config/i18n/tsx/src/locale/zh-CN.d.ts

@@ -0,0 +1,5 @@
+import type { Pack } from '../../types'
+
+declare const zhCN: Pack
+
+export default zhCN

package/generators/config/i18n/tsx/src/locale/zh-CN.ts

@@ -0,0 +1,7 @@
+import { Pack } from './index'
+
+// for component's internal
+export default {
+  // Button component
+  button: '按钮'
+} as Pack

package/lib/commands/create.d.ts

@@ -1 +1,3 @@
-export declare function create(name: string): Promise<void>;
+export declare function create(name: string, cmd: {
+    disableI18n?: boolean;
+}): Promise<void>;