Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seho-dev/project-maid
一款 Visual Studio Code 扩展，为开发与组织中大型项目，提供了一系列实用功能，All in One！
https://github.com/seho-dev/project-maid
Last synced: 11 days ago
JSON representation
一款 Visual Studio Code 扩展，为开发与组织中大型项目，提供了一系列实用功能，All in One！
- Host: GitHub
- URL: https://github.com/seho-dev/project-maid
- Owner: seho-dev
- License: gpl-3.0
- Created: 2022-05-05T08:33:15.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-05T08:23:40.000Z (almost 3 years ago)
- Last Synced: 2025-01-20T23:49:44.703Z (16 days ago)
- Homepage:
- Size: 0 Bytes
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Maid
Project Maid 是一款 Visual Studio Code 扩展，为开发与组织中大型项目，提供了一系列实用功能，All in One！
> 我们正在开发中，想与我们一起开发、或提出功能建议的，欢迎通过 `issue` 联系，或者在[知乎](https://www.zhihu.com/people/akirarika)私信我，我们加 QQ / 微信好友
## 功能列表 (Todo)
[x] 模板功能：通过模板创建文件夹
[ ] 模板功能：通过模板创建文件
[ ] 模板功能：创建模板后，自动修改某些文件，如添加路由等
[ ] Git 功能：一键提交至所选分支，并切换回原分支
[ ] Git 功能：Commit 模板功能，和约束 Commit 格式
[ ] Git 功能：在 Commit 前，运行指定 Shell 脚本
[ ] 文档功能：根据注释生成 .md 文档
### 概述
Project Maid 主张约定优于配置，只要按照我们所事先约定的规则创建文件即可，无需修改编辑各种恼人的 `json` 文件。
只要在任意一个 Visual Studio Code 所打开的文件夹的根目录下，创建一个 `.pm` 文件夹，就可以启用 Project Maid。
具体用法，敬请阅读你感兴趣的功能章节。
### 安装
在 Visual Studio Code 扩展商店中，搜索 `project-maid` 并安装即可。或者[点击此处](https://marketplace.visualstudio.com/items?itemName=akirarika.project-maid)
## 模板功能
我们在开发过程中，尤其是前端开发，经常会遇到重复性复制的场景。
例如小程序开发，我们每次新建页面，都需要创建 `index.json`、`index.wxml`、`index.wxss`、`index.js` 这些文件。模板功能就可以让我们化繁为简。
### 入门
我们在 `.pm` 目录下新建一个 `templates` 目录，在这里存放我们的模板。
接着，我们建立一个以模板名为名的文件夹。例如，我想创建一个用于新建页面的模板，那么我将它取名为 `view`。
此时，我们的目录结构，应当如下：
```sh
> /.pm/templates/page
```
在此目录中，我们再新建一个文件夹，名为 `{{your-name}}-view`。是的，这是一个包含大括号的文件名。
此时，我们的目录结构，应当如下：
```sh
> /.pm/templates/page/{{your-name}}-view
```
然后，我们在其内部新建一个 `{{your-name}}.ts.tpl` 文件，内容为：
```ts
export function {{yourName}}() {
console.log('Say {{YourName}}!');
}
```
完成以上操作后，我们选择任意目录，在其上单机鼠标右键，我们可以就看到 `Create from template..` 的选项菜单。
接着我们输入任意想要的名称，比如 `welcome`，再选择名为 `page` 的模板，我们就会发现目录中，根据我们的模板创建了一个新的文件夹，名称为：`welcome-view`
其内部，有一个名为 `welcome.ts` 的文件，内容为：
```ts
export function welcome() {
console.log("Say Welcome!");
}
```
到此为止，我们的第一个模板就完成啦！这不是什么魔法，在接下来的文章，我们将详细讨论他是如何实现的。
### 模板和变量
在 `/.pm/templates` 内的文件夹，都被视为是模板，其中文件夹名为模板名。
一个模板内部，**只可以拥有一个文件夹**，但此文件夹内部层数、所包含哪些文件均无限制。
Project Maid 会根据此文件夹及其内容，来生成最终的文件。
变量是以 `{{}}` 所包含的内容，它会根据创建时的输入，动态替换为相应的内容。这就是我们前文中创建了一个名为 `{{your-name}}-view` 的模板，最终生成了名为 `welcome-view` 的文件的原因。
目前，我们可以使用以下变量：
| 变量名称 | 说明 |
| ----------- | ---------------------------------------- |
| yourNameRaw | 用户所输入的名称，原封不动的写入 |
| yourName | 用户所输入的名称，将被格式化为小驼峰形式 |
| YourName | 用户所输入的名称，将被格式化为大驼峰形式 |
| your_name | 用户所输入的名称，将被格式化为下划线形式 |
| your-name | 用户所输入的名称，将被格式化为中划线形式 |
以上变量，均可以在 `/.pm/templates/你的模板名称` 内部的所有文件夹名称、和 `.tpl` 文件的文件名及内容中使用。
### tpl
`tpl` 文件即模板文件，表明此文件将可能使用变量，而并非原封不动的复制。
它的文件名和内容中，均可自由的使用变量，当它被从模板中复制时，会自动删掉文件名中的 `.tpl` 扩展名。
除了变量，你还可以书写注释，注释的内容不会真的生成到实际代码中。
```
{{!-- 我是一行注释 --}}
```
## 待续
## 贡献
- Clone 此仓库
- `npm i` 安装依赖
- 使用 `Visual Studio Code` 打开， 按下 `F5` 或在菜单中选择 `Run > Start Debugging` 开始调试开发
- `npm run package` 打包
- 访问 [扩展商店](https://marketplace.visualstudio.com/)，点击右上角 `Publish extensions` 发布扩展