Skip to content

Latest commit

 

History

History
139 lines (101 loc) · 4.46 KB

README.ja-JP.md

File metadata and controls

139 lines (101 loc) · 4.46 KB
Raw

yeareport

年末レポートのための git commit をまとめる NodeJS ツール、Markdown を自動生成

📖 概要

year-report は個人向けの年末レポート作成を支援するツールです。

これにより、次のことができます：

  • 個人の git ワークログをまとめる

  • 美しい Markdown を出力する

  • 特定の作業タイプのコンテンツリストと数量を抽出する

changelog-cli との違い：

  • 個人向けに特化

  • 柔軟で制御可能な時間範囲

  • より多くの制御可能な出力結果モード

  • 開発者の年末レポート用により良い標準素材を設計

  • GPT へのデータ供給のための事前解析

Markdown 出力結果のデモ

default_example

⚙️ インストール

  1. リポジトリをクローンする
git clone https://github.com/kabeep/yeareport.git
  1. 依存関係をインストールする
cd yeareport

# NPM
npm install

# または Yarn
yarn
  1. プログラムをコンパイルする
npm run build
  1. NPM ソフトリンク
npm link
  1. インストールの成功をテストする
yeareport -v

🚀 例を使用する

Usage

yeareport <command> [options]

コマンド：
  yeareport add     現在のディレクトリをキューに追加
  yeareport remove  現在の作業ディレクトリをキューから削除          [aliases: rm]
  yeareport clear   キューをクリア                             [aliases: clr]
  yeareport print   キューをマークダウンファイルとして出力         [aliases: ptr]
  yeareport show    キュー内のログリストを表示

オプション：
      --author     `auto`の場合、git global
                   configから検索、デフォルトはすべてのログを出力        [もじれつ]
      --since      特定の日から出力開始、デフォルトは `2023-01-01`      [もじれつ]
      --before     特定の日まで出力終了、デフォルトは `2024-01-01`      [もじれつ]
      --output     print 出力ディレクトリ、現在の作業ディレクトリに対して相対的
                   、デフォルトは `User/Downloads`                   [もじれつ]
  -o, --overwrite  add 上書き許可、現在の作業ディレクトリが既に存在する場合に上
                   書き操作を実行                 [ブール] [デフォルト値: false]
  -p, --pretty     print タイトルを美化、emojiを使ってMarkdownのタイトルを美化
                                               [ブール] [デフォルト値: false]
  -h, --help       ヘルプ情報を表示する                                [ブール]
  -v, --version    バージョン番号を表示する                             [ブール]

例：
  yeareport add -o                          現在の作業ディレクトリのログがキュー
                                            内に既にある場合に上書きするためのad
                                            dコマンドの承認
  yeareport add --author=kabeep             著者kabeepのログのみをキューに追加
  yeareport add --since=2023-01-01          2023-01-01から2024-01-01までのログを
  --before=2024-01-01                       キューに追加
  yeareport print -p                        Markdownのタイトルは `# {emoji}
                                            {commit-type}` として出力されます

🎯 RoadMap

  • 統計と分割

  • パーセンテージの計算

  • トレンドチャート

  • ガントチャート

🤝 貢献

プルリクエストやIssuesを通じて、あなたのアイデアやコードを貢献することを歓迎します。

📄 ライセンス

このプロジェクトは MIT ライセンスを採用しています。詳細は LICENSE ファイルをご覧ください。