@kalbi/zeicheck 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,218 @@
+# zeicheck
+
+e-Tax (xtx) 確定申告データの整合性チェッカー。ESLintのような使い心地で、青色申告・個人事業主向けの税務申告データをルールベースで検証します。
+
+## インストール
+
+```bash
+npm install -g zeicheck
+```
+
+## 使い方
+
+### 基本的な検証
+
+```bash
+zeicheck check 申告データ.xtx
+```
+
+### 出力例
+
+```
+/path/to/申告データ.xtx
+
+  balance-sheet/equation        error    期末残高: 資産合計(3,500,000) ≠ 負債合計(0) + 資本合計(3,300,000)
+  income-statement/pl-chain     error    経費合計(1,850,000) ≠ 各経費の合算(1,800,000)
+  deductions/blue-deduction-cap warning  青色申告特別控除額(650,000) > 控除前所得(500,000)
+
+✖ 3 件の問題 (2 errors, 1 warning)
+```
+
+### コマンド
+
+```bash
+# xtxファイルの検証
+zeicheck check <file.xtx>
+  -f, --format <stylish|json>     # 出力形式（デフォルト: stylish）
+  -c, --config <path>             # 設定ファイルパス
+  --prior-year <file.xtx>         # 前年ファイル（継続性チェック用）
+  --severity <error|warning|info> # 最低表示レベル
+  --no-color                      # カラー出力を無効化
+
+# ルール一覧の表示
+zeicheck list-rules
+
+# ルールの詳細説明
+zeicheck explain <rule-id>
+```
+
+## ルール一覧
+
+### 貸借対照表 (Balance Sheet)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `balance-sheet/equation` | 資産合計 = 負債合計 + 資本合計 | error |
+| `balance-sheet/opening-owner-equity` | 事業主貸/借の期首残高が0 | error |
+| `balance-sheet/motoire-kin-formula` | 元入金繰越計算の検証 | error |
+| `balance-sheet/non-negative-cash` | 現金残高が負でないか | warning |
+
+### 損益計算書 (Income Statement)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `income-statement/pl-chain` | P/L各段階の計算検証 | error |
+| `income-statement/expense-total` | 経費合計の一致 | error |
+| `income-statement/cogs` | 売上原価の計算検証 | error |
+
+### 帳票間整合性 (Cross-Statement)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `cross-statement/bs-pl-bridge` | B/S⇔P/L所得金額一致 | error |
+| `cross-statement/decision-to-return` | 決算書→申告書の転記一致 | error |
+| `cross-statement/depreciation-sum` | 減価償却合計の一致 | error |
+
+### 控除 (Deductions)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `deductions/blue-deduction-cap` | 青色控除 ≦ 控除前所得 | warning |
+| `deductions/blue-deduction-eligibility` | 65万円控除の適用要件 | info |
+
+### 減価償却 (Depreciation)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `depreciation/useful-life-rates` | 法定耐用年数テーブル照合 | warning |
+| `depreciation/small-asset-threshold` | 少額資産の閾値チェック | warning |
+
+### 継続性 (Continuity)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `continuity/opening-closing-match` | 期首=前年期末の一致 | error |
+| `continuity/year-over-year-change` | 前年比大幅変動の警告 | warning |
+
+### 家事按分 (Home Office)
+
+| ルールID | 説明 | 重要度 |
+|---|---|---|
+| `home-office/reasonable-ratio` | 家事按分率の妥当性 | warning |
+
+## 設定
+
+プロジェクトルートに `.zeicheckrc.json` を配置して、ルールの有効/無効やオプションをカスタマイズできます。
+
+```json
+{
+  "rules": {
+    "balance-sheet/equation": "error",
+    "home-office/reasonable-ratio": ["warning", { "maxRatio": 0.90 }],
+    "continuity/opening-closing-match": "off"
+  },
+  "priorYearFile": "./prior-year.xtx",
+  "format": "stylish",
+  "warningsAsErrors": false
+}
+```
+
+### ルール設定
+
+各ルールの重要度を変更できます:
+
+- `"error"` — エラーとして報告（終了コード1）
+- `"warning"` — 警告として報告
+- `"info"` — 情報として報告
+- `"off"` — ルールを無効化
+
+一部のルールはオプション付きで設定できます:
+
+```json
+{
+  "rules": {
+    "home-office/reasonable-ratio": ["warning", { "maxRatio": 0.50 }]
+  }
+}
+```
+
+## 出力形式
+
+### stylish（デフォルト）
+
+ESLint風のカラー出力。ターミナルでの確認に適しています。
+
+### json
+
+```bash
+zeicheck check data.xtx -f json
+```
+
+CI/CDパイプラインやツール連携に適したJSON形式で出力します。
+
+## 免責事項
+
+本ツールは確定申告データの**形式的な整合性チェック**を目的としたものであり、税務上の正確性・適法性を保証するものではありません。
+
+- 本ツールの検証結果をもって、申告内容が税法上正しいことの証明にはなりません
+- 検証でエラーが検出されなくても、申告内容に誤りがないことを意味するものではありません
+- 税制改正により、ルールが最新の法令に対応していない場合があります
+- 実際の確定申告にあたっては、必ず税理士等の専門家にご相談いただくか、国税庁の公式資料をご確認ください
+
+**本ツールの使用によって生じたいかなる損害についても、開発者は一切の責任を負いません。**
+
+## コントリビューション
+
+zeicheckはコミュニティからの貢献を歓迎します！
+
+### 貢献の方法
+
+- **バグ報告**: [Issues](https://github.com/kalbi-org/zeicheck/issues) で報告してください。再現手順やエラーメッセージを添えていただけると助かります
+- **機能提案**: 新しいルールや機能の要望も Issues でお気軽にどうぞ
+- **プルリクエスト**: バグ修正、新規ルール追加、ドキュメント改善など歓迎します
+
+### 開発環境のセットアップ
+
+```bash
+git clone https://github.com/kalbi-org/zeicheck.git
+cd zeicheck
+npm install
+npm test          # テスト実行
+npm run build     # ビルド
+npm run typecheck # 型チェック
+```
+
+### プルリクエストのガイドライン
+
+1. 既存のテストがすべて通ることを確認してください（`npm test`）
+2. 新しいルールを追加する場合は、対応するユニットテストも追加してください
+3. ルールのメッセージは日本語で記述してください
+4. コミットメッセージは変更内容が分かるように簡潔に書いてください
+
+### 新しいルールの追加方法
+
+1. `src/rules/<カテゴリ>/` にルールファイルを作成
+2. `Rule` インターフェースを実装（`meta` + `check` メソッド）
+3. `src/rules/index.ts` にルールを登録
+4. `tests/unit/rules/<カテゴリ>/` にテストを作成
+
+```typescript
+import type { Rule, RuleContext, RuleDiagnostic } from "../types.js";
+
+export const myRule: Rule = {
+  meta: {
+    id: "category/my-rule",
+    name: "ルール名",
+    description: "ルールの詳細説明",
+    severity: "error",
+  },
+  check(ctx: RuleContext): RuleDiagnostic[] {
+    // 検証ロジック
+    return [];
+  },
+};
+```
+
+## ライセンス
+
+MIT

package/data/useful-life-table.json

@@ -0,0 +1,45 @@
+{
+  "buildings": {
+    "木造": { "usefulLife": 22, "straightLineRate": 0.046, "decliningRate": null },
+    "木骨モルタル造": { "usefulLife": 20, "straightLineRate": 0.050, "decliningRate": null },
+    "鉄骨鉄筋コンクリート造": { "usefulLife": 47, "straightLineRate": 0.022, "decliningRate": null },
+    "鉄筋コンクリート造": { "usefulLife": 47, "straightLineRate": 0.022, "decliningRate": null },
+    "鉄骨造（4mm超）": { "usefulLife": 34, "straightLineRate": 0.030, "decliningRate": null },
+    "鉄骨造（3mm超4mm以下）": { "usefulLife": 27, "straightLineRate": 0.038, "decliningRate": null },
+    "鉄骨造（3mm以下）": { "usefulLife": 19, "straightLineRate": 0.053, "decliningRate": null }
+  },
+  "buildingImprovements": {
+    "木造": { "usefulLife": 15, "straightLineRate": 0.067, "decliningRate": null },
+    "鉄筋コンクリート造": { "usefulLife": 15, "straightLineRate": 0.067, "decliningRate": null },
+    "その他": { "usefulLife": 15, "straightLineRate": 0.067, "decliningRate": null }
+  },
+  "furniture": {
+    "金属製（事務机等）": { "usefulLife": 15, "straightLineRate": 0.067, "decliningRate": 0.133 },
+    "その他（木製家具等）": { "usefulLife": 8, "straightLineRate": 0.125, "decliningRate": 0.250 },
+    "冷暖房用機器": { "usefulLife": 6, "straightLineRate": 0.167, "decliningRate": 0.333 },
+    "電気冷蔵庫": { "usefulLife": 6, "straightLineRate": 0.167, "decliningRate": 0.333 }
+  },
+  "vehicles": {
+    "普通自動車": { "usefulLife": 6, "straightLineRate": 0.167, "decliningRate": 0.333 },
+    "軽自動車": { "usefulLife": 4, "straightLineRate": 0.250, "decliningRate": 0.500 },
+    "二輪車（排気量125cc超）": { "usefulLife": 3, "straightLineRate": 0.334, "decliningRate": 0.667 },
+    "自転車": { "usefulLife": 2, "straightLineRate": 0.500, "decliningRate": 1.000 }
+  },
+  "tools": {
+    "測定工具": { "usefulLife": 5, "straightLineRate": 0.200, "decliningRate": 0.400 },
+    "治具": { "usefulLife": 3, "straightLineRate": 0.334, "decliningRate": 0.667 }
+  },
+  "computers": {
+    "パソコン": { "usefulLife": 4, "straightLineRate": 0.250, "decliningRate": 0.500 },
+    "サーバー": { "usefulLife": 5, "straightLineRate": 0.200, "decliningRate": 0.400 }
+  },
+  "software": {
+    "自社利用（複写販売用）": { "usefulLife": 3, "straightLineRate": 0.334, "decliningRate": null },
+    "自社利用（その他）": { "usefulLife": 5, "straightLineRate": 0.200, "decliningRate": null }
+  },
+  "machinery": {
+    "食料品製造用": { "usefulLife": 10, "straightLineRate": 0.100, "decliningRate": 0.200 },
+    "印刷用": { "usefulLife": 10, "straightLineRate": 0.100, "decliningRate": 0.200 },
+    "その他": { "usefulLife": 10, "straightLineRate": 0.100, "decliningRate": 0.200 }
+  }
+}