valaxy 0.24.5 → 0.25.0

package/client/components/ValaxyCopyright.vue

@@ -1,6 +1,7 @@
 <script lang="ts" setup>
 import { computed } from 'vue'
 import { useI18n } from 'vue-i18n'
+import { useValaxyI18n } from '../composables'
 import { useSiteConfig } from '../config'
 
 withDefaults(defineProps<{
@@ -10,6 +11,7 @@ withDefaults(defineProps<{
 })
 
 const { t, locale } = useI18n()
+const { $t } = useValaxyI18n()
 
 const siteConfig = useSiteConfig()
 
@@ -31,7 +33,7 @@ const licenseHtml = computed(() => {
       <strong>
         {{ t('post.copyright.author') + t('symbol.colon') }}
       </strong>
-      <span>{{ t(siteConfig.author.name) }}</span>
+      <span>{{ $t(siteConfig.author.name) }}</span>
     </li>
     <li v-if="url" class="post-copyright-link">
       <strong>

package/client/composables/app/useValaxyApp.ts

@@ -6,7 +6,7 @@ import { computed } from 'vue'
 import { useI18n } from 'vue-i18n'
 
 import { tObject } from '../../../shared/utils/i18n'
-import { useFrontmatter, useValaxyHead } from '../../composables'
+import { useFrontmatter, useValaxyHead, useValaxyI18n } from '../../composables'
 
 import { useTimezone } from '../../composables/global'
 // https://github.com/vueuse/head
@@ -20,6 +20,7 @@ export function useValaxyApp() {
   const fm = useFrontmatter()
 
   const { locale } = useI18n()
+  const { $t } = useValaxyI18n()
 
   const title = computed(() => tObject(fm.value.title || '', locale.value))
 
@@ -45,7 +46,7 @@ export function useValaxyApp() {
     // https://unhead.unjs.io/docs/schema-org/guides/recipes/identity
     // Personal Website or Blog
     definePerson({
-      name: siteConfig.value.author.name,
+      name: $t(siteConfig.value.author.name),
       url: siteUrl.value,
       image: siteConfig.value.author.avatar,
       sameAs: siteConfig.value.social.map(s => s.link),

package/client/composables/app/useValaxyHead.ts

@@ -3,12 +3,13 @@ import pkg from 'valaxy/package.json'
 import { computed } from 'vue'
 import { useI18n } from 'vue-i18n'
 
-import { useFrontmatter } from '../../composables'
+import { useFrontmatter, useValaxyI18n } from '../../composables'
 import { useSiteConfig } from '../../config'
 import { tObject } from '../../utils'
 
 export function useValaxyHead() {
-  const { locale, t } = useI18n()
+  const { locale } = useI18n()
+  const { $t } = useValaxyI18n()
 
   const fm = useFrontmatter()
   const siteConfig = useSiteConfig()
@@ -17,7 +18,7 @@ export function useValaxyHead() {
   useHead({
     title: $title,
     titleTemplate: (title) => {
-      const siteTitle = t(siteConfig.value.title)
+      const siteTitle = $t(siteConfig.value.title)
       return fm.value.titleTemplate || (title ? `${title} - ${siteTitle}` : siteTitle)
     },
     link: [

package/client/composables/locale.ts

@@ -6,6 +6,7 @@ import { computed } from 'vue'
 // not optimize deps all locales
 import { useI18n } from 'vue-i18n'
 import { tObject } from '../../shared/utils/i18n'
+import { LOCALE_PREFIX } from '../utils'
 import 'dayjs/locale/en'
 import 'dayjs/locale/zh-cn'
 
@@ -63,3 +64,23 @@ export function useLocaleTitle(fm: Ref<{
     return tObject(fm.value.title || '', lang) || ''
   })
 }
+
+/**
+ * @experimental
+ * 以 `$locale:` 开头的 key 会被认为是国际化的 key
+ * 会从 locales/ 目录中获取对应的翻译
+ */
+export function useValaxyI18n() {
+  const { t, locale } = useI18n()
+
+  return {
+    locale,
+
+    $t: (key: string) => {
+      if (key.startsWith(LOCALE_PREFIX)) {
+        return t(key.slice(LOCALE_PREFIX.length))
+      }
+      return key
+    },
+  }
+}

package/dist/{chunk-OA6SKHSD.js → chunk-VNLGPNVS.js}

@@ -4,7 +4,7 @@ import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
 // package.json
-var version = "0.24.5";
+var version = "0.25.0";
 
 // node/modules/fuse.ts
 import path4 from "path";
@@ -537,6 +537,11 @@ function transformObject(obj) {
   return `JSON.parse(${JSON.stringify(JSON.stringify(obj))})`;
 }
 
+// node/utils/i18n.ts
+function $t(key) {
+  return `$locale:${key}`;
+}
+
 // node/utils/resolve.ts
 import { ensurePrefix, slash } from "@antfu/utils";
 import { consola as consola6 } from "consola";
@@ -2140,7 +2145,7 @@ function containerPlugin(md3, containerOptions = {}) {
 ` : `</div>
 `
   });
-  const languages = ["zh-CN", "en"];
+  const languages = containerOptions.siteConfig?.languages || ["zh-CN", "en"];
   languages.forEach((lang) => {
     md3.use(container, lang, {
       render: (tokens, idx) => tokens[idx].nesting === 1 ? `<div lang="${lang}">
@@ -2556,6 +2561,7 @@ async function setupMarkdownPlugins(md3, options, base = "/") {
   if (mdOptions.preConfig)
     mdOptions.preConfig(md3);
   md3.use(highlightLinePlugin).use(preWrapperPlugin, { theme, siteConfig }).use(snippetPlugin, options?.userRoot).use(containerPlugin, {
+    siteConfig,
     ...mdOptions.blocks,
     ...mdOptions?.container
   }).use(cssI18nContainer, {
@@ -3089,7 +3095,7 @@ var templateConfig = {
 import fs16 from "fs-extra";
 var templateLocales = {
   id: "/@valaxyjs/locales",
-  async getContent({ roots }) {
+  async getContent({ roots, config }) {
     const imports = [
       'import { createDefu } from "defu"',
       'const messages = { "zh-CN": {}, en: {} }',
@@ -3102,7 +3108,7 @@ var templateLocales = {
   })
   `
     ];
-    const languages = ["zh-CN", "en"];
+    const languages = config.siteConfig.languages || ["zh-CN", "en"];
     roots.forEach((root, i) => {
       languages.forEach((lang) => {
         const langYml = `${root}/locales/${lang}.yml`;
@@ -4064,7 +4070,7 @@ async function ViteValaxyPlugins(valaxyApp, serverOptions = {}) {
       console.log();
     }
   }
-  const customIcon = {
+  const builtinCustomIcon = {
     nodejs: "vscode-icons:file-type-node",
     playwright: "vscode-icons:file-type-playwright",
     typedoc: "vscode-icons:file-type-typedoc",
@@ -4072,10 +4078,13 @@ async function ViteValaxyPlugins(valaxyApp, serverOptions = {}) {
   };
   plugins.push(
     groupIconVitePlugin({
-      customIcon,
-      ...valaxyConfig.groupIcons,
+      customIcon: {
+        ...builtinCustomIcon,
+        ...valaxyConfig.groupIcons?.customIcon
+      },
       defaultLabels: [
         ...valaxyConfig.groupIcons?.defaultLabels || [],
+        ...Object.keys(builtinCustomIcon),
         ...Object.keys(valaxyConfig.groupIcons?.customIcon || {})
       ]
     })
@@ -4809,6 +4818,7 @@ export {
   isExternal,
   isPath,
   transformObject,
+  $t,
   isInstalledGlobally,
   resolveImportUrl,
   toAtFS,

package/dist/node/cli/index.js

@@ -3,7 +3,7 @@ import {
   registerDevCommand,
   run,
   startValaxyDev
-} from "../../chunk-OA6SKHSD.js";
+} from "../../chunk-VNLGPNVS.js";
 export {
   cli,
   registerDevCommand,

package/dist/node/index.d.ts

@@ -653,6 +653,16 @@ declare function isPath(name: string): boolean;
  */
 declare function transformObject(obj: any): string;
 
+/**
+ * @experimental 试验性
+ * @see https://github.com/YunYouJun/valaxy/issues/566
+ * @param key
+ *
+ * 声明这是一个使用国际化的 key
+ * 从 locales/ 目录中获取对应的翻译
+ */
+declare function $t(key: string): string;
+
 declare const isInstalledGlobally: {
     value?: boolean;
 };
@@ -668,4 +678,4 @@ declare function toAtFS(path: string): string;
 declare function resolveImportPath(importName: string, ensure?: true): Promise<string>;
 declare function resolveImportPath(importName: string, ensure?: boolean): Promise<string | undefined>;
 
-export { ALL_ROUTE, EXCERPT_SEPARATOR, type HookResult, type LoadConfigFromFileOptions, PATHNAME_PROTOCOL_RE, type ResolvedConfig, type ResolvedValaxyOptions, type UnoSetup, type UserInputConfig, type UserValaxyNodeConfig, type ValaxyAddonExport, type ValaxyAddonFn, type ValaxyAddonLike, type ValaxyAddonResolver, type ValaxyAddons, type ValaxyApp, type ValaxyConfigExport, type ValaxyConfigExtendKey, type ValaxyConfigFn, type ValaxyEntryOptions, type ValaxyExtendConfig, type ValaxyHooks, type ValaxyNode, type ValaxyNodeConfig, type ValaxyPickConfig, type ValaxyServerOptions, type ValaxyTheme, ViteValaxyPlugins, build, createServer, createValaxyPlugin, customElements, defaultSiteConfig, defaultValaxyConfig, defaultViteConfig, defineAddon, defineConfig, defineSiteConfig, defineTheme, defineUnoSetup, defineValaxyAddon, defineValaxyConfig, defineValaxyTheme, generateClientRedirects, getGitTimestamp, getIndexHtml, getServerInfoText, isExternal, isInstalledGlobally, isPath, loadConfig, loadConfigFromFile, mergeValaxyConfig, mergeViteConfigs, postProcessForSSG, processValaxyOptions, resolveAddonsConfig, resolveImportPath, resolveImportUrl, resolveOptions, resolveSiteConfig, resolveSiteConfigFromRoot, resolveThemeConfigFromRoot, resolveThemeValaxyConfig, resolveUserThemeConfig, resolveValaxyConfig, resolveValaxyConfigFromRoot, ssgBuild, toAtFS, transformObject };
+export { $t, ALL_ROUTE, EXCERPT_SEPARATOR, type HookResult, type LoadConfigFromFileOptions, PATHNAME_PROTOCOL_RE, type ResolvedConfig, type ResolvedValaxyOptions, type UnoSetup, type UserInputConfig, type UserValaxyNodeConfig, type ValaxyAddonExport, type ValaxyAddonFn, type ValaxyAddonLike, type ValaxyAddonResolver, type ValaxyAddons, type ValaxyApp, type ValaxyConfigExport, type ValaxyConfigExtendKey, type ValaxyConfigFn, type ValaxyEntryOptions, type ValaxyExtendConfig, type ValaxyHooks, type ValaxyNode, type ValaxyNodeConfig, type ValaxyPickConfig, type ValaxyServerOptions, type ValaxyTheme, ViteValaxyPlugins, build, createServer, createValaxyPlugin, customElements, defaultSiteConfig, defaultValaxyConfig, defaultViteConfig, defineAddon, defineConfig, defineSiteConfig, defineTheme, defineUnoSetup, defineValaxyAddon, defineValaxyConfig, defineValaxyTheme, generateClientRedirects, getGitTimestamp, getIndexHtml, getServerInfoText, isExternal, isInstalledGlobally, isPath, loadConfig, loadConfigFromFile, mergeValaxyConfig, mergeViteConfigs, postProcessForSSG, processValaxyOptions, resolveAddonsConfig, resolveImportPath, resolveImportUrl, resolveOptions, resolveSiteConfig, resolveSiteConfigFromRoot, resolveThemeConfigFromRoot, resolveThemeValaxyConfig, resolveUserThemeConfig, resolveValaxyConfig, resolveValaxyConfigFromRoot, ssgBuild, toAtFS, transformObject };

package/dist/node/index.js

@@ -1,4 +1,5 @@
 import {
+  $t,
   ALL_ROUTE,
   EXCERPT_SEPARATOR,
   PATHNAME_PROTOCOL_RE,
@@ -49,8 +50,9 @@ import {
   startValaxyDev,
   toAtFS,
   transformObject
-} from "../chunk-OA6SKHSD.js";
+} from "../chunk-VNLGPNVS.js";
 export {
+  $t,
   ALL_ROUTE,
   EXCERPT_SEPARATOR,
   PATHNAME_PROTOCOL_RE,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "valaxy",
   "type": "module",
-  "version": "0.24.5",
+  "version": "0.25.0",
   "description": "📄 Vite & Vue powered static blog generator.",
   "author": {
     "email": "me@yunyoujun.cn",
@@ -132,8 +132,8 @@
     "vue-i18n": "^11.1.9",
     "vue-router": "^4.5.1",
     "yargs": "^18.0.0",
-    "@valaxyjs/devtools": "0.24.5",
-    "@valaxyjs/utils": "0.24.5"
+    "@valaxyjs/devtools": "0.25.0",
+    "@valaxyjs/utils": "0.25.0"
   },
   "devDependencies": {
     "@mdit-vue/plugin-component": "^2.1.4",

package/shared/constants.ts

@@ -1 +1,8 @@
 export const EXTERNAL_URL_RE = /^(?:[a-z]+:|\/\/)/i
+
+/**
+ * @experimental
+ * 标识这是一个使用国际化的 key
+ * 从 locales/ 目录中获取对应的翻译
+ */
+export const LOCALE_PREFIX = '$locale:'