@skspwork/config-doc 0.2.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skspwork/config-doc",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Interactive documentation tool for JSON configuration files (appsettings.json)",
   "keywords": [
     "config",
@@ -31,7 +31,7 @@
     "packages/cli/bin",
     "packages/cli/package.json",
     "packages/web/app",
-    "packages/web/components", 
+    "packages/web/components",
     "packages/web/lib",
     "packages/web/types",
     "packages/web/public",

package/packages/web/app/api/config/metadata/route.ts

@@ -1,6 +1,7 @@
 import { NextRequest, NextResponse } from 'next/server';
 import path from 'path';
 import { FileSystemService } from '@/lib/fileSystem';
+import { StorageService } from '@/lib/storage';
 import { ProjectConfigFiles } from '@/types';
 import { getRootPath } from '@/lib/getRootPath';
 
@@ -8,8 +9,32 @@ export async function GET() {
   try {
     const rootPath = getRootPath();
     const fsService = new FileSystemService(rootPath);
+    const storageService = new StorageService(fsService);
 
-    const metadata = await fsService.loadConfigFiles();
+    // project_settings.jsonを読み込み
+    const settings = await fsService.loadProjectSettings();
+
+    if (!settings) {
+      return NextResponse.json({
+        success: true,
+        data: null
+      });
+    }
+
+    // UI用にConfigFileInfo形式に変換（互換性のため）
+    const configFiles = settings.configFiles.map((filePath, index) => ({
+      id: `config-${index + 1}`,
+      fileName: filePath.split(/[/\\]/).pop() || 'config.json',
+      filePath,
+      docsFileName: storageService.getDocsFileName(filePath)
+    }));
+
+    const metadata: ProjectConfigFiles = {
+      projectName: settings.projectName,
+      createdAt: '',  // 不要になったが互換性のため
+      lastModified: new Date().toISOString(),
+      configFiles
+    };
 
     return NextResponse.json({
       success: true,
@@ -41,50 +66,46 @@ export async function POST(request: NextRequest) {
 
     const rootPath = getRootPath();
     const fsService = new FileSystemService(rootPath);
+    const storageService = new StorageService(fsService);
 
-    // メタデータを作成または更新
-    const existingMetadata = await fsService.loadConfigFiles();
+    // 既存の設定を読み込み
+    const existingSettings = await fsService.loadProjectSettings();
 
-    // 削除された設定ファイルの docs.json を削除
+    // 削除されたファイルのdocsを削除
     const deletedDocsFileNames: string[] = [];
-    if (existingMetadata && existingMetadata.configFiles) {
-      const newFilePaths = new Set(configFilePaths);
-      for (const oldConfig of existingMetadata.configFiles) {
-        if (!newFilePaths.has(oldConfig.filePath)) {
-          // この設定ファイルは削除された
-          deletedDocsFileNames.push(oldConfig.docsFileName);
-          await fsService.deleteConfigDocs(oldConfig.docsFileName);
+    if (existingSettings && existingSettings.configFiles) {
+      const newPaths = new Set(
+        configFilePaths.map((p: string) =>
+          path.isAbsolute(p) ? path.relative(rootPath, p) : p
+        )
+      );
+
+      for (const oldPath of existingSettings.configFiles) {
+        if (!newPaths.has(oldPath)) {
+          const docsFileName = storageService.getDocsFileName(oldPath);
+          deletedDocsFileNames.push(docsFileName);
+          await fsService.deleteConfigDocs(docsFileName);
         }
       }
     }
 
-    const metadata: ProjectConfigFiles = {
-      projectName: existingMetadata?.projectName || path.basename(rootPath),
-      createdAt: existingMetadata?.createdAt || new Date().toISOString(),
-      lastModified: new Date().toISOString(),
-      configFiles: configFilePaths.map((filePath, index) => {
-        const fileName = filePath.split(/[/\\]/).pop() || 'config.json';
-        const docsFileName = fileName.replace('.json', '.docs.json');
-
-        // 絶対パスの場合は相対パスに変換
-        const relativePath = path.isAbsolute(filePath)
-          ? path.relative(rootPath, filePath)
-          : filePath;
-
-        return {
-          id: `config-${index + 1}`,
-          fileName,
-          filePath: relativePath,
-          docsFileName
-        };
-      })
+    // 絶対パスを相対パスに変換
+    const relativePaths = configFilePaths.map((p: string) =>
+      path.isAbsolute(p) ? path.relative(rootPath, p) : p
+    );
+
+    // 新しい設定を保存
+    const newSettings = {
+      projectName: existingSettings?.projectName || path.basename(rootPath),
+      configFiles: relativePaths,
+      export: existingSettings?.export || {}
     };
 
-    await fsService.saveConfigFiles(metadata);
+    await fsService.saveProjectSettings(newSettings);
 
     return NextResponse.json({
       success: true,
-      message: 'メタデータを保存しました',
+      message: 'プロジェクト設定を保存しました',
       deletedDocsFiles: deletedDocsFileNames
     });
   } catch (error) {

package/packages/web/app/api/export/settings/route.ts

@@ -3,17 +3,17 @@ import { getRootPath } from '@/lib/getRootPath';
 import path from 'path';
 import fs from 'fs/promises';
 import { ExportSettings, UserSettings, ProjectSettings } from '@/types';
+import { FileSystemService } from '@/lib/fileSystem';
 
-const USER_SETTINGS_FILE = '.user.local.json';
-const PROJECT_SETTINGS_FILE = 'settings.json';
+const USER_SETTINGS_FILE = '.user_settings.json';
 const CONFIG_DOC_DIR = '.config_doc';
 
 // GET: エクスポート設定を読み込み
 export async function GET() {
   try {
     const rootPath = getRootPath();
+    const fsService = new FileSystemService(rootPath);
     const userSettingsPath = path.join(rootPath, CONFIG_DOC_DIR, USER_SETTINGS_FILE);
-    const projectSettingsPath = path.join(rootPath, CONFIG_DOC_DIR, PROJECT_SETTINGS_FILE);
 
     // ユーザ設定を読み込み
     let userSettings: UserSettings;
@@ -28,22 +28,14 @@ export async function GET() {
       };
     }
 
-    // プロジェクト設定を読み込み
-    let projectSettings: ProjectSettings;
-    try {
-      const content = await fs.readFile(projectSettingsPath, 'utf-8');
-      projectSettings = JSON.parse(content);
-    } catch {
-      // デフォルトのプロジェクト設定
-      projectSettings = {
-        fileName: 'config-doc'
-      };
-    }
+    // プロジェクト設定から export.fileName を取得
+    const projectSettings = await fsService.loadProjectSettings();
+    const fileName = projectSettings?.export?.fileName || 'config-doc';
 
     // 統合された設定を返す
     const settings: ExportSettings = {
       ...userSettings,
-      ...projectSettings
+      fileName
     };
 
     return NextResponse.json({
@@ -76,6 +68,7 @@ export async function POST(request: NextRequest) {
     }
 
     const rootPath = getRootPath();
+    const fsService = new FileSystemService(rootPath);
     const configDocDir = path.join(rootPath, CONFIG_DOC_DIR);
 
     // .config_doc ディレクトリを確保
@@ -94,17 +87,28 @@ export async function POST(request: NextRequest) {
       'utf-8'
     );
 
-    // プロジェクト設定を保存（fileName）
+    // プロジェクト設定の export.fileName を更新
     if (settings.fileName !== undefined) {
-      const projectSettings: ProjectSettings = {
-        fileName: settings.fileName
-      };
-      const projectSettingsPath = path.join(configDocDir, PROJECT_SETTINGS_FILE);
-      await fs.writeFile(
-        projectSettingsPath,
-        JSON.stringify(projectSettings, null, 2),
-        'utf-8'
-      );
+      const existingProjectSettings = await fsService.loadProjectSettings();
+
+      if (existingProjectSettings) {
+        // 既存の設定を更新
+        existingProjectSettings.export = {
+          ...existingProjectSettings.export,
+          fileName: settings.fileName
+        };
+        await fsService.saveProjectSettings(existingProjectSettings);
+      } else {
+        // 新規作成
+        const newProjectSettings: ProjectSettings = {
+          projectName: path.basename(rootPath),
+          configFiles: [],
+          export: {
+            fileName: settings.fileName
+          }
+        };
+        await fsService.saveProjectSettings(newProjectSettings);
+      }
     }
 
     return NextResponse.json({

package/packages/web/lib/fileSystem.ts

@@ -1,6 +1,6 @@
 import fs from 'fs/promises';
 import path from 'path';
-import { ProjectConfigFiles, ConfigDocs, FileSystemItem } from '@/types';
+import { ProjectConfigFiles, ConfigDocs, FileSystemItem, ProjectSettings } from '@/types';
 
 export class FileSystemService {
   private configDocDir = '.config_doc';
@@ -25,6 +25,37 @@ export class FileSystemService {
     await fs.mkdir(docsDir, { recursive: true });
   }
 
+  // 新しいプロジェクト設定の読み込み
+  async loadProjectSettings(): Promise<ProjectSettings | null> {
+    const settingsPath = path.join(
+      this.rootPath,
+      this.configDocDir,
+      'project_settings.json'
+    );
+    try {
+      const content = await fs.readFile(settingsPath, 'utf-8');
+      return JSON.parse(content);
+    } catch {
+      return null;
+    }
+  }
+
+  // 新しいプロジェクト設定の保存
+  async saveProjectSettings(settings: ProjectSettings): Promise<void> {
+    await this.ensureConfigDocDir();
+    const settingsPath = path.join(
+      this.rootPath,
+      this.configDocDir,
+      'project_settings.json'
+    );
+    await fs.writeFile(
+      settingsPath,
+      JSON.stringify(settings, null, 2),
+      'utf-8'
+    );
+  }
+
+  // 旧形式のconfig_files.jsonの読み込み（マイグレーション用）
   async loadConfigFiles(): Promise<ProjectConfigFiles | null> {
     const configFilesPath = path.join(
       this.rootPath,

package/packages/web/lib/htmlGenerator.ts

@@ -1,4 +1,5 @@
 import { FileSystemService } from './fileSystem';
+import { StorageService } from './storage';
 import { ProjectConfigFiles, ConfigDocs } from '@/types';
 
 interface ConfigWithDocs {
@@ -10,40 +11,53 @@ interface ConfigWithDocs {
 
 export class HtmlGenerator {
   private fsService: FileSystemService;
+  private storageService: StorageService;
 
   constructor(rootPath: string) {
     this.fsService = new FileSystemService(rootPath);
+    this.storageService = new StorageService(this.fsService);
   }
 
   async generateHtml(): Promise<string> {
-    // メタデータを読み込む
-    const metadata = await this.fsService.loadConfigFiles();
-    if (!metadata || !metadata.configFiles || metadata.configFiles.length === 0) {
+    // プロジェクト設定を読み込む
+    const settings = await this.fsService.loadProjectSettings();
+    if (!settings || !settings.configFiles || settings.configFiles.length === 0) {
       return this.generateEmptyHtml();
     }
 
     // 各設定ファイルとそのドキュメントを読み込む
     const configs: ConfigWithDocs[] = [];
-    for (const configFile of metadata.configFiles) {
+    for (const filePath of settings.configFiles) {
       try {
-        const configData = await this.fsService.loadConfigFile(configFile.filePath);
-        const docs = await this.fsService.loadConfigDocs(configFile.docsFileName);
+        const fileName = filePath.split(/[/\\]/).pop() || 'config.json';
+        const docsFileName = this.storageService.getDocsFileName(filePath);
+
+        const configData = await this.fsService.loadConfigFile(filePath);
+        const docs = await this.fsService.loadConfigDocs(docsFileName);
 
         configs.push({
-          filePath: configFile.filePath,
-          fileName: configFile.fileName,
+          filePath,
+          fileName,
           configData,
           docs: docs || {
-            configFilePath: configFile.filePath,
+            configFilePath: filePath,
             lastModified: new Date().toISOString(),
             properties: {}
           }
         });
       } catch (error) {
-        console.error(`Failed to load config: ${configFile.filePath}`, error);
+        console.error(`Failed to load config: ${filePath}`, error);
       }
     }
 
+    // 互換性のため ProjectConfigFiles 形式に変換
+    const metadata: ProjectConfigFiles = {
+      projectName: settings.projectName,
+      createdAt: '',
+      lastModified: new Date().toISOString(),
+      configFiles: []
+    };
+
     return this.generateFullHtml(metadata, configs);
   }
 

package/packages/web/lib/markdownGenerator.ts

@@ -13,23 +13,24 @@ export class MarkdownGenerator {
     const fsService = new FileSystemService(this.rootPath);
     const storageService = new StorageService(fsService);
 
-    // メタデータを読み込む
-    const configFiles = await fsService.loadConfigFiles();
-    if (!configFiles || configFiles.configFiles.length === 0) {
+    // プロジェクト設定を読み込む
+    const settings = await fsService.loadProjectSettings();
+    if (!settings || settings.configFiles.length === 0) {
       return '# 設定ファイルドキュメント\n\nドキュメント化された設定ファイルがありません。\n';
     }
 
     let markdown = '# 設定ファイルドキュメント\n\n';
-    markdown += `プロジェクト: **${configFiles.projectName}**\n\n`;
-    markdown += `最終更新: ${new Date(configFiles.lastModified).toLocaleString('ja-JP')}\n\n`;
+    markdown += `プロジェクト: **${settings.projectName}**\n\n`;
+    markdown += `最終更新: ${new Date().toLocaleString('ja-JP')}\n\n`;
     markdown += '---\n\n';
 
     // 各設定ファイルのドキュメントを生成
-    for (const configFile of configFiles.configFiles) {
-      const docs = await storageService.loadAllDocs(configFile.filePath);
+    for (const filePath of settings.configFiles) {
+      const fileName = filePath.split(/[/\\]/).pop() || 'config.json';
+      const docs = await storageService.loadAllDocs(filePath);
 
-      markdown += `## ${configFile.fileName}\n\n`;
-      markdown += `**ファイルパス:** \`${configFile.filePath}\`\n\n`;
+      markdown += `## ${fileName}\n\n`;
+      markdown += `**ファイルパス:** \`${filePath}\`\n\n`;
 
       const propertyEntries = Object.entries(docs.properties);
       if (propertyEntries.length === 0) {

package/packages/web/lib/markdownTableGenerator.ts

@@ -13,24 +13,25 @@ export class MarkdownTableGenerator {
     const fsService = new FileSystemService(this.rootPath);
     const storageService = new StorageService(fsService);
 
-    // メタデータを読み込む
-    const configFiles = await fsService.loadConfigFiles();
-    if (!configFiles || configFiles.configFiles.length === 0) {
+    // プロジェクト設定を読み込む
+    const settings = await fsService.loadProjectSettings();
+    if (!settings || settings.configFiles.length === 0) {
       return '# 設定ファイルドキュメント\n\nドキュメント化された設定ファイルがありません。\n';
     }
 
     let markdown = '# 設定ファイルドキュメント\n\n';
-    markdown += `プロジェクト: **${configFiles.projectName}**\n\n`;
-    markdown += `最終更新: ${new Date(configFiles.lastModified).toLocaleString('ja-JP')}\n\n`;
+    markdown += `プロジェクト: **${settings.projectName}**\n\n`;
+    markdown += `最終更新: ${new Date().toLocaleString('ja-JP')}\n\n`;
     markdown += '---\n\n';
 
     // 各設定ファイルのドキュメントを生成
-    for (const configFile of configFiles.configFiles) {
-      const docs = await storageService.loadAllDocs(configFile.filePath);
-      const configData = await fsService.loadConfigFile(configFile.filePath);
+    for (const filePath of settings.configFiles) {
+      const fileName = filePath.split(/[/\\]/).pop() || 'config.json';
+      const docs = await storageService.loadAllDocs(filePath);
+      const configData = await fsService.loadConfigFile(filePath);
 
-      markdown += `## ${configFile.fileName}\n\n`;
-      markdown += `**ファイルパス:** \`${configFile.filePath}\`\n\n`;
+      markdown += `## ${fileName}\n\n`;
+      markdown += `**ファイルパス:** \`${filePath}\`\n\n`;
 
       const propertyEntries = Object.entries(docs.properties);
       if (propertyEntries.length === 0) {

package/packages/web/lib/storage.ts

@@ -1,5 +1,6 @@
 import { FileSystemService } from './fileSystem';
 import { ConfigDocs, PropertyDoc } from '@/types';
+import path from 'path';
 
 export class StorageService {
   constructor(private fs: FileSystemService) {}
@@ -11,10 +12,13 @@ export class StorageService {
   ): Promise<void> {
     const docsFileName = this.getDocsFileName(configFilePath);
 
+    // 絶対パスを相対パスに変換
+    const relativeConfigPath = this.toRelativePath(configFilePath);
+
     let docs = await this.fs.loadConfigDocs(docsFileName);
     if (!docs) {
       docs = {
-        configFilePath,
+        configFilePath: relativeConfigPath,
         lastModified: new Date().toISOString(),
         properties: {}
       };
@@ -22,6 +26,7 @@ export class StorageService {
 
     docs.properties[propertyPath] = propertyDoc;
     docs.lastModified = new Date().toISOString();
+    docs.configFilePath = relativeConfigPath; // 常に相対パスを保存
 
     await this.fs.saveConfigDocs(docsFileName, docs);
   }
@@ -30,28 +35,45 @@ export class StorageService {
     const docsFileName = this.getDocsFileName(configFilePath);
     const docs = await this.fs.loadConfigDocs(docsFileName);
 
+    // 絶対パスを相対パスに変換
+    const relativeConfigPath = this.toRelativePath(configFilePath);
+
     return docs || {
-      configFilePath,
+      configFilePath: relativeConfigPath,
       lastModified: new Date().toISOString(),
       properties: {}
     };
   }
 
-  private getDocsFileName(configFilePath: string): string {
-    // 絶対パスの場合は、パス全体からハッシュを生成して一意にする
-    const isAbsolute = /^[a-zA-Z]:[/\\]/.test(configFilePath) || configFilePath.startsWith('/');
-
-    if (isAbsolute) {
-      // 絶対パスの場合：パスを正規化してBase64エンコード（ファイル名として安全な形式）
-      const normalized = configFilePath.replace(/[/\\]/g, '_').replace(/:/g, '');
-      const fileName = configFilePath.split(/[/\\]/).pop() || 'config.json';
-      const baseName = fileName.replace('.json', '');
-      // ファイル名の前にパスのハッシュを追加して一意性を確保
-      return `${normalized.substring(0, 50)}_${baseName}.docs.json`;
-    } else {
-      // 相対パスの場合：従来通り
-      const fileName = configFilePath.split(/[/\\]/).pop() || 'config.json';
+  // 公開メソッド: docsファイル名を取得
+  public getDocsFileName(configFilePath: string): string {
+    // 相対パスに変換してから処理
+    const relativePath = this.toRelativePath(configFilePath);
+
+    // パスの深さが1以下（ルート直下のファイル）の場合は、シンプルなファイル名
+    const pathParts = relativePath.split(/[/\\]/).filter(p => p && p !== '.');
+
+    if (pathParts.length <= 1) {
+      // ルート直下のファイル: components.json → components.docs.json
+      const fileName = pathParts[0] || 'config.json';
       return fileName.replace('.json', '.docs.json');
+    } else {
+      // サブディレクトリのファイル: 相対パスを含めて一意にする
+      // 例: ../SimMoney/components.json → __SimMoney_components.docs.json
+      // 例: sample/appsettings.json → sample_appsettings.docs.json
+      const normalized = relativePath
+        .replace(/\.\./g, '__')  // .. を __ に変換
+        .replace(/[/\\]/g, '_')  // / と \ を _ に変換
+        .replace(/:/g, '');       // : を削除
+      return normalized.replace('.json', '.docs.json');
+    }
+  }
+
+  private toRelativePath(filePath: string): string {
+    // 絶対パスの場合は相対パスに変換
+    if (path.isAbsolute(filePath)) {
+      return path.relative(this.fs['rootPath'], filePath);
     }
+    return filePath;
   }
 }

package/packages/web/types/index.ts

@@ -45,12 +45,16 @@ export interface FileSystemItem {
 
 export type ExportFormat = 'html' | 'markdown' | 'markdown-table';
 
-// チーム共有設定（settings.json）
+// プロジェクト設定（project_settings.json）- チーム共有
 export interface ProjectSettings {
-  fileName?: string;               // 出力ファイル名（拡張子なし、デフォルト: config-doc）
+  projectName: string;
+  configFiles: string[];           // 設定ファイルの相対パス配列
+  export?: {
+    fileName?: string;             // 出力ファイル名（拡張子なし、デフォルト: config-doc）
+  };
 }
 
-// ユーザ個別設定（.user.local.json）
+// ユーザ個別設定（.user_settings.json）
 export interface UserSettings {
   format: ExportFormat;            // 出力形式
   autoExport: boolean;             // 保存時に自動エクスポート
@@ -58,4 +62,6 @@ export interface UserSettings {
 }
 
 // 統合された設定（レスポンス用）
-export interface ExportSettings extends UserSettings, ProjectSettings {}
+export interface ExportSettings extends UserSettings {
+  fileName?: string;               // ProjectSettings.export.fileName から取得
+}