12 个版本 (重大变更)
0.10.0 | 2024年3月17日 |
---|---|
0.8.0 | 2023年12月21日 |
0.7.3 | 2023年11月14日 |
0.3.2 | 2023年2月19日 |
#2 在 #secrets
每月下载量 391
17KB
265 行
模板 CLI
你是否曾经想要创建一个新的 NextJS 路由,使用 useSearchParams
钩子使用查询参数?
或者插入一个使用新的 satisfies
操作符导出负载和操作函数的服务器端页面?
或者制作一个包含所有 @ 注释和为 GET、POST、PUT 设置路由的 Java Spring 控制器文件?
并且你总是需要检查文档,因为你忘记了页面看起来是什么样子?使用哪些钩子,导入什么类型,如何正确命名函数?
如果是这样,那么 Templates CLI 就是为你准备的 :).
这是一个简单的工具,让你能够非常容易地创建、管理和使用一系列模板页面。
完全用 Rust 编写(需要指出这一点,因为这是你学习 Rust 的原因,对吧?)。
安装
cargo install templates
请确保 ~/.cargo/bin
在你的 PATH 中。
将来还会添加更多与发行版相关的选项 :)
最佳的学习方式是通过示例!
tp copy p ps -p reports -- svelte
这会将之前在
- ~/templates/svelte/[p]+page.svelte
- ~/templates/svelte/[ps]+page.server.ts
中创建的两个文件复制到
- ./reports/+page.svelte
- ./reports/+page.server.ts
每个文件都包含你事先准备好的模板(包含类型、函数等)。
tp show ls
这将显示终端中 ~/templates/[ls]your_file_name
文件的内容,准备好复制。
tp var -- next
这将列出在 ~/templates/next/var
文件中列出的所有环境变量。
用法
设置
你需要做的第一件事是设置一个 templates
文件夹。默认值为 ~/templates
。
tp set [path_to_your_templates_folder]
内部开始创建你的模板文件,格式为 [cli_shortcut]template_name
。你可以通过子文件夹(例如 svelte
、next
)来分组它们。
一些示例
[r]readme.md
[c]config.json
[p]+page.svelte
svelte/[ls]+layout.server.ts
svelte/[e]+error.svelte
next/[p]page.ts
next/[lt]layout.ts
next/[lj]layout.js
复制
tp copy [pages] -p <path> -- <project>
pages
- 模板文件的快捷方式列表(例如p
、ls
)。path
- 文件将被创建的路径(可选)。project
- 在您的模板文件夹内的子文件夹名称(可选)。
使用配置部分的示例设置
tp copy p lj -p ./routes -- next
这将创建 page.ts
和 layout.js
文件在 ./routes
目录,并将 next/[p]page.ts
和 next/[lj]layout.js
的内容分别复制到它们中,作为 ./routes/page.ts
和 ./routes/layout.js
。
显示
tp show [page] -- <project>
page
- 模板文件的快捷方式列表(例如,p
,ls
)。project
- 在您的模板文件夹内的子文件夹名称(可选)。
tp show p
这将显示终端中 [p]file_name
模板文件的内容。
变量
tp show -- <project>
project
- 在您的模板文件夹内的子文件夹名称(可选)。
tp var
这将打印 `var/ 文件内容。
tp var -- svelte
这将打印 `svelte/var/ 文件内容。
配置
tp config
打印当前配置。
依赖
~1.7–2.8MB
~53K SLoC