vimd 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 notokeishou
+
+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,270 @@
+# vimd
+
+🌐 [English](README-en.md) | 日本語
+
+> pandocを使ったリアルタイムMarkdownプレビューツール (view 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)
+
+**vimd** は、pandocを使用した高速でシンプルなMarkdownプレビューツールです。複数のテーマに対応したリアルタイムHTMLプレビューを提供します。
+
+## 特徴
+
+- **リアルタイムプレビュー**: ファイル保存時にブラウザが即座に更新 (live-server)
+- **複数テーマ**: 5つの組み込みテーマ (GitHub, Minimal, Dark, Academic, Technical)
+- **pandoc連携**: pandocによる高品質なMarkdown変換
+- **グローバル設定**: プロジェクトディレクトリを汚さない `~/.vimd/config.js`
+- **対話的セットアップ**: 初回起動時にテーマ選択をガイド
+- **クロスプラットフォーム**: macOS, Linux, Windows で動作
+
+## インストール
+
+```bash
+npm install -g vimd
+```
+
+インストール後、対話的なセットアップで初期設定を行います。
+
+### 必要要件
+
+- **Node.js** >= 18.0.0 (ESMサポートが必要)
+- **pandoc** >= 2.0 (別途インストールが必要)
+
+pandocのインストール方法:
+
+```bash
+# macOS
+brew install pandoc
+
+# Ubuntu/Debian
+sudo apt install pandoc
+
+# Windows
+choco install pandoc
+```
+
+## クイックスタート
+
+```bash
+# ライブプレビューを開始
+vimd dev README.md
+
+# 静的HTMLを生成
+vimd build README.md
+
+# テーマを変更
+vimd theme
+
+# 設定を編集
+vimd config
+```
+
+## コマンド
+
+### `vimd dev <file>`
+
+ホットリロード対応のライブプレビューサーバーを起動します。ブラウザを自動で開き、ファイルの変更を監視します。
+
+```bash
+vimd dev README.md
+vimd dev docs/guide.md --port 3000
+vimd dev spec.md --theme dark --no-open
+```
+
+**オプション:**
+
+- `-p, --port <port>`: ポート番号 (デフォルト: 8080)
+- `-t, --theme <theme>`: テーマ名 (グローバル設定を上書き)
+- `--no-open`: ブラウザを自動で開かない
+
+### `vimd build <file>`
+
+静的HTMLファイルを生成します。スタイルが埋め込まれたスタンドアロンHTMLを出力します。
+
+```bash
+vimd build README.md
+vimd build docs/guide.md -o dist/guide.html
+vimd build spec.md --theme academic
+```
+
+**オプション:**
+
+- `-o, --output <path>`: 出力ファイルパス (デフォルト: 同名で拡張子.html)
+- `-t, --theme <theme>`: テーマ名 (グローバル設定を上書き)
+
+### `vimd theme`
+
+対話的にテーマを変更します。5つの組み込みテーマから選択できます。
+
+```bash
+vimd theme
+```
+
+### `vimd config`
+
+対話的に設定を編集します。テーマ、ポート、その他の設定を変更できます。
+
+```bash
+# 対話的な設定エディタ
+vimd config
+
+# 現在の設定を表示
+vimd config --list
+```
+
+## テーマ
+
+vimdには5つの組み込みテーマがあります:
+
+| テーマ        | 説明                              | 用途                 |
+| ------------- | --------------------------------- | -------------------- |
+| **GitHub**    | GitHub Markdownスタイル (推奨)    | 一般的なドキュメント |
+| **Minimal**   | シンプルな白背景                  | 集中して書きたいとき |
+| **Dark**      | VS Codeインスパイアのダークモード | 夜間の作業           |
+| **Academic**  | 論文スタイルのレイアウト          | 学術論文、研究文書   |
+| **Technical** | APIドキュメントスタイル           | 技術仕様書、API文書  |
+
+## 設定
+
+グローバル設定は `~/.vimd/config.js` に保存されます。
+
+```javascript
+export default {
+  theme: 'github',
+  port: 8080,
+  host: 'localhost',
+  open: true,
+  pandoc: {
+    standalone: true,
+    toc: false,
+    highlightStyle: 'github',
+  },
+  watch: {
+    ignored: ['node_modules', '.git'],
+  },
+};
+```
+
+### 設定オプション
+
+- `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('README.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/            # ビルド済みファイル
+```
+
+## トラブルシューティング
+
+### pandocが見つからない
+
+「pandoc not found」エラーが出る場合:
+
+1. パッケージマネージャーでpandocをインストール
+2. インストールを確認: `pandoc --version`
+3. ターミナルを再起動
+
+### ポートが使用中
+
+ポート8080が既に使用中の場合:
+
+```bash
+vimd dev README.md --port 3000
+```
+
+または `~/.vimd/config.js` でデフォルトポートを変更してください。
+
+### テーマが適用されない
+
+以下を確認してください:
+
+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

