@dxtmisha/scripts 0.10.15 → 0.11.0

package/src/classes/Design/DesignTypesPrompts.ts

@@ -0,0 +1,289 @@
+import { createHash } from 'node:crypto'
+import { forEach, isFilled } from '@dxtmisha/functional-basic'
+import { PropertiesFile } from '../Properties/PropertiesFile'
+import { DesignTypesAi } from './DesignTypesAi'
+
+import type {
+  DesignTypesItem,
+  DesignTypesList,
+  DesignTypesPromptCacheItem,
+  DesignTypesPromptCacheList,
+  DesignTypesPromptData,
+  DesignTypesPromptResult
+} from '../../types/designTypes'
+
+import { UI_MODULES } from '../../config'
+
+/**
+ * Class for reading prompt files and generating AI project rules and prompt triggers description.
+ *
+ * Класс для чтения файлов промптов и генерации описания правил проекта ИИ и триггеров промптов.
+ */
+export class DesignTypesPrompts {
+  /** Cached list of prompt files / Кэшированный список файлов с промптами */
+  protected listPrompts?: DesignTypesList
+
+  /** Cached prompt AI metadata list / Кэшированный список метаданных промптов ИИ */
+  protected cacheList?: DesignTypesPromptCacheList
+
+  /**
+   * Constructor for DesignTypesPrompts.
+   *
+   * Конструктор для DesignTypesPrompts.
+   * @param promptsDir input directory path containing prompt files / входной путь к директории, содержащей файлы промптов
+   * @param ai instance of DesignTypesAi for AI interactions / экземпляр DesignTypesAi для ИИ взаимодействия
+   */
+  constructor(
+    protected readonly promptsDir: string = 'ai-resources',
+    protected readonly ai: DesignTypesAi
+  ) { }
+
+  /**
+   * Reads and returns the prompt cache list from the JSON cache file.
+   *
+   * Читает и возвращает список кэша промптов из JSON файла кэша.
+   * @returns prompt cache list / список кэша промптов
+   */
+  getCacheList(): DesignTypesPromptCacheList {
+    if (this.cacheList === undefined) {
+      const cachePath = this.getCachePath()
+      const data = PropertiesFile.readFile<DesignTypesPromptCacheList>(cachePath)
+
+      this.cacheList = Array.isArray(data) ? data : []
+    }
+
+    return this.cacheList
+  }
+
+  /**
+   * Gets a list of prompt files.
+   *
+   * Получает список файлов с промптами.
+   * @returns list of prompt files / список файлов с промптами
+   */
+  getListPrompts(): DesignTypesList {
+    if (this.listPrompts === undefined) {
+      const files = PropertiesFile.readDirRecursive(this.promptsDir)
+
+      this.listPrompts = forEach(
+        files,
+        (file) => {
+          if (file.endsWith('.json')) {
+            return undefined
+          }
+
+          const path = `${this.promptsDir}/${file}`
+          const content = PropertiesFile.readFileOnly(path)
+
+          if (content) {
+            return {
+              path,
+              content,
+              md5: this.getMd5(content)
+            }
+          }
+        }
+      ) as DesignTypesList
+    }
+
+    return this.listPrompts
+  }
+
+  /**
+   * Initializes prompt rules by executing cache processing and returning formatted prompt rule strings.
+   *
+   * Инициализирует правила промптов, выполняя обработку кэша и возвращая список отформатированных строк правил промптов.
+   * @returns array of formatted prompt rule strings / массив отформатированных строк правил промптов
+   */
+  async init(): Promise<string[]> {
+    await this.make()
+
+    const list = this.getListPrompts()
+    const cache = this.getCacheList()
+    const prompts: string[] = []
+
+    for (const item of list) {
+      const cachedItem = cache.find(itemCache => itemCache.path === item.path)
+
+      if (cachedItem && isFilled(cachedItem.description)) {
+        prompts.push(this.getPromptLine(item.path, cachedItem.description))
+      }
+    }
+
+    return prompts
+  }
+
+  /**
+   * Processes prompt files using AI and updates the JSON cache file if changes are detected.
+   *
+   * Обрабатывает файлы промптов с помощью ИИ и обновляет JSON файл кэша при обнаружении изменений.
+   * @returns current instance / текущий экземпляр
+   */
+  async make(): Promise<this> {
+    const list = this.getListPrompts()
+    let isCacheChanged = false
+
+    for (const item of list) {
+      const result = await this.toAiPromptItem(item)
+
+      if (result.isChanged) {
+        isCacheChanged = true
+      }
+    }
+
+    if (isCacheChanged) {
+      this.saveCacheList(this.getCacheList())
+    }
+
+    return this
+  }
+
+  /**
+   * Generates project rules and prompt triggers description using AI.
+   *
+   * Генерирует описание правил проекта и триггеров промптов с помощью ИИ.
+   * @returns prompt rules description / описание правил промптов
+   */
+  async toAiPrompts(): Promise<string> {
+    const prompts = await this.init()
+
+    if (prompts.length > 0) {
+      return '## Mandatory Rules\n'
+        + 'You MUST evaluate whether your task relates to any of the following topics (even if not working directly with this package). If related material is present, you are strictly obligated to read and study the corresponding file before proceeding:\n'
+        + `${prompts.join('\n')}`
+    }
+
+    return ''
+  }
+
+  /**
+   * Gets the cache JSON file path for prompts.
+   *
+   * Получает путь к JSON файлу кэша для промптов.
+   * @returns cache JSON file path / путь к JSON файлу кэша
+   */
+  protected getCachePath(): string {
+    return `${this.promptsDir}/prompts.json`
+  }
+
+  /**
+   * Generates MD5 hash for the given content.
+   *
+   * Генерирует MD5 хэш для переданного содержимого.
+   * @param content file or text content / содержимое файла или текста
+   * @returns MD5 hash string / MD5 хэш строка
+   */
+  protected getMd5(content: string): string {
+    return createHash('md5').update(content.trim()).digest('hex')
+  }
+
+  /**
+   * Formats a prompt rule entry line for a file and description.
+   *
+   * Форматирует строку элемента правила промпта для файла и описания.
+   * @param path relative file path / относительный путь к файлу
+   * @param description rule description / описание правила
+   * @returns formatted prompt rule line / отформатированная строка правила промпта
+   */
+  protected getPromptLine(
+    path: string,
+    description: string
+  ): string {
+    return `- '${UI_MODULES}/${this.ai.getProjectName()}/${path}': ${description}`
+  }
+
+  /**
+   * Saves the prompt cache list to the JSON cache file.
+   *
+   * Сохраняет список кэша промптов в JSON файл кэша.
+   * @param cache cache list to save / список кэша для сохранения
+   */
+  protected saveCacheList(cache: DesignTypesPromptCacheList): void {
+    this.cacheList = cache
+    PropertiesFile.writeByPath(this.getCachePath(), cache)
+  }
+
+  /**
+   * Generates document metadata (title and description) for studying a prompt file using AI.
+   *
+   * Генерирует метаданные документа (название и описание) для изучения файла промпта с помощью ИИ.
+   * @param content prompt file content / содержимое файла промпта
+   * @returns object with document title and description or undefined / объект с названием и описанием документа или undefined
+   */
+  protected async toAiPromptData(content: string): Promise<DesignTypesPromptData | undefined> {
+    return this.ai.toAiJson<DesignTypesPromptData>(
+      content,
+      'Goal: Generate a document metadata object in valid JSON format for an AI coding assistant.\n\n'
+      + 'CRITICAL RESTRICTIONS:\n'
+      + '- The output MUST be a valid JSON object with keys: "name" and "description".\n'
+      + '- Field "name": Short and concise document title (maximum 4-5 words).\n'
+      + '- Field "description": Clear description for an AI agent explaining what exact standards, rules, or tools this file contains and what commercial or technical task it solves (maximum 3 sentences).\n'
+      + '- Do NOT include markdown code block wrappers (```json). Return ONLY the raw JSON string.\n\n'
+      + 'EXAMPLES OF GOOD OUTPUT:\n'
+      + '{\n'
+      + '  "name": "Coding Standards",\n'
+      + '  "description": "Строгие архитектурные конвенции и стандарты написания кода для продукта"\n'
+      + '}\n\n'
+      + 'OUTPUT REQUIREMENTS:\n'
+      + 'Return ONLY the JSON object. No explanations, no markdown formatting, no conversational text.'
+    )
+  }
+
+  /**
+   * Processes a single prompt file item using cache or AI into a formatted rule entry string and updates cache list if changed.
+   *
+   * Обрабатывает один элемент файла промпта с использованием кэша или ИИ в отформатированную строку правила и обновляет список кэша при изменениях.
+   * @param item prompt file item / элемент файла промпта
+   * @returns object with formatted rule string and changed flag / объект с отформатированной строкой правила и флагом изменений
+   */
+  protected async toAiPromptItem(
+    item: DesignTypesItem
+  ): Promise<DesignTypesPromptResult> {
+    const md5 = item.md5 ?? this.getMd5(item.content)
+    const cache = this.getCacheList()
+    const cacheIndex = cache.findIndex(itemCache => itemCache.path === item.path)
+    const cachedItem = cacheIndex >= 0 ? cache[cacheIndex] : undefined
+
+    if (
+      cachedItem
+      && cachedItem.md5 === md5
+      && isFilled(cachedItem.name)
+      && isFilled(cachedItem.description)
+    ) {
+      return {
+        prompt: this.getPromptLine(item.path, cachedItem.description),
+        isChanged: false
+      }
+    }
+
+    console.log(`-- processing prompt metadata for ${item.path}...`)
+
+    const data = await this.toAiPromptData(item.content)
+
+    if (
+      data
+      && isFilled(data.name)
+      && isFilled(data.description)
+    ) {
+      const newItem: DesignTypesPromptCacheItem = {
+        path: item.path,
+        md5,
+        name: data.name,
+        description: data.description
+      }
+
+      if (cacheIndex >= 0) {
+        cache[cacheIndex] = newItem
+      } else {
+        cache.push(newItem)
+      }
+
+      return {
+        prompt: this.getPromptLine(item.path, data.description),
+        isChanged: true
+      }
+    }
+
+    return { isChanged: false }
+  }
+}

