Skip to content

v0.1.0 - Initial Release

Choose a tag to compare

@rizumita rizumita released this 30 Nov 08:49
· 36 commits to main since this release
a023522

Shirushi (標) - Document ID管理・検証システム

GitリポジトリにおけるMarkdown/YAMLファイルのドキュメントID管理・検証システムの初回リリースです。

機能

CLIコマンド

  • shirushi lint - ドキュメントID検証(読み取り専用)
  • shirushi scan - ドキュメント一覧表示

Dimension System

  • enum: 固定値セット(例: コンポーネント名)
  • enum_from_doc_type: ドキュメントのdoc_typeフィールドから導出
  • year: 年コンポーネント(メタデータまたは現在年)
  • serial: スコープ内連番
  • checksum: mod26AZチェックサム

検証機能

  • ID形式検証(テンプレートベースの正規表現生成)
  • チェックサム検証
  • インデックスファイル整合性検証
  • Git連携(--base, --changed-only オプション)

設定

  • Zodによるスキーマ検証
  • YAML設定ファイル(.shirushi.yml)

インストール

# pnpmの場合
pnpm add shirushi

# npmの場合
npm install shirushi

使用例

# ドキュメントID検証
shirushi lint

# 変更ファイルのみ検証
shirushi lint --changed-only

# 特定のコミットからの変更を検証
shirushi lint --base main

# ドキュメント一覧
shirushi scan

ドキュメント

次バージョン (v0.2) で予定

  • shirushi assign - 自動ID割り当て
  • shirushi index sync - インデックス同期