md-bookshelf

Markdown本文の文字量を、有名な本の「約何冊分」としてターミナルに可視化するCLIです。

インストール

開発中のこのリポジトリからグローバルコマンドとして登録できます。

npm install
npm run build
npm link
md-bookshelf ./notes

npmへ公開後はnpm install -g md-bookshelfまたはnpx md-bookshelf .でも利用できます。

TAB補完

zshでは次を.zshrcへ追加します。

autoload -Uz compinit && compinit
source <(md-bookshelf completion zsh)

bashでは次を.bashrcへ追加します。

source <(md-bookshelf completion bash)

fishでは一度だけ次を実行します。

md-bookshelf completion fish > ~/.config/fish/completions/md-bookshelf.fish

コマンド、主要オプション、出力形式、対象ディレクトリを補完します。

開発環境で使う

npm install
npm run dev -- ./notes

npm run dev -- . --book harry-potter-1-ja --top 5
npm run dev -- . --format json
npm run dev -- books
npm run dev -- books add ./notes --id my-book --title "自分の本" --author "著者" --characters 100000 --language ja
npm run dev -- books add --global --id my-book --title "自分の本" --author "著者" --characters 100000 --language ja

対象ディレクトリの.md-bookshelf/config.jsonにローカル設定を置けます。全ディレクトリ共通の設定は~/.md-bookshelf/config.jsonに置きます。

{
  "bookId": "harry-potter-1-ja",
  "top": 10,
  "exclude": ["archive/**"],
  "includeCode": false,
  "countSpaces": false
}

独自作品はローカルなら<対象>/.md-bookshelf/books.json、--global指定時は~/.md-bookshelf/books.jsonへ保存されます。言語はja、en、ja-JPなどのBCP 47言語タグで指定します。

詳しい集計規則は仕様書を参照してください。