npm - @skspwork/config-doc - Versions diffs - 2.0.2 → 2.0.4 - Mend

@skspwork/config-doc 2.0.2 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

package/packages/web/.next/standalone/lib/htmlGenerator.ts CHANGED Viewed

@@ -2,6 +2,7 @@ import { FileSystemService } from './fileSystem';
 import { StorageService } from './storage';
 import { escapeHtml } from './utils';
 import { ProjectConfigFiles, ConfigDocs } from '@/types';
+import { sortTagsByOrder } from './configManagerUtils';
 interface ConfigWithDocs {
   filePath: string;
@@ -26,6 +27,12 @@ export class HtmlGenerator {
       return this.generateEmptyHtml();
     }
+    // フィールドの順序を取得
+    const fieldKeys = settings.fields ? Object.keys(settings.fields) : [];
+    // タグの順序を取得
+    const availableTags = settings.availableTags || [];
     // 各設定ファイルとそのドキュメントを読み込む
     const configs: ConfigWithDocs[] = [];
     for (const filePath of settings.configFiles) {
@@ -59,7 +66,7 @@ export class HtmlGenerator {
       configFiles: []
     };
-    return this.generateFullHtml(metadata, configs);
+    return this.generateFullHtml(metadata, configs, fieldKeys, availableTags);
   }
   private generateEmptyHtml(): string {
@@ -85,8 +92,10 @@ export class HtmlGenerator {
 </html>`;
   }
-  private generateFullHtml(metadata: ProjectConfigFiles, configs: ConfigWithDocs[]): string {
+  private generateFullHtml(metadata: ProjectConfigFiles, configs: ConfigWithDocs[], fieldKeys: string[], availableTags: string[]): string {
     const configsJson = JSON.stringify(configs, null, 2);
+    const fieldKeysJson = JSON.stringify(fieldKeys);
+    const availableTagsJson = JSON.stringify(availableTags);
     return `<!DOCTYPE html>
 <html lang="ja">
@@ -123,10 +132,25 @@ export class HtmlGenerator {
   <script>
     const configs = ${configsJson};
+    const fieldKeys = ${fieldKeysJson};
+    const availableTags = ${availableTagsJson};
     let activeConfigIndex = 0;
     let selectedPath = '';
     let currentSearchQuery = '';
+    // タグをavailableTagsの順序でソート
+    function sortTagsByOrder(tags) {
+      if (!tags || tags.length === 0) return [];
+      return [...tags].sort((a, b) => {
+        const indexA = availableTags.indexOf(a);
+        const indexB = availableTags.indexOf(b);
+        if (indexA !== -1 && indexB !== -1) return indexA - indexB;
+        if (indexA === -1) return 1;
+        if (indexB === -1) return -1;
+        return 0;
+      });
+    }
     ${this.getScripts()}
   </script>
 </body>
@@ -223,13 +247,15 @@ export class HtmlGenerator {
     }
     .config-tab {
-      padding: 10px 15px;
+      display: flex;
+      flex-direction: column;
+      gap: 2px;
+      padding: 10px 12px;
       background: #f9fafb;
       border: 1px solid #e5e7eb;
       border-radius: 4px;
       cursor: pointer;
       transition: all 0.2s;
-      font-size: 0.9rem;
     }
     .config-tab:hover {
@@ -242,10 +268,28 @@ export class HtmlGenerator {
       border-color: #2563eb;
     }
+    .config-tab.active .config-tab-path {
+      color: rgba(255, 255, 255, 0.8);
+    }
     .config-tab.hidden {
       display: none;
     }
+    .config-tab-filename {
+      font-weight: 500;
+      font-size: 0.9rem;
+    }
+    .config-tab-path {
+      font-size: 0.75rem;
+      color: #9ca3af;
+      overflow: hidden;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      max-width: 100%;
+    }
     .tree-container {
       padding: 10px;
       max-height: 600px;
@@ -363,6 +407,20 @@ export class HtmlGenerator {
       border-bottom: 2px solid #e5e7eb;
     }
+    .property-file {
+      font-size: 0.85rem;
+      color: #6b7280;
+      background: #f9fafb;
+      padding: 6px 10px;
+      border-radius: 4px;
+      margin-bottom: 12px;
+      font-family: 'Courier New', monospace;
+      overflow: hidden;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      cursor: help;
+    }
     .property-path {
       background: #f3f4f6;
       padding: 10px 15px;
@@ -585,23 +643,26 @@ export class HtmlGenerator {
       const doc = config.docs.properties && config.docs.properties[node.path];
       let html = \`<h2>\${escapeHtml(node.key)}</h2>\`;
+      html += \`<div class="property-file" title="\${escapeHtml(config.filePath)}">ファイル: \${escapeHtml(config.filePath)}</div>\`;
       html += \`<div class="property-path">パス: \${escapeHtml(node.path)}</div>\`;
       html += \`<div class="property-value">値: \${escapeHtml(JSON.stringify(node.value, null, 2))}</div>\`;
       if (doc) {
         if (doc.tags && doc.tags.length > 0) {
+          const sortedTags = sortTagsByOrder(doc.tags);
           html += \`<div class="doc-section">
             <h3>タグ</h3>
             <div class="tag-list">\`;
-          doc.tags.forEach(tag => {
+          sortedTags.forEach(tag => {
             html += \`<span class="tag">\${escapeHtml(tag)}</span>\`;
           });
           html += \`</div>
           </div>\`;
         }
-        // フィールドを表示
-        Object.entries(doc.fields).forEach(([label, value]) => {
+        // フィールドをprojectFieldsの順序で表示
+        fieldKeys.forEach(label => {
+          const value = doc.fields[label];
           if (value) {
             html += \`<div class="doc-section">
               <h3>\${escapeHtml(label)}</h3>
@@ -645,7 +706,10 @@ export class HtmlGenerator {
         }
         tab.className = className;
-        tab.textContent = config.fileName;
+        tab.innerHTML = \`
+          <div class="config-tab-filename">\${escapeHtml(config.fileName)}</div>
+          <div class="config-tab-path" title="\${escapeHtml(config.filePath)}">\${escapeHtml(config.filePath)}</div>
+        \`;
         tab.addEventListener('click', () => {
           activeConfigIndex = index;
           renderConfigTabs(matchedConfigIndexes);
@@ -657,6 +721,7 @@ export class HtmlGenerator {
         });
         tabsEl.appendChild(tab);
       });
     }
     // 現在の設定を描画

package/packages/web/.next/standalone/lib/markdownGenerator.ts CHANGED Viewed

@@ -1,6 +1,8 @@
 import { FileSystemService } from './fileSystem';
 import { StorageService } from './storage';
-import path from 'path';
+import { ConfigParser } from './configParser';
+import { sortTagsByOrder } from './configManagerUtils';
+import { getPropertyByPath } from './utils';
 export class MarkdownGenerator {
   private rootPath: string;
@@ -19,6 +21,12 @@ export class MarkdownGenerator {
       return '# 設定ファイルドキュメント\n\nドキュメント化された設定ファイルがありません。\n';
     }
+    // フィールドの順序を取得
+    const fieldKeys = settings.fields ? Object.keys(settings.fields) : [];
+    // タグの順序を取得
+    const availableTags = settings.availableTags || [];
     let markdown = '# 設定ファイルドキュメント\n\n';
     markdown += `プロジェクト: **${settings.projectName}**\n\n`;
     markdown += `最終更新: ${new Date().toLocaleString('ja-JP')}\n\n`;
@@ -28,37 +36,74 @@ export class MarkdownGenerator {
     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 += `## ${fileName}\n\n`;
       markdown += `**ファイルパス:** \`${filePath}\`\n\n`;
-      const propertyEntries = Object.entries(docs.properties);
-      if (propertyEntries.length === 0) {
-        markdown += '*ドキュメントが登録されていません。*\n\n';
+      // 設定ファイルから全プロパティを取得（オブジェクト型も含む）
+      // ツリー構造の順序を保持するためソートしない
+      const allPropertyPaths = ConfigParser.getAllPropertyPaths(configData);
+      if (allPropertyPaths.length === 0) {
+        markdown += '*プロパティがありません。*\n\n';
         continue;
       }
       markdown += '### プロパティ一覧\n\n';
-      for (const [propertyPath, doc] of propertyEntries) {
+      for (const propertyPath of allPropertyPaths) {
+        const doc = docs.properties[propertyPath];
+        const value = getPropertyByPath(configData, propertyPath);
         markdown += `#### \`${propertyPath}\`\n\n`;
-        if (doc.tags && doc.tags.length > 0) {
-          markdown += `**タグ:** ${doc.tags.map(tag => `\`${tag}\``).join(', ')}\n\n`;
+        // 値を表示（プリミティブ値とプリミティブ配列）
+        if (value !== undefined && value !== null) {
+          const valueType = typeof value;
+          const isArray = Array.isArray(value);
+          const isObject = valueType === 'object' && !isArray;
+          if (isArray) {
+            // 配列の場合：要素がプリミティブならば表示
+            const hasPrimitiveElements = value.length > 0 && value.every((item: any) =>
+              typeof item !== 'object' || item === null
+            );
+            if (hasPrimitiveElements) {
+              markdown += `**値:** \`${JSON.stringify(value)}\`\n\n`;
+            }
+          } else if (!isObject) {
+            // プリミティブ値を表示
+            markdown += `**値:** \`${String(value)}\`\n\n`;
+          }
         }
-        // フィールドを表示
-        Object.entries(doc.fields).forEach(([label, value]) => {
-          if (value) {
-            markdown += `**${label}:**\n\n${value}\n\n`;
+        // ドキュメントがある場合
+        if (doc) {
+          if (doc.tags && doc.tags.length > 0) {
+            const sortedTags = sortTagsByOrder(doc.tags, availableTags);
+            markdown += `**タグ:** ${sortedTags.map(tag => `\`${tag}\``).join(', ')}\n\n`;
+          }
+          // フィールドをprojectFieldsの順序で表示
+          if (doc.fields) {
+            for (const fieldKey of fieldKeys) {
+              const fieldValue = doc.fields[fieldKey];
+              if (fieldValue) {
+                markdown += `**${fieldKey}:**\n\n${fieldValue}\n\n`;
+              }
+            }
           }
-        });
+        } else {
+          // ドキュメントがない場合
+          markdown += '*ドキュメントなし*\n\n';
+        }
         markdown += '---\n\n';
       }
     }
-    markdown += `\n*このドキュメントは [ConfigDoc](https://github.com/your-repo/configdoc) により自動生成されました。*\n`;
+    markdown += `\n*このドキュメントは ConfigDoc により自動生成されました。*\n`;
     return markdown;
   }

package/packages/web/.next/standalone/lib/markdownTableGenerator.ts CHANGED Viewed

@@ -1,6 +1,8 @@
 import { FileSystemService } from './fileSystem';
 import { StorageService } from './storage';
 import { escapeTableCell, getPropertyByPath, formatValue } from './utils';
+import { ConfigParser } from './configParser';
+import { sortTagsByOrder } from './configManagerUtils';
 export class MarkdownTableGenerator {
   private rootPath: string;
@@ -19,6 +21,12 @@ export class MarkdownTableGenerator {
       return '# 設定ファイルドキュメント\n\nドキュメント化された設定ファイルがありません。\n';
     }
+    // フィールドの順序を取得（すべてのフィールドをテーブルの列として使用）
+    const fieldKeys = settings.fields ? Object.keys(settings.fields) : [];
+    // タグの順序を取得
+    const availableTags = settings.availableTags || [];
     let markdown = '# 設定ファイルドキュメント\n\n';
     markdown += `プロジェクト: **${settings.projectName}**\n\n`;
     markdown += `最終更新: ${new Date().toLocaleString('ja-JP')}\n\n`;
@@ -33,52 +41,47 @@ export class MarkdownTableGenerator {
       markdown += `## ${fileName}\n\n`;
       markdown += `**ファイルパス:** \`${filePath}\`\n\n`;
-      const propertyEntries = Object.entries(docs.properties);
-      if (propertyEntries.length === 0) {
-        markdown += '*ドキュメントが登録されていません。*\n\n';
+      // 設定ファイルから全プロパティを取得（オブジェクト型も含む）
+      // ツリー構造の順序を保持するためソートしない
+      const allPropertyPaths = ConfigParser.getAllPropertyPaths(configData);
+      if (allPropertyPaths.length === 0) {
+        markdown += '*プロパティがありません。*\n\n';
         continue;
       }
-      // すべてのフィールドラベルを収集（説明以外）
-      const fieldLabels = new Set<string>();
-      propertyEntries.forEach(([_, doc]) => {
-        Object.keys(doc.fields).forEach(label => {
-          if (label !== '説明') {
-            fieldLabels.add(label);
-          }
-        });
-      });
-      const sortedLabels = Array.from(fieldLabels).sort();
-      // テーブルヘッダー
-      markdown += '| プロパティ名 | タグ | 説明 | 値 |';
-      sortedLabels.forEach(label => {
+      // テーブルヘッダー（projectFieldsの順序で表示）
+      markdown += '| プロパティ名 | タグ | 値 |';
+      fieldKeys.forEach(label => {
         markdown += ` ${label} |`;
       });
       markdown += '\n';
-      markdown += '|-------------|------|------|-----|';
-      sortedLabels.forEach(() => {
+      markdown += '|-------------|------|-----|';
+      fieldKeys.forEach(() => {
         markdown += '------|';
       });
       markdown += '\n';
       // 各プロパティの行を追加
-      for (const [propertyPath, doc] of propertyEntries) {
+      for (const propertyPath of allPropertyPaths) {
+        const doc = docs.properties[propertyPath];
         const propertyName = escapeTableCell(propertyPath);
-        const tags = doc.tags && doc.tags.length > 0
-          ? escapeTableCell(doc.tags.map(tag => `\`${tag}\``).join(', '))
+        const sortedTags = doc && doc.tags && doc.tags.length > 0
+          ? sortTagsByOrder(doc.tags, availableTags)
+          : [];
+        const tags = sortedTags.length > 0
+          ? escapeTableCell(sortedTags.map(tag => `\`${tag}\``).join(', '))
           : '-';
-        const description = escapeTableCell(doc.fields['説明'] || '-');
         const value = this.getPropertyValue(configData, propertyPath);
         const valueStr = escapeTableCell(value);
-        markdown += `| ${propertyName} | ${tags} | ${description} | ${valueStr} |`;
+        markdown += `| ${propertyName} | ${tags} | ${valueStr} |`;
-        // フィールドの値を追加（説明以外）
-        sortedLabels.forEach(label => {
-          const fieldValue = doc.fields[label] || '-';
+        // フィールドの値をprojectFieldsの順序で追加
+        fieldKeys.forEach(label => {
+          const fieldValue = (doc && doc.fields && doc.fields[label]) || '-';
           markdown += ` ${escapeTableCell(fieldValue)} |`;
         });
@@ -88,7 +91,7 @@ export class MarkdownTableGenerator {
       markdown += '\n';
     }
-    markdown += `\n*このドキュメントは [ConfigDoc](https://github.com/your-repo/configdoc) により自動生成されました。*\n`;
+    markdown += `\n*このドキュメントは ConfigDoc により自動生成されました。*\n`;
     return markdown;
   }

package/packages/web/.next/standalone/lib/utils.ts CHANGED Viewed

@@ -58,15 +58,32 @@ export function getPropertyByPath(obj: unknown, propertyPath: string): unknown {
 /**
  * 値を表示用の文字列に変換
+ * プリミティブ値とプリミティブ配列のみ表示し、オブジェクトとオブジェクト配列は'-'を返す
  */
 export function formatValue(value: unknown): string {
   if (value === null || value === undefined) {
     return '-';
   }
-  if (typeof value === 'object') {
-    return JSON.stringify(value);
+  const valueType = typeof value;
+  const isArray = Array.isArray(value);
+  const isObject = valueType === 'object' && !isArray;
+  if (isArray) {
+    // 配列の場合：要素がプリミティブならば表示
+    const hasPrimitiveElements = value.length > 0 && value.every((item: any) =>
+      typeof item !== 'object' || item === null
+    );
+    if (hasPrimitiveElements) {
+      return JSON.stringify(value);
+    }
+    // オブジェクト配列の場合は表示しない
+    return '-';
+  } else if (isObject) {
+    // オブジェクトの場合は表示しない
+    return '-';
   }
+  // プリミティブ値を表示
   return String(value);
 }