@@ -0,0 +1,7 @@
+interface BuildOptions {
+    output?: string;
+    theme?: string;
+}
+export declare function buildCommand(filePath: string, options: BuildOptions): Promise<void>;
+export {};
+//# sourceMappingURL=build.d.ts.map

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

@@ -0,0 +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"}

package/dist/cli/commands/build.js

@@ -0,0 +1,54 @@
+// src/cli/commands/build.ts
+import { ConfigLoader } from '../../config/loader.js';
+import { MarkdownConverter } from '../../core/converter.js';
+import { PandocDetector } from '../../core/pandoc-detector.js';
+import { Logger } from '../../utils/logger.js';
+import * as path from 'path';
+import fs from 'fs-extra';
+export async function buildCommand(filePath, options) {
+    try {
+        Logger.info('Building HTML...');
+        // 1. Load configuration
+        const config = await ConfigLoader.loadGlobal();
+        // Override with command line options
+        if (options.theme) {
+            config.theme = options.theme;
+        }
+        Logger.info(`Theme: ${config.theme}`);
+        // 2. Check pandoc installation
+        PandocDetector.ensureInstalled();
+        // 3. 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
+        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
+        const converter = new MarkdownConverter({
+            theme: config.theme,
+            pandocOptions: {
+                ...config.pandoc,
+                standalone: true, // build always uses standalone
+            },
+            customCSS: config.css,
+            template: config.template || undefined,
+        });
+        // 6. Execute conversion
+        Logger.info('Converting...');
+        const html = await converter.convertWithTemplate(absolutePath);
+        await converter.writeHTML(html, outputPath);
+        Logger.success(`Build complete: ${outputPath}`);
+    }
+    catch (error) {
+        Logger.error('Build failed');
+        if (error instanceof Error) {
+            Logger.error(error.message);
+        }
+        process.exit(1);
+    }
+}

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

@@ -0,0 +1,6 @@
+interface ConfigOptions {
+    list?: boolean;
+}
+export declare function configCommand(options: ConfigOptions): Promise<void>;
+export {};
+//# sourceMappingURL=config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/config.ts"],"names":[],"mappings":"AAQA,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAiBzE"}

package/dist/cli/commands/config.js

