跳转至内容
There is a version suitable for your browser's language settings. Would you like to go to the english language of the site?
主页文档

模板

H1

Milkio 的 VS Code 扩展内置了模板功能。

和代码片段不同的是,模板可以一次性创建多个文件。例如,我们可能经常要为某些功能编写增删改查,使用模板,我们可以一次性创建好这些文件。

模板功能并非只对 Milkio 工程有效,只要安装好了 VS Code 扩展,那么就可以在所有的 JavaScript 工程中使用。准备好摆脱每次手动输入 <script lang="ts" setup> 的日子了吗?

安装

Milkio 工程已经默认安装好了,对于非 Milkio 工程来说(比如你的 Vue / React 工程)需要安装才可以使用模板。

终端窗口
bun add --dev milkio-template

创建模板

在你的 /.templates 目录中创建任意名称的文件。

/.templates/foo-template.ts
import { createTemplate } from "milkio-template";
import { join } from "path";
await createTemplate(async (tools) => {
return {
path: join(tools.directory(), `${tools.hyphen(tools.name())}.ts`),
content: `
console.log("Hello ${tools.name()}!")
`.trim(),
};
});

工具

createTemplate 中,你可以通过 tools 对象来获取工具集。有以下方法可以使用。

名称结果类型说明
tools.namestring创建模板时填写的名称
tools.directorystring创建模板时选择的目录
tools.srcstring目录与 src 目录的相对路径,通常用于 import 中的路径
tools.hyphenstring将名称转换为中划线命名 (foo-bar)
tools.humpstring将名称转换为大驼峰命名 (FooBar)
tools.camelstring将名称转换为小驼峰命名 (fooBar)

内置模板

Milkio 不会提供内置模板,因为每个团队所使用的技术栈都可能是不同的,如果 Milkio 内置了一种偏向一种技术栈的模板,就会使另一部分所使用技术栈有差异的用户感到沮丧。而且内置的模板意味着它们是不可编辑的,这意味着使用者无法亲自调整一些细节,使模板在使用起来更加顺手。