Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
aecb5a2
Initial commit
kohki-shikata Aug 1, 2026
58a8f1f
initial commit
kohki-shikata Aug 1, 2026
f695bc0
Reconstruct directories
kohki-shikata Aug 1, 2026
62c9a57
doc: add index
kohki-shikata Aug 13, 2026
2d024af
Update doc - versioning rule
kohki-shikata Aug 13, 2026
1a69941
Update doc - Git rule
kohki-shikata Aug 13, 2026
467cf62
Update thin ddd
kohki-shikata Aug 13, 2026
957f113
Update README.md
kohki-shikata Aug 13, 2026
faef5ef
Merge pull request #3 from b4moss/update-docs
kohki-shikata Aug 13, 2026
0af9817
Update charter
kohki-shikata Aug 14, 2026
2288d6a
Generalize README for shared charter.
kohki-shikata Aug 14, 2026
8100326
Generalize TDD rules away from a single product.
kohki-shikata Aug 14, 2026
eea47f7
Generalize Thin DDD away from a single app stack.
kohki-shikata Aug 14, 2026
27f0ce2
Generalize docs layout away from product-specific domains.
kohki-shikata Aug 14, 2026
44a98f8
Fix SemVer spelling.
kohki-shikata Aug 14, 2026
0edba1b
Update docs directory structure
kohki-shikata Aug 14, 2026
f885d50
Merge pull request #4 from b4moss/update-charter
kohki-shikata Aug 14, 2026
3837501
Add override doc
kohki-shikata Aug 19, 2026
82229e0
Update charter's gist
kohki-shikata Aug 19, 2026
49d861e
Update git-rule
kohki-shikata Aug 19, 2026
b94e879
Merge pull request #6 from b4moss/update-charter
kohki-shikata Aug 19, 2026
f195367
Update charter
kohki-shikata Aug 25, 2026
86db315
Merge pull request #7 from b4moss/update-charter
kohki-shikata Aug 25, 2026
e89de45
Merge pull request #48 from b4moss/develop
kohki-shikata Sep 25, 2026
9dc1c2e
docs: v0.6.0 破壊的変更の移行例と仕様書メタを更新 (#50)
kohki-shikata Sep 25, 2026
dbc408e
Rewrite docs as OKF v0.1 knowledge bundle
cursoragent Sep 25, 2026
e5d3f49
Merge charter/docs (v1.1.0 OKF)
kohki-shikata Sep 25, 2026
06e8a59
docs: charter構成に合わせて既存ドキュメントを整理
kohki-shikata Sep 25, 2026
0360433
docs: 移動に合わせて README のリンクを更新
kohki-shikata Sep 25, 2026
56b30c8
docs: charter v1.2.0 / OKF v0.1 に合わせて docs を整列
cursoragent Sep 27, 2026
e5bee5c
docs: コード正本に合わせて specs/tests のラグを解消
cursoragent Sep 27, 2026
b076979
Merge pull request #52 from b4moss/cursor/okf-docs-align-d9ad
kohki-shikata Sep 29, 2026
fc485f5
docs: sync charter to v1.3.0
cursoragent Oct 8, 2026
0c47042
Merge pull request #53 from b4moss/update-charter-v1.3
kohki-shikata Oct 21, 2026
fe5ac1b
ci: run Scorecard on schedule and workflow_dispatch only
cursoragent Oct 22, 2026
7e56d4a
ci: ignore docs-only pushes in Codecov workflow
cursoragent Oct 22, 2026
f852456
ci: point Dependabot PRs at develop for CI
cursoragent Oct 22, 2026
6272d55
docs: align CI/CD specs with Scorecard and Dependabot triggers
cursoragent Oct 22, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Dependabot opens update PRs only; no auto-merge.
# target-branch: develop so PRs hit CI (ci.yml bases: develop / dev-*).
version: 2
updates:
- package-ecosystem: npm
directory: /
target-branch: develop
schedule:
interval: weekly
day: monday
Expand All @@ -24,6 +26,7 @@ updates:

- package-ecosystem: github-actions
directory: /
target-branch: develop
schedule:
interval: weekly
day: monday
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ on:
push:
branches:
- main
# Docs / markdown-only pushes should not burn CI minutes or Codecov uploads.
paths-ignore:
- "docs/**"
- "**/*.md"
- "LICENSE"
- ".github/**/*.md"

concurrency:
group: codecov-${{ github.workflow }}-${{ github.ref }}
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ on:
branch_protection_rule:
schedule:
- cron: "30 1 * * 1"
push:
branches:
- main
# Manual refresh when needed; avoid re-scoring on every main push
# (including docs-only merges).
workflow_dispatch:

permissions: read-all

Expand Down
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Tree-shakeable **browser-only** cache helper. Pick a **driver** (localStorage /

Extracted and generalized from the cache logic in [`@b4moss/jp-local-gov-id`](https://github.com/b4moss/jp-local-gov-id).

CI/CD: [docs/ci-cd.md](./docs/ci-cd.md)
Docs hub: [docs/README.md](./docs/README.md) · OKF index: [docs/index.md](./docs/index.md)
CI/CD: [docs/specs/ops/ci-cd.md](./docs/specs/ops/ci-cd.md)

## Install

Expand Down Expand Up @@ -110,6 +111,22 @@ Legacy entries without `createdAt` are left alone by `olderThan` and absolute-ti
- Public `clear()` MethodDef / `@b4moss/cachian/methods/clear` removed — use `purge({ all: true })`.
- `remove(key)` deletes a **single** key only; multi-key deletion is `purge({ keys })`.

Migration:

```ts
// before (v0.5 and earlier) — full clear
await cache.clear();

// after (v0.6) — full clear
await cache.purge({ all: true });

// single key
await cache.remove("a");

// multiple keys
await cache.purge({ keys: ["a", "b"] });
```

## Breaking changes (v0.4)

- `createCache()` no longer returns a fixed full API; pass `driver` + `methods`.
Expand Down
19 changes: 18 additions & 1 deletion README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@

[`@b4moss/jp-local-gov-id`](https://github.com/b4moss/jp-local-gov-id) のキャッシュロジックを外出し・汎用化したものです。

CI/CD: [docs/ci-cd.ja.md](./docs/ci-cd.ja.md)
Docs hub: [docs/README.md](./docs/README.md) · OKF 索引: [docs/index.md](./docs/index.md)
CI/CD: [docs/specs/ops/ci-cd.ja.md](./docs/specs/ops/ci-cd.ja.md)

## インストール

Expand Down Expand Up @@ -110,6 +111,22 @@ await cache.purge({ expired: true });
- 公開 `clear()` MethodDef / `@b4moss/cachian/methods/clear` を廃止 — 全削除は `purge({ all: true })`
- `remove(key)` は **単一キーのみ**削除。複数キー削除は `purge({ keys })`

移行例:

```ts
// 以前(v0.5 以前)— 全削除
await cache.clear();

// 以後(v0.6)— 全削除
await cache.purge({ all: true });

// 単一キー
await cache.remove("a");

// 複数キー
await cache.purge({ keys: ["a", "b"] });
```

## 破壊的変更(v0.4)

- `createCache()` は固定フル API を返さず、`driver` + `methods` の指定が必須
Expand Down
45 changes: 45 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# @b4moss/cachian

プロダクトの意味的な pillar 正本(目的・スコープ・技術方針のハブ)。
OKF の版索引は [`index.md`](./index.md)(`okf_version` のみ)。

## 目的

ブラウザ専用のツリーシェイク可能なキャッシュヘルパー。
[`@b4moss/jp-local-gov-id`](https://github.com/b4moss/jp-local-gov-id) のキャッシュロジックを外出し・汎用化し、キー・値はドメイン非依存とする。

## スコープ

- **やること**
- ドライバ(localStorage / IndexedDB)と必要な MethodDef(`get` / `set` / `update` / `upsert` / `remove` / `has` / `purge`)だけを選んで組み立てる
- 非同期 API・TTL・エントリ形式 `{ expiresAt, data, createdAt? }`・条件付きパージ
- ブラウザ環境ガード(`CachianEnvironmentError`。現行はドライバ factory 時)
- CDN / IIFE バンドル(`createFullCache` 含む。詳細は [`specs/core/`](./specs/core/))
- **やらぬこと**
- Node / SSR 向けストレージ実装の保証
- CDN / IIFE のブラウザ手動確認を受け入れ TC の必須にすること
- 任意カスタム `StorageAdapter` の公開互換保証(形状は実装詳細。npm ルートからは非 export)
- ドキュメントサイト(現状 out of scope)

## 技術方針

- 単一 npm パッケージ `@b4moss/cachian`(TypeScript / Vitest)。テスト正本ファイルは `src/createCache.test.ts`
- 公開面はサブパス exports(ルートから drivers / methods を再エクスポートしない)
- IIFE は `src/cdn.ts` → `dist/cachian.iife(.min).js`(グローバル `Cachian`)
- `sideEffects: false`、ランタイム依存ゼロ
- CI/CD 契約: [`specs/ops/ci-cd.md`](./specs/ops/ci-cd.md)(日本語: [`ci-cd.ja.md`](./specs/ops/ci-cd.ja.md))
- 開発ルール: [`charter/`](./charter/)(OKF v0.1: [`charter/okf/`](./charter/okf/))

現行機能の仕様正本は `docs/specs/`(ドメイン: `core` / `drivers` / `methods` / `ops`)。
受け入れケースは `docs/tests/`(同じドメイン切り)。

## 索引

- [roadmap](./roadmap.md) — SemVer・マイルストーン
- [wishlist](./wishlist.md) — PO メモ
- [plans](./plans/) — これからやる内容
- [specs](./specs/) — 現行仕様
- [tests](./tests/) — テスト仕様
- [憲章](./charter/) — 開発ルール
- [override-charter](./override-charter.md) — 憲章オーバーライド
- ルート [README](../README.md) / [README (ja)](../README_ja.md)
89 changes: 89 additions & 0 deletions docs/charter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
type: Charter
title: 憲章(charter)
description: 合同会社 知的・自転車の開発方針の最上位取り決め。
tags: [charter]
timestamp: 2026-10-08
---
# 憲章(charter)

**憲章(charter)** は、合同会社 知的・自転車が開発するプロダクトの開発方針の最上位に位置付けられるもの取り決めです。
開発にあたっては、まず憲章を確認し、その方針に従って進めてください。

この憲章は、合同会社 知的・自転車のOSS部門によって[ホスト](https://github.com/b4moss/charter)されています。

各プロジェクトには、この憲章リポジトリ **`main` ブランチの `docs/`**(OKF v0.1)を共有します。かつての `docs` 専用ブランチは使いません。

共有の仕方は、プロジェクトに応じて適切なものを以下から選びます。

1. charter を `remote` に追加し、`charter/main` をマージ(共有対象は `docs/`)。
2. charter を submodule で追加。
3. charter を `remote` に追加し、`subtree` で `docs/` を取り込む。

どの方式を取るかは、プロジェクトに応じてPOが判断をします。具体的なコマンド例はリポジトリルートの [README.md](../../README.md) を参照。

## 憲章の更新

上記のいずれを取ったとしても、各プロジェクトで憲章を更新(上書き・削除)することは禁止します。

憲章は、`charter` のリポジトリが更新されることにより、各プロジェクトで `pull` します。

## 憲章の沿わない事項の扱い

各プロジェクトにおいて、憲章に沿わない事項が出た場合は [/docs/override-charter.md](../override-charter.md)に記載します。

ここに記述された内容は、憲章の内容よりも優先されます。

ここに記述するかどうかは、POが判断します。

## 概要

憲章では、大まかに以下の内容が定められています。

| 文書 | 内容 |
|------|------|
| [tdd.md](./tdd.md) | TDD 方針(氷山パターン、テスト仕様書) |
| [thin-ddd.md](./thin-ddd.md) | 薄い DDD(Controller / Service / Repository / Validation) |
| [git-rule.md](./git-rule.md) | git の運用について |
| [versioning-rule.md](./versioning-rule.md) | バージョンの運用方法について |
| [doc-rule.md](./doc-rule.md) | ドキュメント運用方針 |
| README.md | 本ドキュメント |

プロダクト要件の正本は、各プロジェクトの `docs/README.md`(pillar)および `docs/specs/` とする。`docs/index.md` は OKF 索引のみ。憲章には詰め込まない。

## 記述フォーマット

当憲章を含め、 **OKF v0.1** をベースとした記述でドキュメントを記述します。

## 適用範囲

### すべてのプロジェクト

- TDD
- Gitルール
- バージョニングルール
- ドキュメントルール

### Webアプリケーション / デスクトップアプリケーション

- 薄いDDD

### CLI、パッケージ、ブラウザ拡張

- 薄いDDDは意識しつつ、CRUDを伴わないものはCRUD Traitを採用しなくとも良い。

### 例外

開発初期状態などは、憲章に沿わない状態を許容する。POが適宜判断。
バージョンを重ねるうちに整えていく。

## GitHub / Gitea 等の Issue や Project について

- 開発時は、LLMとの親和性を考え、`docs/`ベースの記述・開発で良い。
- 開発が進むと、複雑化するため、仕様は`docs/`に残しつつ、実装課題やTODOは、Issueを活用していく。
- ただし、Wikiは用いない。(仕様はコードリポジトリを正とするため)


----

以上
69 changes: 69 additions & 0 deletions docs/charter/ci-cd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
type: Rule
title: "CI/CD方針"
description: "当憲章で定める、CI/CDの方針です。"
owner: PO
role: ['rule']
tags: ['ci','cd','actions','workflow','tests']
status: active
---

# CI/CD方針

## 用語定義

- `CI`: VCSに変更したコードを追加したときに、自動テストを実行する
- `CD`: VCSに変更があり、尚且つ特定の振る舞いがあったときに、実行環境へデプロイする

## CIの責務

- VCS上で自動テストを実行することによって、バグや想定しない振る舞いを検出する
- 自動テストが用意されていても、実装者が手元で実行しない場合に備えるガードの目的
- VCSへのデプロイは頻繁に発生するものであり、CIが過剰で開発速度を妨げてはいけない

## CDの責務

- 新規に開発したり修正したコードを、一刻も早くデリバリーする
- 意図しないデプロイを行わないよう、特定の振る舞いの時だけ、特定の環境に対してデプロイされること

## CI/CDの実装

- [charterのGitルール](./git-rule.md)では、`GitHub`/`Gitea`がVCSのリモートリポジトリである
- 従って、`GitHub Actions`/`Gitea Actions`による、ワークフローで定義され、実行される

## CIの考え方

- Lint、単体・結合テストが全て行われること
- [ブランチ戦略](./git-rule.md)に従い、**開発ブランチ** (`dev-*`) へのPR時に、実行されること
- 開発ブランチ以外の主要ブランチ(develop, main等)へPRの際も、必ず実行されること
- ただし、一度実行されたCIが通過した場合は、上流のPRでスキップすること(コスト低減)
- E2Eテストは、CIには含めない
- ただし、ワークフローには用意し、GitHub/Giteaの管理画面上から、手動で実行できるようにする
- CI実行時のコスト低減が目的だが、必要に応じてマニュアルで実行できる導線を用意しておくことが目的

## CDの考え方

1. 特定のタグを基準とする(基本的には、新しいタグがmainに打たれたもの)
2. その内容が、特定のブランチにマージされた場合に発動
- `staging`: ステージング環境
- `production`: 本番環境
- `release`: パッケージレジストリ(ライブラリ等の場合のみ)
3. 当然、CIが通っていることが前提

## マニュアル自動テスト実行

- 実装者は、PRを作る前に、必ず自動テストを通すこと
- CIに全てを期待しない
- プロジェクト固有のルールによっては、huskyなどを使っても良い(特にOSSなど)
- MINORバージョンアップデート相当の時は、`dev-*`ブランチに全てのコミットが集積された時点で、手元E2Eテストを実行し、必ず通す。
- E2Eテストは、実装者手元で行うこと
- ただし、ワークフローとしては存在し、リポオーナーが必要に応じて、リモート上で実行できる状態とする

## その他

- CIは非常にコストのかかる作業なので、重複や時間のかかることはないようにする
- キャッシュを最大限活用すること

---

以上
Loading
Loading