diff --git a/docs/src/guide/advanced/runtime.md b/docs/src/guide/advanced/runtime.md index a0fb5b4..ff253a9 100644 --- a/docs/src/guide/advanced/runtime.md +++ b/docs/src/guide/advanced/runtime.md @@ -1,36 +1,12 @@ # 运行时 -`@voerkai18n/runtime`是`voerkai18n`的运行时依赖,支持两种依赖方式。 +`@voerkai18n/runtime`是`voerkai18n`的运行时依赖 -## 源码依赖 - - 默认情况下,运行`voerkai18n compile`时会在`languages`文件下生成运行时文件`runtime.js`,该文件被`languages/index.js`引入,里面是核心运行时`ES6`源代码(`@voerkai18n/runtime`源码),也就是在您的工程中是直接引入的运行时代码,因此就不需要额外安装`@voerkai18n/runtime`了。 - - 此时,`@voerkai18n/runtime`源码就成为您工程是一部分。 - -## 库依赖 - - 当运行`voerkai18n compile --no-inline-runtime`时,就不会生成运行时文件`runtime.js`,而是采用`import "@voerkai18n/runtime`的方式导入运行时,此时会自动/手动安装`@voerkai18n/runtime`到运行依赖中。 - - -## 如何选择 - -**那么应该选择`源码依赖`还是`库依赖`呢?** - -问题的重点在于,在`monorepo`工程或者`开发库`时,`源码依赖`会导致存在重复的运行时源码。而采用`库依赖`,则不存在此问题。因此: - -- 普通应用采用`源码依赖`方式,运行`voerkai18n compile `来编译语言包。 -- `monorepo`工程或者`开发库`采用`库依赖`,`voerkai18n compile --no-inline-runtime`来编译语言包。 - - - -## 注意 +**注意** - `@voerkai18n/runtime`发布了`commonjs`和`esm`两个经过`babel/rollup`转码后的`ES5`版本。 - -- 每次运行`voerkai18n compile`时均会重新生成`runtime.js`源码文件,为了确保最新的运行时,请及时更新`@voerkai18n/cli` - -- 当升级了`@voerkai18n/runtime`后,需要重新运行`voerkai18n compile`以重新生成`runtime.js`文件。 +- 当运行`voerkai18n compile`时会尝试自动升级`@voerkai18n/runtime` +- 建议及时升级`@voerkai18n/runtime`到最新版本 diff --git a/docs/src/guide/intro/history.md b/docs/src/guide/intro/history.md index cd4a9db..58446a8 100644 --- a/docs/src/guide/intro/history.md +++ b/docs/src/guide/intro/history.md @@ -1,5 +1,11 @@ # 更新日志 +## 2023/1/10 + +- 添加`typescript`类型支持 +- 移除`@voerkai18n/runtime`的源码依赖方式 +- 支持生成`languages`文件夹下的`typescript`文件 + ## 2022/8/24 - 全新灵活的格式化机制 diff --git a/docs/src/guide/tools/cli.md b/docs/src/guide/tools/cli.md index cbf10e1..c59d8d0 100644 --- a/docs/src/guide/tools/cli.md +++ b/docs/src/guide/tools/cli.md @@ -233,7 +233,7 @@ Arguments: Options: -D, --debug 输出调试信息 -m, --moduleType [types] 输出模块类型,取值auto,esm,cjs (default: "esm") - --no-inline-runtime 不嵌入运行时源码 + -t, --typescript 生成`typescript`文件 -h, --help display help for command ``` @@ -255,5 +255,4 @@ myapp - 在当前工程目录下,一般不需要指定参数就可以反复多次进行编译。 - 您每次修改了源码并`extract`后,均应该再次运行`compile`命令。 -- 如果您修改了`formatters.js`,执行`compile`命令不会重新生成和修改该文件。 -- `--no-inline-runtime `参数用来指示如何引用运行时。默认会将运行时代码生成保存在`languages/runtime.js`,应用以源码形式引用。当启用`--no-inline-runtime `参数时会采用`require("@voerkai18n/runtime")`的方式。 \ No newline at end of file +- 如果您修改了`formatters.js`,执行`compile`命令不会重新生成和修改该文件。 \ No newline at end of file diff --git a/package.json b/package.json index b310b01..25316af 100644 --- a/package.json +++ b/package.json @@ -47,8 +47,5 @@ "apps" ], "includeDescendants": false - }, - "dependencies": { - "autopub": "link:.yalc\\autopub" - } + } } diff --git a/yalc.lock b/yalc.lock deleted file mode 100644 index 6cf4c4c..0000000 --- a/yalc.lock +++ /dev/null @@ -1,10 +0,0 @@ -{ - "version": "v1", - "packages": { - "autopub": { - "signature": "473bffdd0f6747c0e15c60b82fac98cf", - "link": true, - "replaced": "file:.yalc/autopub" - } - } -} \ No newline at end of file