Mdmg

脚手架原型代码工具。

安装

cargo install mdmg

Debian

1. 从 https://github.com/himanoa/mdmg/releases 下载最新的 deb 包

dpkg -i mdmg_[version]_amd64.deb

macOS

使用 homebrew

brew install -s himanoa/tap/mdmg

特性

• 基于Markdown驱动
  • 受 scaffdog 启发。
• 零依赖
• 零配置
• 不使用交互式shell。
  • 容易在脚本和文本编辑器中重用。

使用方法

1. 将当前目录移动到您的项目目录。
2. 执行 mdmg setup。
3. 创建一个类似以下文件 .mdmg/${plan_name}.md。

## src/main.rs

```rust
fn main() -> Result<()> {
    unimplemented!()
}
```

4. 执行 mdmg generate ${plan_name} foo。

Mdmg 计划文件格式

请按照以下格式编写。

## file_name

```
file_body
```

重点如下。

• 在 h2 标签中写入文件名
• 在代码块中写入文件正文，其中下一行
• ↑ 是可以的，可以写多个

模板引擎

Mdmg 计划 Markdown 可以使用 handlebars 模板。

可使用的函数和变量。

支持的变量

• identify mdmg generate 命令的第三个参数。
  • 示例。 mdmg generate foo bar => bar

支持的函数

• pascal_case
  • 示例
    • identify: fooBarBaz
    • 模板: {{pascal_case identify}}
    • 输出: FooBarBaz
• camel_case
  • 示例
    • identify: FooBarBaz
    • 模板: {{camel_case identify}}
    • 输出: fooBarBaz
• kebab_case
  • 示例
    • identify: FooBarBaz
    • 模板：{{kebab_case identify}}
    • 输出：foo-bar-baz
• snake_case
  • 示例
    • identify: FooBarBaz
    • 模板：{{snake_case identify}}
    • 输出：foo_bar_baz
• 环境:
  • 示例
    • 环境变量：FOO=12
    • 模板：{{env "FOO"}}
    • 输出：12

实现 => https://github.com/himanoa/mdmg/blob/master/src/template.rs

贡献

查看 https://github.com/himanoa/mdmg/blob/master/CONTRIBUTING.md