package/src/config.ts

@@ -25,6 +25,8 @@ export const UI_DIR_IN = 'src'
 export const UI_DIR_AI = 'ai'
 /** Screenshot folder name for AI / Название папки со снимками экрана для AI */
 export const UI_DIR_AI_PROMPT_SCREENSHOT = 'ai-screenshot'
+/** AI types list directory name / Название директории со списком типов AI */
+export const UI_DIR_AI_TYPES_LIST = 'ai-types-list'
 /** Components directory name/ Название директории компонентов */
 export const UI_DIR_COMPONENTS = 'components'
 /** Constructors directory name/ Название директории конструкторов */

package/src/library.ts

@@ -1,68 +1,73 @@
-// Classes
-export * from './classes/Ai/AiAbstract'
-export * from './classes/Ai/AiClaude'
-export * from './classes/Ai/AiClaudeAgent'
-export * from './classes/Ai/AiClaudeAgentLite'
-export * from './classes/Ai/AiClaudeCli'
-export * from './classes/Ai/AiClaudeCliLite'
-export * from './classes/Ai/AiClaudeLite'
-export * from './classes/Ai/AiDoc'
-export * from './classes/Ai/AiDocItem'
-export * from './classes/Ai/AiDocItemAbstract'
-export * from './classes/Ai/AiDocItemClasses'
-export * from './classes/Ai/AiDocItemComposables'
-export * from './classes/Ai/AiDocType'
-export * from './classes/Ai/AiGoogle'
-export * from './classes/Ai/AiGoogleCli'
-export * from './classes/Ai/AiGoogleCliLite'
-export * from './classes/Ai/AiGoogleLite'
-export * from './classes/Ai/AiOpenAi'
-export * from './classes/Ai/AiOpenAiLite'
-export * from './classes/Ai/AiZAi'
-export * from './classes/Ai/AiZAiLite'
-export * from './classes/Ai/ApiTmp'
-export * from './classes/BrowserItem'
-export * from './classes/Build/BuildFunctional'
-export * from './classes/Build/BuildPackages'
-export * from './classes/Build/BuildPublishPackages'
-export * from './classes/BuildItem'
-export * from './classes/Design/DesignFigma'
-export * from './classes/Design/DesignScreenshot'
-export * from './classes/Design/DesignTypes'
-export * from './classes/Design/DesignTypescript'
-export * from './classes/Design/DesignWikiStorm'
-export * from './classes/Design/DesignWikiStormItem'
-export * from './classes/FigmaApi'
-export * from './classes/Git/GitRead'
-export * from './classes/Library/LibraryAiMcpItem'
-export * from './classes/Library/LibraryAiPrompt'
-export * from './classes/Library/LibraryAiPromptItem'
-export * from './classes/Library/LibraryAiWiki'
-export * from './classes/Library/LibraryAiWikiItem'
-export * from './classes/Library/LibraryExport'
-export * from './classes/Library/LibraryList'
-export * from './classes/Library/LibraryPlugin'
-export * from './classes/Library/LibraryTypes'
-export * from './classes/Package/PackageFile'
-export * from './classes/Properties/PropertiesFile'
-
-// Composables
-export * from './composables/useAi'
-
-// Functions
-export * from './functions/getConfigAi'
-export * from './functions/getDirname'
-export * from './functions/getPackageJson'
-export * from './functions/hasNativeDirname'
-export * from './functions/run'
-
-// Types
-export * from './types/aiTypes'
-export * from './types/configTypes'
-export * from './types/designTypes'
-export * from './types/figmaApiTypes'
-export * from './types/gitTypes'
-export * from './types/libraryTypes'
-export * from './types/propertyTypes'
-export * from './types/screenshotTypes'
-export * from './types/webTypes'
+// Classes
+export * from './classes/Ai/AiAbstract'
+export * from './classes/Ai/AiClaude'
+export * from './classes/Ai/AiClaudeAgent'
+export * from './classes/Ai/AiClaudeAgentLite'
+export * from './classes/Ai/AiClaudeCli'
+export * from './classes/Ai/AiClaudeCliLite'
+export * from './classes/Ai/AiClaudeLite'
+export * from './classes/Ai/AiDoc'
+export * from './classes/Ai/AiDocItem'
+export * from './classes/Ai/AiDocItemAbstract'
+export * from './classes/Ai/AiDocItemClasses'
+export * from './classes/Ai/AiDocItemComposables'
+export * from './classes/Ai/AiDocType'
+export * from './classes/Ai/AiGoogle'
+export * from './classes/Ai/AiGoogleCli'
+export * from './classes/Ai/AiGoogleCliLite'
+export * from './classes/Ai/AiGoogleLite'
+export * from './classes/Ai/AiOpenAi'
+export * from './classes/Ai/AiOpenAiLite'
+export * from './classes/Ai/AiZAi'
+export * from './classes/Ai/AiZAiLite'
+export * from './classes/Ai/ApiTmp'
+export * from './classes/BrowserItem'
+export * from './classes/Build/BuildFunctional'
+export * from './classes/Build/BuildPackages'
+export * from './classes/Build/BuildPublishPackages'
+export * from './classes/BuildItem'
+export * from './classes/Design/DesignFigma'
+export * from './classes/Design/DesignScreenshot'
+export * from './classes/Design/DesignTypes'
+export * from './classes/Design/DesignTypesAi'
+export * from './classes/Design/DesignTypesDescription'
+export * from './classes/Design/DesignTypesMake'
+export * from './classes/Design/DesignTypesMcp'
+export * from './classes/Design/DesignTypesPrompts'
+export * from './classes/Design/DesignTypescript'
+export * from './classes/Design/DesignWikiStorm'
+export * from './classes/Design/DesignWikiStormItem'
+export * from './classes/FigmaApi'
+export * from './classes/Git/GitRead'
+export * from './classes/Library/LibraryAiMcpItem'
+export * from './classes/Library/LibraryAiPrompt'
+export * from './classes/Library/LibraryAiPromptItem'
+export * from './classes/Library/LibraryAiWiki'
+export * from './classes/Library/LibraryAiWikiItem'
+export * from './classes/Library/LibraryExport'
+export * from './classes/Library/LibraryList'
+export * from './classes/Library/LibraryPlugin'
+export * from './classes/Library/LibraryTypes'
+export * from './classes/Package/PackageFile'
+export * from './classes/Properties/PropertiesFile'
+
+// Composables
+export * from './composables/useAi'
+
+// Functions
+export * from './functions/getConfigAi'
+export * from './functions/getDirname'
+export * from './functions/getPackageJson'
+export * from './functions/hasNativeDirname'
+export * from './functions/run'
+
+// Types
+export * from './types/aiTypes'
+export * from './types/configTypes'
+export * from './types/designTypes'
+export * from './types/figmaApiTypes'
+export * from './types/gitTypes'
+export * from './types/libraryTypes'
+export * from './types/propertyTypes'
+export * from './types/screenshotTypes'
+export * from './types/webTypes'

