故事行数计数器

描述

此工具分析 git 仓库的提交信息，查找 Version1 或 Jira 故事编号，并获取与故事相关的变更行总数。

入门指南

此工具是用 Rust 构建的。这是你第一次使用 Rust 吗？对我来说也是。

• 您已安装 Rust，最好通过 rustup 进行安装
• 您已将 ~/.cargo/bin 添加到您的 PATH 变量中
• 一步构建和运行，使用 cargo run --，或 cargo run -- --help
• 或者，使用以下命令构建可执行文件：

$ cargo build --release
  ... builds in a few minutes ...
$ ./target/release/story-line-counter
$ ./target/release/story-line-counter --help
$ ./target/release/story-line-counter run --help

此时它已准备好使用，但只实现了运行操作。将可执行文件添加到您的 PATH 中，您就可以在任何 git 仓库中通过运行 story-line-counter 来使用它。

用法

$ story-line-counter --help

story-line-counter 1.0.0
Lea Fairbanks <[email protected]>

USAGE:
    story-line-counter [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    collect    Parses a git repo and outputs DiffCollection objects.
    help       Prints this message or the help of the given subcommand(s)
    run        Opens a repo and outputs a DiffTotalCollection.
    total      Loads a DiffCollection file and outputs a DiffTotalCollection.

您可以一次性收集和总计一个仓库。

$ story-line-counter run -p /path/to/points.json /path/to/repo

或者，您可以将其分成两个步骤，总计多个仓库。

$ story-line-counter collect /path/to/repo1 > repo1.json
$ story-line-counter collect /path/to/repo2 > repo2.json
$ story-line-counter total -p /path/to/points.json repo1.json repo2.json

包含一个点数文件是可选的，但您必须生成自己的文件以匹配故事编号与点值。此仓库中包含一个示例 points.json 文件 在此。它可以格式化或未格式化。