code-story

code story cli

Get your code activity log for standup from git.   ⚠️ This is beta version

Opinionated git log parser shows which code you worked on in the specified period, providing additional useful information.

Features:

• group commit by branch
• show link on task tracker
• show link on PR, branch or tag
• the ability to set working day for smart detect show log period with common usage
• the ability to set the start time of the day, which will help you more accurately determine what you were doing
• show changed files in commits
• support config file

Output example:

Repository: codestory
Author: Alexander Ivankov
Story since 11:30 18.10.2020 until 11:30 23.10.2020

feature/CODESTORY-1-documentation  ───────────────────────────────────────── branch name
PR: https://github.com/MoonW1nd/codestory/pull/feature/CODESTORY-1-doc  ──── link on PR
TASK: https://tracker.yandex.ru/CODESTORY-1  ─────────────────────────────── task tracker link
COMMITS:
    A 2020-09-21 1234826 feat(readme.md): start documentation ─────── commit info
    │    A README.md  ─────────────────────────────────────────────── changed file
    │    └─────────────────────────────────────────────────────────── file modification type (*)
    └──────────────────────────────────────────────────────────────── commit modification type (*)

(*) Modification types: A - add file/commit, M - modified file/commit, D - delete file

Installation

npm i -g code-story

Options

• --since, -s - show commits more recent than a specific date.
• --after, -a - show commits more recent than a specific date.
• --until, -u - show commits older than a specific date.
• --before, -b - show commits older than a specific date.
• --trackerUrl, -t - base url in task tracker system.
• --author - limit the commits output to ones with author header lines that match the specified pattern.
• --branch, -b - show only commits in the specified branch or revision range.
• --number, -n - the number of commits to return
• --file, -f - file filter for the git log command
• --committer - limit the commits output to ones with author header lines that match the specified pattern.
• --showCommitFiles - show files changed in commits.
• --clearConsole - clear console before out info
• --workingDaysOfWeek - sets working days of the week, use 2 first letter of day in the list and separated a comma.Use ! symbol for exclude day.

  Example: --workingDaysOfWeek="!Su,!Sa"

• --startDayTime - sets the start time of the day. The commit history will start and end from this time.

  Format: hours:minutes Example: --startDayTime=09:00

• --header - cli header type
• --help, -h - show help

Config file

Support set often used options in:

• codestory property in a package.json
• a JSON or YAML, extensionless .codestoryrc file
• an .codestoryrc with the extensions .json, .yaml, .yml, .js, or .cjs (example: .codestoryrc.json)
• a codestory.config.js or codestory.config.cjs CommonJS

Example:

# .codestoryrc

author:
    'Alexander Ivankov'
trackerUrl:
    'https://tracker.yandex.ru'
workingDaysOfWeek:
    '!Fr,!Su,!Sa'
startDayTime:
    '11:30'

Usage

Get commits story by last week

code-story --since=1.week.ago

Known issues

• wrong detect branch name in branch without commits (#4)