momi

该项目是一个简单的工具，可以帮助您创建新的会议纪要（MoM）文档。它将创建一个新的文本文件，其中包含会议的元数据和MoM模板。

特性

• 创建新的MoM文档
• 向文档添加元数据（以下为元数据列表）
• 为MoM添加模板
• 将文档保存到指定的名称和位置

安装

先决条件

• Rust和Cargo

如何安装

cargo install momi

用法

Windows

momi.exe [options] <filename>

Mac和Linux

./momi [options] <filename>

选项

• -o, --overwrite 如果文件已存在则覆盖文件
• -v, --详细
• -a, --author <AUTHOR> 文档的作者
• -p, --open 创建文件后打开所有文件
• -e, --enrich 向文档添加附加元数据
• -h, --help 打印帮助信息
• -V, --version 打印版本

附加选项

• --create-config 创建默认配置文件

示例

momi.exe -a "John Doe" "Meeting with the client 1.md"

文件 Meeting with the client 1.md 包含以下内容

# Meeting with the client 1

created: 2024-04-30 04:58:44
author: John Doe

配置

配置文件位于可执行文件同一目录下的 config.json。它可以包含以下设置

• author: 文档的默认作者
• extension: 文档的默认扩展名
• header: 文档的默认页眉
• footer: 文档的默认页脚
• rich：可以添加到文档的自定义元数据

示例

在 config.json

{
  "author": "John Doe",
  "extension": "txt",
  "header": "--------header--------",
  "footer": "--------footer--------",
  "rich": {
    "extra_metadata": [
      "location",
      "attendees",
      "meeting chair",
      "agenda"
    ]
  }
}

此json文件将设置元数据的默认值

• 文档的作者将是“John Doe”
• 文档的扩展名将是 txt
• 文档的标题将是“--------header--------”
• 文档的页脚将是“--------footer--------”
• 可以添加到文档的额外元数据标签有 location、attendees、meeting chair 和 agenda
  • 这些标签是可选的，可以使用 -e 选项添加到文档中

根据上述配置，以下bash命令将创建以下内容的文件

momi.exe "Meeting with the client 1"

在文件 Meeting with the client 1.txt

Meeting with the client 1

created: 2024-04-30 05:01:39
author: John Doe

--------header--------

--------footer--------

如果提供了 -e 或 --enrich 选项，程序将询问要添加到文档中的额外元数据标签和值。

momi.exe -e "Meeting with the client 1"

Meeting with the client 1

created: 2024-04-30 05:01:39
author: John Doe

location: 
attendees: 
meeting chair: 
agenda: 

--------header--------

--------footer--------

如果命令行上提供了 -o 或 --overwrite 选项，则配置文件将由命令行选项覆盖。

支持的元数据

• created：文档创建的日期和时间
• author：文档的作者

支持的扩展名

以下是可以自动添加到文件名作为文档标题的扩展名

• .txt：文本文件
• .md：Markdown文件

如何确定哪些元数据被写入文档？

优先级顺序

1. CLI选项
2. 配置文件
3. 无或默认值

如果提供了作者作为CLI选项，程序将写入元数据到文档中。如果没有提供作者，程序将使用配置文件中的默认作者。如果没有在配置文件中提供作者，程序将写入当前用户的名称作为作者（$USER）。

如果同时提供了配置文件和作者作为选项，程序将使用提供的作者选项，并忽略配置文件中的作者。

其他元数据将按照与作者相同的规则写入文档。

如何构建

先决条件

• Rust和Cargo

步骤

1. 克隆仓库
2. 在项目目录中打开终端
3. 运行以下命令

cargo build --release

4. 可执行文件位于 target/release/momi
5. 您可以将可执行文件复制到PATH中的目录（可选）

您也可以使用以下命令从项目目录运行可执行文件

cargo run -- [options] <filename>

尚未实现但计划中

有关计划中但尚未实现的特性的列表，请参阅 Todo.md

许可协议

本项目采用MIT许可协议 - 详细信息请参阅LICENSE文件。