File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# codegrid-markdown
22
3- [ CodeGrid] ( https://www.codegrid.net/ ) の記事で使われているMarkdown拡張記法を含んだ、[ markded] ( https://marked.js.org/ ) ベースのMarkdownライブラリーです。
3+ [ CodeGrid] ( https://www.codegrid.net/ ) の記事で使われているMarkdown拡張記法を含んだ、[ marked] ( https://marked.js.org/ ) ベースのMarkdownライブラリーです。
4+
5+ ## 動作環境
6+
7+ Node.js 24以上が必要です。
48
59## 使い方
610
@@ -266,14 +270,35 @@ cgmdのレンダラは`lib/renderer/cgmd/`に追加し、`lib/renderer/cgmd.js`
266270
267271### テスト
268272
269- テストは`test/`以下に配置し、Node組み込みテストで実行します。全体の実行は`npm test`、反復実行は`npm run test:watch`を使います。レンダラ関連は`test/cgmd/renderer`、トークナイザは`test/cgmd/tokenizer`、トランスフォーマは`test/cgmd/transformer`を参照・追加します。
273+ テストは`test/`以下に配置し、Node組み込みテストで実行します。
274+
275+ | コマンド | 説明 |
276+ |---|---|
277+ | `npm test` | 全テストを実行 |
278+ | `npm run test:watch` | ファイル変更を監視しながら反復実行 |
279+ | `npm run test:update-snapshots` | スナップショットを更新 |
280+
281+ テストの配置:
282+
283+ - レンダラ:`test/cgmd/renderer/`
284+ - トークナイザ:`test/cgmd/tokenizer/`
285+ - トランスフォーマ:`test/cgmd/transformer/`
286+ - CLI:`test/cgmd/cli.js`
287+
288+ #### スナップショットテスト
289+
290+ CLIのテスト(`test/cgmd/cli.js`)は`node:test`のスナップショット機能(`t.assert.snapshot()`)を使っています。スナップショットは`test/cgmd/cli.js.snapshot`に保存されており、コミット対象です。
291+
292+ CLIの出力が意図的に変わった場合は`npm run test:update-snapshots`でスナップショットを更新してからコミットしてください。
270293
271294### 開発の流れ
272295
296+ - **環境**:Node.js 24以上が必要です
273297- 依存を整える:`npm ci`
274298- 実装を加える:拡張は`lib/renderer/cgmd/`、DOM整形は`lib/transformer/`
275299- 動作確認:サンプルの`npm run example`または最小入力での単体実行
276300- テスト:失敗→修正→`npm run test:watch`で反復
301+ - スナップショット更新:CLIの出力が変わった場合は`npm run test:update-snapshots`
277302- ドキュメント:新しい記法やオプションは`README.md`に追記
278303
279304## LICENSE
You can’t perform that action at this time.
0 commit comments