package/src/media/templates/packages/library/_.gitignore.txt

@@ -11,6 +11,8 @@ node_modules
 dist-ssr
 *.local
 
+ai-types.md
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json

package/src/media/templates/prompts/aiCodeVuePrompt.en.md

@@ -7,7 +7,7 @@
 - **Lists (v-for)**: Always use a unique `:key`. Avoid using the array index as a key.
 - **Directives**: Never use `v-if` on the same element as `v-for`.
 - **Reactivity**: Use `ref` for data. Calculate complex logic via `computed`.
-- **Logic**: ALL logic must be moved to Composables. The component should only contain the composable call and the template.
+- **Logic**: Extract only complex logic into Composables. Simple logic or calling existing hooks (even multiple) does not need to be extracted into a separate composable.
 - **Templates**: Cleanest possible HTML. No function calls, calculations, or inline styles. If complex logic is needed, split into sub-components.
 - **Props**: One-way data flow. Never mutate incoming props.
 - **Events**: Event names must be strictly in kebab-case.

package/src/media/templates/prompts/aiCodeVuePrompt.ru.md

@@ -7,7 +7,7 @@
 - **Списки (v-for)**: Всегда используй уникальный `:key`. Избегай использования индекса массива в качестве ключа.
 - **Директивы**: Никогда не используй `v-if` на том же элементе, что и `v-for`.
 - **Реактивность**: Используй `ref` для данных. Сложную логику вычисляй через `computed`.