@@ -0,0 +1,117 @@
+// src/cli/commands/config.ts
+import inquirer from 'inquirer';
+import { ConfigLoader } from '../../config/loader.js';
+import { ThemeManager } from '../../themes/index.js';
+import { Logger } from '../../utils/logger.js';
+import { PathResolver } from '../../utils/path-resolver.js';
+export async function configCommand(options) {
+    try {
+        // --list オプション: 現在の設定を表示
+        if (options.list) {
+            await showCurrentConfig();
+            return;
+        }
+        // 対話的設定変更
+        await interactiveConfig();
+    }
+    catch (error) {
+        Logger.error('Failed to update configuration');
+        if (error instanceof Error) {
+            Logger.error(error.message);
+        }
+        process.exit(1);
+    }
+}
+async function showCurrentConfig() {
+    const config = await ConfigLoader.loadGlobal();
+    const configPath = PathResolver.getConfigPath();
+    console.log('\nCurrent configuration:');
+    console.log(`  Theme: ${config.theme}`);
+    console.log(`  Port: ${config.port}`);
+    console.log(`  Host: ${config.host}`);
+    console.log(`  Open Browser: ${config.open}`);
+    console.log(`  Config File: ${configPath}\n`);
+}
+async function interactiveConfig() {
+    const config = await ConfigLoader.loadGlobal();
+    // 変更したい項目を選択
+    const { item } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'item',
+            message: 'What would you like to change?',
+            choices: [
+                { name: 'Theme', value: 'theme' },
+                { name: 'Port number', value: 'port' },
+                { name: 'Auto-open browser', value: 'open' },
+                { name: 'Cancel', value: 'cancel' },
+            ],
+        },
+    ]);
+    if (item === 'cancel') {
+        Logger.info('Configuration unchanged');
+        return;
+    }
+    // 項目別の変更処理
+    switch (item) {
+        case 'theme':
+            await changeTheme(config);
+            break;
+        case 'port':
+            await changePort(config);
+            break;
+        case 'open':
+            await changeOpen(config);
+            break;
+    }
+    // 設定保存
+    await ConfigLoader.save(config);
+    Logger.success('Configuration updated');
+}
+async function changeTheme(config) {
+    const themes = ThemeManager.list();
+    const { theme } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'theme',
+            message: 'Select a theme:',
+            choices: themes.map((t) => ({
+                name: t.name === config.theme
+                    ? `${t.displayName} (current)`
+                    : t.displayName,
+                value: t.name,
+            })),
+            default: config.theme,
+        },
+    ]);
+    config.theme = theme;
+}
+async function changePort(config) {
+    const { port } = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'port',
+            message: 'Enter port number:',
+            default: config.port.toString(),
+            validate: (input) => {
+                const num = parseInt(input, 10);
+                if (isNaN(num) || num < 1 || num > 65535) {
+                    return 'Port must be between 1 and 65535';
+                }
+                return true;
+            },
+        },
+    ]);
+    config.port = parseInt(port, 10);
+}
+async function changeOpen(config) {
+    const { open } = await inquirer.prompt([
+        {
+            type: 'confirm',
+            name: 'open',
+            message: 'Auto-open browser in preview?',
+            default: config.open,
+        },
+    ]);
+    config.open = open;
+}

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

@@ -0,0 +1,8 @@
+interface DevOptions {
+    port?: string;
+    theme?: string;
+    open?: boolean;
+}
+export declare function devCommand(filePath: string, options: DevOptions): Promise<void>;
+export {};
+//# sourceMappingURL=dev.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/dev.ts"],"names":[],"mappings":"AAWA,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,CAoGf"}

package/dist/cli/commands/dev.js

