vimd 0.1.12 → 0.2.1

package/README.md

@@ -2,128 +2,128 @@
 
 🌐 [English](README-en.md) | 日本語
 
-> pandocを使ったリアルタイムMarkdownプレビューツール (view markdown)
+> 書きながら見る。Markdownプレビュー
 
 [![npm version](https://img.shields.io/npm/v/vimd.svg)](https://www.npmjs.com/package/vimd)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-≥18-green.svg)](https://nodejs.org/)
 
-**vimd** は、pandocを使用した高速でシンプルなMarkdownプレビューツールです。複数のテーマに対応したリアルタイムHTMLプレビューを提供します。
+---
 
-## 特徴
+## デモ
 
-- **リアルタイムプレビュー**: ファイル保存時にブラウザが即座に更新 (live-server)
-- **複数テーマ**: 5つの組み込みテーマ (GitHub, Minimal, Dark, Academic, Technical)
-- **pandoc連携**: pandocによる高品質なMarkdown変換
-- **グローバル設定**: プロジェクトディレクトリを汚さない `~/.vimd/config.js`
-- **対話的設定**: `vimd theme` や `vimd config` で簡単に設定変更
-- **クロスプラットフォーム**: macOS, Linux, Windows で動作
+![vimd demo](assets/demo.gif)
 
-## インストール
+---
 
-```bash
-npm install -g vimd
-```
+## テーマ
 
-初回起動時に `vimd theme` で好みのテーマを選択できます。
+<details open>
+<summary><strong>GitHub</strong> (デフォルト)</summary>
 
-### 必要要件
+![GitHub Theme](assets/theme-github.png)
 
-- **Node.js** >= 18.0.0 (ESMサポートが必要)
-- **pandoc** >= 2.0 (別途インストールが必要)
+</details>
 
-pandocのインストール方法:
+<details>
+<summary><strong>Dark</strong></summary>
 
-```bash
-# macOS
-brew install pandoc
+![Dark Theme](assets/theme-dark.png)
 
-# Ubuntu/Debian
-sudo apt install pandoc
+</details>
 
-# Windows
-choco install pandoc
-```
+<details>
+<summary><strong>Academic</strong></summary>
 
-## クイックスタート
+![Academic Theme](assets/theme-academic.png)
 
-```bash
-# ライブプレビューを開始
-vimd dev draft.md
+</details>
 
-# 静的HTMLを生成
-vimd build draft.md
+<details>
+<summary><strong>Minimal</strong></summary>
 
-# テーマを変更
-vimd theme
+![Minimal Theme](assets/theme-minimal.png)
 
-# 設定を編集
-vimd config
-```
+</details>
 
-## コマンド
+<details>
+<summary><strong>Technical</strong></summary>
 
-### `vimd dev <file>`
+![Technical Theme](assets/theme-technical.png)
 
-ホットリロード対応のライブプレビューサーバーを起動します。ブラウザを自動で開き、ファイルの変更を監視します。
+</details>
 
-```bash
-vimd dev draft.md
-vimd dev docs/guide.md --port 3000
-vimd dev article.md --theme dark --no-open
-```
+---
 
-**オプション:**
+## クイックスタート
 
-- `-p, --port <port>`: ポート番号 (デフォルト: 8080)
-- `-t, --theme <theme>`: テーマ名 (グローバル設定を上書き)
-- `--no-open`: ブラウザを自動で開かない
+### 必要要件
 
-### `vimd build <file>`
+- **Node.js** >= 18.0.0
+- **pandoc** >= 2.0（オプション、高品質ビルド時のみ）
 
-静的HTMLファイルを生成します。スタイルが埋め込まれたスタンドアロンHTMLを出力します。
+### インストール
 
 ```bash
-vimd build draft.md
-vimd build docs/guide.md -o dist/guide.html
-vimd build article.md --theme academic
+npm install -g vimd
 ```
 
-**オプション:**
-
-- `-o, --output <path>`: 出力ファイルパス (デフォルト: 同名で拡張子.html)
-- `-t, --theme <theme>`: テーマ名 (グローバル設定を上書き)
+v0.2.0 からは **pandoc なしで利用可能** になりました。
+高品質な出力が必要な場合のみ pandoc をインストールしてください。
 
-### `vimd theme`
+```bash
+# pandocのインストール（オプション）
+brew install pandoc        # macOS
+sudo apt install pandoc    # Ubuntu/Debian
+choco install pandoc       # Windows
+```
 
-対話的にテーマを変更します。5つの組み込みテーマから選択できます。
+### 使い方
 
 ```bash
-vimd theme
-```
+# ライブプレビューを開始（pandoc不要、高速）
+vimd dev draft.md
 
-### `vimd config`
+# 静的HTMLを生成（pandoc使用、高品質）
+vimd build draft.md
 
-対話的に設定を編集します。テーマ、ポート、その他の設定を変更できます。
+# 高速ビルド（pandoc不要）
+vimd build draft.md --fast
 
-```bash
-# 対話的な設定エディタ
-vimd config
+# テーマを変更
+vimd theme
 
-# 現在の設定を表示
-vimd config --list
+# 設定を編集
+vimd config
 ```
 
-## テーマ
+---
+
+## コマンド
 
-vimdには5つの組み込みテーマがあります:
+| コマンド | 説明 |
+|---------|------|
+| `vimd dev <file>` | ライブプレビューサーバーを起動 |
+| `vimd build <file>` | 静的HTMLを生成 |
+| `vimd theme` | テーマを対話的に変更 |
+| `vimd config` | 設定を対話的に編集 |
 
-| テーマ        | 説明                              | 用途                 |
-| ------------- | --------------------------------- | -------------------- |
-| **GitHub**    | GitHub Markdownスタイル (推奨)    | 一般的なドキュメント |
-| **Minimal**   | シンプルな白背景                  | 集中して書きたいとき |
-| **Dark**      | VS Codeインスパイアのダークモード | 夜間の作業           |
-| **Academic**  | 論文スタイルのレイアウト          | 学術論文、研究文書   |
-| **Technical** | APIドキュメントスタイル           | 技術仕様書、API文書  |
+### オプション
+
+```bash
+# dev コマンド
+vimd dev draft.md --port 3000      # ポート指定
+vimd dev draft.md --theme dark     # テーマ指定
+vimd dev draft.md --no-open        # ブラウザを開かない
+vimd dev draft.md --pandoc         # pandocパーサーを使用
+
+# build コマンド
+vimd build draft.md -o output.html # 出力先指定
+vimd build draft.md --fast         # markdown-itで高速ビルド
+vimd build draft.md --theme dark   # テーマ指定
+```
+
+---
 
 ## 設定
 
@@ -133,138 +133,56 @@ vimdには5つの組み込みテーマがあります:
 export default {
   theme: 'github',
   port: 8080,
-  host: 'localhost',
   open: true,
-  pandoc: {
-    standalone: true,
-    toc: false,
-    highlightStyle: 'github',
-  },
-  watch: {
-    ignored: ['node_modules', '.git'],
-  },
+  devParser: 'markdown-it',  // dev用パーサー（デフォルト: markdown-it）
+  buildParser: 'pandoc',     // build用パーサー（デフォルト: pandoc）
 };
 ```
 
-### 設定オプション
-
-- `theme`: デフォルトテーマ名 (文字列)
-- `port`: 開発サーバーのポート (数値、デフォルト: 8080)
-- `host`: 開発サーバーのホスト (文字列、デフォルト: 'localhost')
-- `open`: ブラウザを自動で開く (真偽値、デフォルト: true)
-- `pandoc.standalone`: スタンドアロンHTMLを生成 (真偽値)
-- `pandoc.toc`: 目次を生成 (真偽値)
-- `pandoc.highlightStyle`: コードハイライトスタイル (文字列)
-- `watch.ignored`: ファイル監視で無視するパターン (配列)
-
-## API使用
-
-vimdはNode.jsライブラリとしても使用できます:
-
-```javascript
-import { MarkdownConverter, ConfigLoader, ThemeManager } from 'vimd';
-
-// 設定を読み込む
-const config = await ConfigLoader.loadGlobal();
-
-// コンバーターを作成
-const converter = new MarkdownConverter({
-  theme: 'github',
-  pandocOptions: config.pandoc,
-});
-
-// MarkdownをHTMLに変換
-const html = await converter.convertWithTemplate('draft.md');
-
-// 利用可能なテーマを一覧表示
-const themes = ThemeManager.list();
-console.log(themes); // [{ name: 'github', displayName: 'GitHub' }, ...]
-```
-
-## 開発
-
-```bash
-# リポジトリをクローン
-git clone https://github.com/notokeishou/vimd.git
-cd vimd
-
-# 依存関係をインストール
-npm install
-
-# ビルド
-npm run build
-
-# テストを実行
-npm test
-
-# カバレッジ付きでテスト
-npm run test:coverage
-
-# 開発モード
-npm run dev -- dev test.md
-```
-
-### プロジェクト構造
+### パーサー設定
 
-```
-vimd/
-├── src/
-│   ├── cli/          # CLIコマンド
-│   ├── config/       # 設定管理
-│   ├── core/         # コア機能 (converter, watcher, server)
-│   ├── themes/       # テーマシステム
-│   └── utils/        # ユーティリティ関数
-├── tests/
-│   ├── unit/         # ユニットテスト
-│   └── integration/  # 統合テスト
-├── templates/        # HTMLテンプレート
-└── dist/            # ビルド済みファイル
-```
+| パーサー | 特徴 | 用途 |
+|----------|------|------|
+| `markdown-it` | 高速、pandoc不要 | 開発時のプレビュー |
+| `pandoc` | 高品質、多機能 | 最終出力の生成 |
 
-## トラブルシューティング
+詳細な設定オプションは [docs/ja/api.md](docs/ja/api.md) を参照してください。
 
-### pandocが見つからない
+---
 
-「pandoc not found」エラーが出る場合:
+## Why vimd?
 
-1. パッケージマネージャーでpandocをインストール
-2. インストールを確認: `pandoc --version`
-3. ターミナルを再起動
+| 特徴 | vimd | 他のツール |
+|------|------|-----------|
+| セットアップ | `npm i -g vimd` | 複雑な設定が必要な場合も |
+| 外部依存 | なし（pandocはオプション） | pandoc必須が多い |
+| 変換品質 | markdown-it / pandoc 選択可 | 固定 |
+| テーマ | 5種類組み込み | 別途設定が必要 |
+| 設定ファイル | プロジェクト外 (`~/.vimd/`) | プロジェクト内が多い |
+| ライブリロード | 自動 | 手動リロードが必要な場合も |
 
-### ポートが使用中
+---
 
-ポート8080が既に使用中の場合:
+## ドキュメント
 
-```bash
-vimd dev draft.md --port 3000
-```
+- [開発ガイド](docs/ja/development.md) - 開発環境構築
+- [アーキテクチャ](docs/ja/architecture.md) - プロジェクト構造
+- [APIリファレンス](docs/ja/api.md) - 詳細なオプション
+- [テスト](docs/ja/testing.md) - テスト構成
+- [トラブルシューティング](docs/ja/troubleshooting.md) - よくある問題
+- [v0.2.0 リリースノート](docs/ja/releases/v0.2.0.md) - Dual Parser System
 
-または `~/.vimd/config.js` でデフォルトポートを変更してください。
+---
 
-### テーマが適用されない
+## リンク
 
-以下を確認してください:
+- [CONTRIBUTING.md](CONTRIBUTING.md) - コントリビューションガイド
+- [CHANGELOG.md](CHANGELOG.md) - 変更履歴
+- [GitHub](https://github.com/notokeishou/vimd)
+- [npm](https://www.npmjs.com/package/vimd)
 
-1. 利用可能なテーマを確認: `vimd theme`
-2. 設定を確認: `vimd config --list`
-3. ソースからの場合は再ビルド: `npm run build`
+---
 
 ## ライセンス
 
 MIT © notokeishou
-
-## コントリビューション
-
-コントリビューションを歓迎します! プルリクエストの提出方法については [CONTRIBUTING.md](CONTRIBUTING.md) をお読みください。
-
-## 変更履歴
-
-リリース履歴は [CHANGELOG.md](CHANGELOG.md) を参照してください。
-
-## リンク
-
-- [GitHubリポジトリ](https://github.com/notokeishou/vimd)
-- [npmパッケージ](https://www.npmjs.com/package/vimd)
-- [Issue Tracker](https://github.com/notokeishou/vimd/issues)
-
----

package/dist/cli/commands/build.d.ts

@@ -1,6 +1,7 @@
 interface BuildOptions {
     output?: string;
     theme?: string;
+    fast?: boolean;
 }
 export declare function buildCommand(filePath: string, options: BuildOptions): Promise<void>;
 export {};

package/dist/cli/commands/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/build.ts"],"names":[],"mappings":"AAQA,UAAU,YAAY;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,IAAI,CAAC,CA0Df"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/build.ts"],"names":[],"mappings":"AASA,UAAU,YAAY;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,IAAI,CAAC,CAmEf"}

package/dist/cli/commands/build.js

@@ -2,6 +2,7 @@
 import { ConfigLoader } from '../../config/loader.js';
 import { MarkdownConverter } from '../../core/converter.js';
 import { PandocDetector } from '../../core/pandoc-detector.js';
+import { ParserFactory } from '../../core/parser/index.js';
 import { Logger } from '../../utils/logger.js';
 import * as path from 'path';
 import fs from 'fs-extra';
@@ -15,30 +16,38 @@ export async function buildCommand(filePath, options) {
             config.theme = options.theme;
         }
         Logger.info(`Theme: ${config.theme}`);
-        // 2. Check pandoc installation
-        PandocDetector.ensureInstalled();
-        // 3. Check file exists
+        // 2. Determine parser type
+        const parserType = options.fast ? 'markdown-it' : config.buildParser;
+        Logger.info(`Parser: ${parserType}`);
+        // 3. Check pandoc installation only if pandoc parser is selected
+        if (parserType === 'pandoc') {
+            PandocDetector.ensureInstalled();
+        }
+        // 4. Check file exists
         const absolutePath = path.resolve(filePath);
         if (!(await fs.pathExists(absolutePath))) {
             Logger.error(`File not found: ${filePath}`);
             process.exit(1);
         }
-        // 4. Determine output path
+        // 5. Determine output path
         const outputPath = options.output
             ? path.resolve(options.output)
             : path.join(path.dirname(absolutePath), path.basename(filePath, path.extname(filePath)) + '.html');
         Logger.info(`Output: ${outputPath}`);
-        // 5. Prepare converter
+        // 6. Prepare converter with selected parser
+        const pandocOptions = {
+            ...config.pandoc,
+            standalone: true, // build always uses standalone
+        };
+        const parser = ParserFactory.create(parserType, pandocOptions);
         const converter = new MarkdownConverter({
             theme: config.theme,
-            pandocOptions: {
-                ...config.pandoc,
-                standalone: true, // build always uses standalone
-            },
+            pandocOptions: pandocOptions,
             customCSS: config.css,
             template: config.template || undefined,
         });
-        // 6. Execute conversion
+        converter.setParser(parser);
+        // 7. Execute conversion
         Logger.info('Converting...');
         const html = await converter.convertWithTemplate(absolutePath);
         await converter.writeHTML(html, outputPath);

package/dist/cli/commands/dev.d.ts

@@ -2,6 +2,7 @@ interface DevOptions {
     port?: string;
     theme?: string;
     open?: boolean;
+    pandoc?: boolean;
 }
 export declare function devCommand(filePath: string, options: DevOptions): Promise<void>;
 export {};

package/dist/cli/commands/dev.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/dev.ts"],"names":[],"mappings":"AAYA,UAAU,UAAU;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,IAAI,CAAC,CA+If"}
+{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/dev.ts"],"names":[],"mappings":"AAaA,UAAU,UAAU;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,UAAU,GAClB,OAAO,CAAC,IAAI,CAAC,CA6Jf"}

package/dist/cli/commands/dev.js

@@ -4,6 +4,7 @@ import { FileWatcher } from '../../core/watcher.js';
 import { MarkdownConverter } from '../../core/converter.js';
 import { LiveServer } from '../../core/server.js';
 import { PandocDetector } from '../../core/pandoc-detector.js';
+import { ParserFactory } from '../../core/parser/index.js';
 import { Logger } from '../../utils/logger.js';
 import { ProcessManager } from '../../utils/process-manager.js';
 import { SessionManager } from '../../utils/session-manager.js';
@@ -47,50 +48,62 @@ export async function devCommand(filePath, options) {
         }
         Logger.info(`Theme: ${config.theme}`);
         Logger.info(`Port: ${port}`);
-        // 5. Check pandoc installation
-        PandocDetector.ensureInstalled();
-        // 6. Check file exists
+        // 5. Determine parser type
+        const parserType = options.pandoc ? 'pandoc' : config.devParser;
+        Logger.info(`Parser: ${parserType}`);
+        // 6. Check pandoc installation only if pandoc parser is selected
+        if (parserType === 'pandoc') {
+            PandocDetector.ensureInstalled();
+        }
+        // 7. Check file exists
         const absolutePath = path.resolve(filePath);
         if (!(await fs.pathExists(absolutePath))) {
             Logger.error(`File not found: ${filePath}`);
             process.exit(1);
         }
-        // 7. Prepare output HTML in source directory
+        // 8. Prepare output HTML in source directory
         const sourceDir = path.dirname(absolutePath);
         const basename = path.basename(filePath, path.extname(filePath));
         const htmlFileName = `vimd-preview-${basename}.html`;
         const htmlPath = path.join(sourceDir, htmlFileName);
-        // 8. Prepare converter
+        // 9. Prepare converter with selected parser
+        const parser = ParserFactory.create(parserType, config.pandoc);
         const converter = new MarkdownConverter({
             theme: config.theme,
             pandocOptions: config.pandoc,
             customCSS: config.css,
             template: config.template,
         });
-        // 9. Initial conversion
+        converter.setParser(parser);
+        // 10. Initial conversion
         Logger.info('Converting markdown...');
         const html = await converter.convertWithTemplate(absolutePath);
         await converter.writeHTML(html, htmlPath);
         Logger.success('Conversion complete');
-        // 10. Start live server from source directory
+        // 11. Start live server from source directory
         const server = new LiveServer({
             port: port,
             host: config.host,
             open: config.open,
             root: sourceDir,
         });
-        await server.start(htmlPath);
-        // 11. Save session
+        const startResult = await server.start(htmlPath);
+        // Update port if live-server used a different one
+        const actualPort = startResult.actualPort;
+        if (startResult.portChanged) {
+            port = actualPort;
+        }
+        // 12. Save session with actual port
         await SessionManager.saveSession({
             pid: process.pid,
-            port: port,
+            port: actualPort,
             htmlPath: htmlPath,
             sourcePath: absolutePath,
             startedAt: new Date().toISOString(),
         });
         Logger.info(`Watching: ${filePath}`);
         Logger.info('Press Ctrl+C to stop');
-        // 12. Start file watching
+        // 13. Start file watching
         const watcher = new FileWatcher(absolutePath, config.watch);
         watcher.onChange(async (changedPath) => {
             Logger.info('File changed, reconverting...');
@@ -107,7 +120,7 @@ export async function devCommand(filePath, options) {
             }
         });
         watcher.start();
-        // 13. Register cleanup - remove generated HTML file and session
+        // 14. Register cleanup - remove generated HTML file and session
         ProcessManager.onExit(async () => {
             Logger.info('Shutting down...');
             await watcher.stop();
@@ -120,8 +133,8 @@ export async function devCommand(filePath, options) {
             catch {
                 // Ignore errors when removing file
             }
-            // Remove session from registry
-            await SessionManager.removeSession(port);
+            // Remove session from registry (use actual port)
+            await SessionManager.removeSession(actualPort);
             Logger.info('Cleanup complete');
         });
     }

package/dist/cli/commands/kill.d.ts

@@ -0,0 +1,7 @@
+interface KillOptions {
+    all?: boolean;
+    port?: string;
+}
+export declare function killCommand(options: KillOptions): Promise<void>;
+export {};
+//# sourceMappingURL=kill.d.ts.map

package/dist/cli/commands/kill.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kill.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/kill.ts"],"names":[],"mappings":"AAQA,UAAU,WAAW;IACnB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAsDD,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAyErE"}