-- **Логика**: ВСЯ логика должна быть вынесена в Composables. Компонент должен содержать только вызов composable и шаблон.
+- **Логика**: Выноси в Composables только сложную объёмную логику. Простую логику или прямое использование готовых хуков (даже нескольких) выносить в отдельный composable не требуется.
 - **Шаблоны**: Максимально чистый HTML. Никаких вызовов функций, вычислений или инлайн-стилей. Если нужна сложная логика — разделяй на подкомпоненты.
 - **Props**: Односторонний поток данных. Никогда не мутируй входящие пропсы.
 - **События**: Названия событий — строго в kebab-case.

package/src/types/designTypes.ts

@@ -107,13 +107,50 @@ export type DesignTypescriptItem = {
 /** List of TypeScript items / Список TypeScript элементов */
 export type DesignTypescriptList = DesignTypescriptItem[]
 
+/** Design types item / Элемент типов дизайна */
 export type DesignTypesItem = {
+  /** Relative file path / Относительный путь к файлу */
   path: string
+  /** File content / Содержимое файла */
   content: string
+  /** MD5 hash string / Строка MD5 хэша */
+  md5?: string
 }
 
+/** List of design types items / Список элементов типов дизайна */
 export type DesignTypesList = DesignTypesItem[]
 
+/** Design types prompt cache item / Элемент кэша промпта типов дизайна */
+export type DesignTypesPromptCacheItem = {
+  /** Relative file path / Относительный путь к файлу */
+  path: string
+  /** MD5 hash string / Строка MD5 хэша */
+  md5: string
+  /** Document title / Название документа */
+  name: string
+  /** Document description / Описание документа */
+  description: string
+}
+
+/** List of design types prompt cache items / Список элементов кэша промптов типов дизайна */
+export type DesignTypesPromptCacheList = DesignTypesPromptCacheItem[]
+
+/** Design types prompt data item / Элемент данных промпта типов дизайна */
+export type DesignTypesPromptData = {
+  /** Document title / Название документа */
+  name?: string
+  /** Document description / Описание документа */
+  description?: string
+}
+
+/** Design types prompt item result / Результат обработки элемента промпта типов дизайна */
+export type DesignTypesPromptResult = {
+  /** Formatted prompt rule string / Отформатированная строка правила промпта */
+  prompt?: string
+  /** Flag indicating whether the cache was changed / Флаг указывающий был ли изменен кэш */
+  isChanged: boolean
+}
+
 /** Design MCP resource item / Элемент ресурса MCP дизайна */
 export type DesignMcpResourceItem = {
   /** Resource URI / URI ресурса */