@@ -0,0 +1,95 @@
+// src/cli/commands/dev.ts
+import { ConfigLoader } from '../../config/loader.js';
+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 { Logger } from '../../utils/logger.js';
+import { ProcessManager } from '../../utils/process-manager.js';
+import * as path from 'path';
+import fs from 'fs-extra';
+export async function devCommand(filePath, options) {
+    try {
+        Logger.info('Starting vimd dev...');
+        // 1. Load configuration
+        const config = await ConfigLoader.loadGlobal();
+        // Override with command line options
+        if (options.port) {
+            config.port = parseInt(options.port, 10);
+        }
+        if (options.theme) {
+            config.theme = options.theme;
+        }
+        if (options.open !== undefined) {
+            config.open = options.open;
+        }
+        Logger.info(`Theme: ${config.theme}`);
+        Logger.info(`Port: ${config.port}`);
+        // 2. Check pandoc installation
+        PandocDetector.ensureInstalled();
+        // 3. Check file exists
+        const absolutePath = path.resolve(filePath);
+        if (!(await fs.pathExists(absolutePath))) {
+            Logger.error(`File not found: ${filePath}`);
+            process.exit(1);
+        }
+        // 4. Prepare output directory
+        const outputDir = path.join(process.cwd(), '.vimd-tmp');
+        await fs.ensureDir(outputDir);
+        const htmlPath = path.join(outputDir, path.basename(filePath, path.extname(filePath)) + '.html');
+        // 5. Prepare converter
+        const converter = new MarkdownConverter({
+            theme: config.theme,
+            pandocOptions: config.pandoc,
+            customCSS: config.css,
+            template: config.template,
+        });
+        // 6. Initial conversion
+        Logger.info('Converting markdown...');
+        const html = await converter.convertWithTemplate(absolutePath);
+        await converter.writeHTML(html, htmlPath);
+        Logger.success('Conversion complete');
+        // 7. Start live server
+        const server = new LiveServer({
+            port: config.port,
+            host: config.host,
+            open: config.open,
+            root: outputDir,
+        });
+        await server.start(htmlPath);
+        Logger.info(`Watching: ${filePath}`);
+        Logger.info('Press Ctrl+C to stop');
+        // 8. Start file watching
+        const watcher = new FileWatcher(absolutePath, config.watch);
+        watcher.onChange(async (changedPath) => {
+            Logger.info('File changed, reconverting...');
+            try {
+                const newHtml = await converter.convertWithTemplate(changedPath);
+                await converter.writeHTML(newHtml, htmlPath);
+                Logger.success('Reconversion complete');
+            }
+            catch (error) {
+                Logger.error('Reconversion failed');
+                if (error instanceof Error) {
+                    Logger.error(error.message);
+                }
+            }
+        });
+        watcher.start();
+        // 9. Register cleanup
+        ProcessManager.onExit(async () => {
+            Logger.info('Shutting down...');
+            await watcher.stop();
+            await server.stop();
+            await fs.remove(outputDir);
+            Logger.info('Cleanup complete');
+        });
+    }
+    catch (error) {
+        Logger.error('Failed to start dev server');
+        if (error instanceof Error) {
+            Logger.error(error.message);
+        }
+        process.exit(1);
+    }
+}

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

@@ -0,0 +1,2 @@
+export declare function themeCommand(): Promise<void>;
+//# sourceMappingURL=theme.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/theme.ts"],"names":[],"mappings":"AAMA,wBAAsB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CA6ClD"}

package/dist/cli/commands/theme.js

@@ -0,0 +1,46 @@
+// src/cli/commands/theme.ts
+import inquirer from 'inquirer';
+import { ConfigLoader } from '../../config/loader.js';
+import { ThemeManager } from '../../themes/index.js';
+import { Logger } from '../../utils/logger.js';
+export async function themeCommand() {
+    try {
+        // 1. 現在の設定読み込み
+        const config = await ConfigLoader.loadGlobal();
+        const currentTheme = config.theme;
+        // 2. テーマ一覧取得
+        const themes = ThemeManager.list();
+        // 3. 対話的選択
+        const answers = await inquirer.prompt([
+            {
+                type: 'list',
+                name: 'theme',
+                message: 'Select a theme:',
+                choices: themes.map((t) => ({
+                    name: t.name === currentTheme
+                        ? `${t.displayName} (current)`
+                        : t.displayName,
+                    value: t.name,
+                })),
+                default: currentTheme,
+            },
+        ]);
+        // 変更がない場合
+        if (answers.theme === currentTheme) {
+            Logger.info('Theme unchanged');
+            return;
+        }
+        // 4. 設定更新
+        config.theme = answers.theme;
+        await ConfigLoader.save(config);
+        Logger.success(`Theme updated to '${answers.theme}'`);
+        Logger.info('All projects will use this theme.');
+    }
+    catch (error) {
+        Logger.error('Failed to change theme');
+        if (error instanceof Error) {
+            Logger.error(error.message);
+        }
+        process.exit(1);
+    }
+}

package/dist/cli/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}