@dxtmisha/scripts 0.7.2 → 0.7.7

package/bin/design-wiki-storm.ts

@@ -0,0 +1,9 @@
+#!/usr/bin/env vite-node
+
+import { DesignWikiStorm } from '../src/classes/Design/DesignWikiStorm'
+
+// const name: string | undefined = process.argv?.[2] ?? undefined
+
+new DesignWikiStorm()
+  .make()
+  .then()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dxtmisha/scripts",
   "private": false,
-  "version": "0.7.2",
+  "version": "0.7.7",
   "type": "module",
   "description": "Development scripts and CLI tools for DXT UI projects - automated component generation, library building and project management tools",
   "keywords": [
@@ -28,7 +28,8 @@
     "url": "https://github.com/dxtmisha/dxt-ui/issues"
   },
   "scripts": {
-    "library": "dxt-library"
+    "library": "dxt-library",
+    "publish-to-npm": "npm publish --access public"
   },
   "files": [
     "bin/",
@@ -49,7 +50,8 @@
     "dxt-library": "bin/design-library.ts",
     "dxt-package": "bin/design-package.ts",
     "dxt-types": "bin/design-types.ts",
-    "dxt-ui": "bin/design-ui.ts"
+    "dxt-ui": "bin/design-ui.ts",
+    "dxt-wiki-storm": "bin/design-wiki-storm.ts"
   },
   "exports": {
     ".": "./src/library.ts",

package/src/classes/Ai/AiAbstract.ts

@@ -39,10 +39,12 @@ export abstract class AiAbstract<AI = any> {
    * Конструктор инициализирует ресурсы конкретной реализации.
    * @param key - API key / API ключ
    * @param model - initial model id / начальный идентификатор модели
+   * @param config - configuration object / объект конфигурации
    */
   constructor(
     protected key: string,
-    protected model: string
+    protected model: string,
+    protected config: Record<string, any> = {}
   ) {
   }
 
@@ -150,6 +152,17 @@ export abstract class AiAbstract<AI = any> {
     return this
   }
 
+  /**
+   * Sets / switches configuration object.
+   *
+   * Устанавливает / переключает объект конфигурации.
+   * @param config - configuration object / объект конфигурации
+   */
+  setConfig(config: Record<string, any>): this {
+    this.config = config
+    return this
+  }
+
   /**
    * Generates AI response using active model and composed contents.
    *

package/src/classes/Ai/AiGoogleLite.ts

@@ -69,7 +69,8 @@ export class AiGoogleLite extends AiAbstract<GoogleGenAI> {
             { text: contents }
           ]
         }
-      ]
+      ],
+      config: this.config
     })
 
     return response?.text ?? ''

package/src/classes/Build/__tests__/buildFunctional.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it, vi } from 'vitest'
+import { BuildFunctional } from '../buildFunctional'
+import { PropertiesFile } from '../../Properties/PropertiesFile'
+import { UI_DIRS_LIBRARY } from '../../../config'
+
+vi.mock('@dxtmisha/functional', () => ({
+  func1: vi.fn(),
+  func2: vi.fn()
+}))
+
+vi.mock('../../Properties/PropertiesFile', () => ({
+  PropertiesFile: {
+    writeByPath: vi.fn()
+  }
+}))
+
+describe('BuildFunctional', () => {
+  it('getList should return keys of the functional package', () => {
+    const build = new BuildFunctional()
+    const list = build.getList()
+    expect(list).toContain('func1')
+    expect(list).toContain('func2')
+    expect(list).toHaveLength(2)
+  })
+
+  it('make should call PropertiesFile.writeByPath with correct arguments', () => {
+    const build = new BuildFunctional()
+    build.make()
+
+    expect(PropertiesFile.writeByPath).toHaveBeenCalledWith(
+      [...UI_DIRS_LIBRARY, 'functional.ts'],
+      expect.stringContaining('export { func1 } from \'@dxtmisha/functional\'')
+    )
+    expect(PropertiesFile.writeByPath).toHaveBeenCalledWith(
+      [...UI_DIRS_LIBRARY, 'functional.ts'],
+      expect.stringContaining('export { func2 } from \'@dxtmisha/functional\'')
+    )
+    expect(PropertiesFile.writeByPath).toHaveBeenCalledWith(
+      [...UI_DIRS_LIBRARY, 'functional.ts'],
+      expect.stringContaining('export type * from \'@dxtmisha/functional\'')
+    )
+  })
+})

package/src/classes/Build/buildFunctional.ts

@@ -4,10 +4,20 @@ import { PropertiesFile } from '../Properties/PropertiesFile'
 
 import { UI_DIRS_LIBRARY } from '../../config'
 
+/**
+ * A class for building the functional library exports.
+ *
+ * Класс для сборки экспортов функциональной библиотеки.
+ */
 export class BuildFunctional {
   constructor() {
   }
 
+  /**
+   * Generates the functional.ts file by re-exporting all members from @dxtmisha/functional.
+   *
+   * Генерирует файл functional.ts, повторно экспортируя все элементы из @dxtmisha/functional.
+   */
   make(): void {
     console.log('Build functional...')
 
@@ -33,6 +43,11 @@ export class BuildFunctional {
     console.log('...end')
   }
 
+  /**
+   * Returns a list of all exported members from the @dxtmisha/functional package.
+   *
+   * Возвращает список всех экспортируемых элементов из пакета @dxtmisha/functional.
+   */
   getList(): string[] {
     return Object.keys(functional)
   }

package/src/classes/Component/ComponentCreator.ts

@@ -34,6 +34,7 @@ export class ComponentCreator {
    * Collects only empty component directories.
    *
    * Собирает только пустые директории компонентов.
+   * @protected
    */
   protected getDirs(): string[] {
     return PropertiesFile.readDirOnlyRecursive(UI_DIRS_COMPONENTS)

package/src/classes/Component/ComponentItem.ts

@@ -56,6 +56,7 @@ export class ComponentItem {
    * Gets component name from directory path.
    *
    * Получает имя компонента из пути директории.
+   * @protected
    */
   protected getName(): string {
     const parts = PropertiesFile.splitForDir(this.path)
@@ -66,6 +67,7 @@ export class ComponentItem {
    * Reads project name from package.json.
    *
    * Читает имя проекта из package.json.
+   * @protected
    */
   protected getProjectName(): string {
     return this.readPackage()?.name ?? 'Project'
@@ -75,6 +77,8 @@ export class ComponentItem {
    * Builds destination file path for output.
    *
    * Строит путь назначения для выходного файла.
+   * @param path filename/ имя файла
+   * @protected
    */
   protected getFilePath(path: string): string[] {
     return [
@@ -87,6 +91,8 @@ export class ComponentItem {
    * Builds template file path for reading.
    *
    * Строит путь к файлу шаблона для чтения.
+   * @param path filename/ имя файла
+   * @protected
    */
   protected getSamplePath(path: string): string[] {
     return [...DIR_SAMPLE, path]
@@ -96,6 +102,7 @@ export class ComponentItem {
    * Lists all template files recursively.
    *
    * Получает список всех файлов шаблонов рекурсивно.
+   * @protected
    */
   protected getFilesSample(): string[] {
     return PropertiesFile.readDirRecursive(DIR_SAMPLE)
@@ -105,6 +112,8 @@ export class ComponentItem {
    * Reads template file content as string.
    *
    * Читает содержимое файла шаблона как строку.
+   * @param path filename/ имя файла
+   * @protected
    */
   protected readFile(path: string): string {
     return String(PropertiesFile.readFile(this.getSamplePath(path)))
@@ -114,6 +123,7 @@ export class ComponentItem {
    * Reads package.json data or returns empty object.
    *
    * Читает данные package.json или возвращает пустой объект.
+   * @protected
    */
   protected readPackage(): Record<string, any> {
     return PropertiesFile.readFile(UI_FILE_PACKAGE) ?? {}
@@ -123,6 +133,9 @@ export class ComponentItem {
    * Writes generated file to destination.
    *
    * Записывает сгенерированный файл в место назначения.
+   * @param path filename/ имя файла
+   * @param content file content/ содержимое файла
+   * @protected
    */
   protected writeFile(path: string, content: string): void {
     const paths = this.getFilePath(path)
@@ -135,6 +148,8 @@ export class ComponentItem {
    * Replaces template placeholders with actual values.
    *
    * Заменяет плейсхолдеры шаблона реальными значениями.
+   * @param contentOrPath content or path/ содержимое или путь
+   * @protected
    */
   protected replacement(contentOrPath: string): string {
     return contentOrPath

package/src/classes/Component/ComponentWiki.ts

@@ -125,6 +125,7 @@ export class ComponentWiki {
    * Returns root path segments for the component.
    *
    * Возвращает сегменты корневого пути компонента.
+   * @protected
    */
   protected getRootComponent(): string[] {
     return [
@@ -137,6 +138,7 @@ export class ComponentWiki {
    * Returns wiki directory path segments.
    *
    * Возвращает сегменты пути wiki директории.
+   * @protected
    */
   protected getPathWiki(): string[] {
     return [
@@ -149,6 +151,7 @@ export class ComponentWiki {
    * Returns temporary directory path segments.
    *
    * Возвращает сегменты пути временной директории.
+   * @protected
    */
   protected getPathTemporary(): string[] {
     return [
@@ -161,6 +164,7 @@ export class ComponentWiki {
    * Derives component folder name.
    *
    * Получает имя директории компонента.
+   * @protected
    */
   protected getName(): string {
     return String(getNameDirByPaths(this.getRootComponent()))
@@ -170,6 +174,7 @@ export class ComponentWiki {
    * Reads the demo file content.
    *
    * Читает содержимое демо-файла.
+   * @protected
    */
   protected readDemo(): string {
     return new ComponentWikiFile(FILE_DEMO_SAMPLE).read()
@@ -179,6 +184,7 @@ export class ComponentWiki {
    * Reads the prompt template.
    *
    * Читает шаблон промпта.
+   * @protected
    */
   protected readPrompt(): string {
     return new ComponentWikiFile(FILE_PROMPT_SAMPLE)
@@ -190,6 +196,7 @@ export class ComponentWiki {
    * Prepares context for AI.
    *
    * Подготавливает контекст для ИИ.
+   * @protected
    */
   protected makeAi(): void {
     if (this.ai) {
@@ -206,6 +213,7 @@ export class ComponentWiki {
    * Invokes AI generation and splits result into types / stories / mdx.
    *
    * Вызывает генерацию через ИИ и делит результат на types / stories / mdx.
+   * @protected
    */
   protected async aiGenerate(): Promise<void> {
     if (this.ai) {

package/src/classes/Component/ComponentWikiFile.ts

@@ -98,6 +98,7 @@ export class ComponentWikiFile {
    *
    * Извлекает дату из строки содержимого.
    * @param content content string / строка содержимого
+   * @protected
    */
   protected extractDateFromContent(content: string): Datetime {
     const match = content.match(DATE_UPDATED_MATCH)
@@ -118,6 +119,7 @@ export class ComponentWikiFile {
    *
    * Добавляет текущую дату в содержимое, если isDate равно true.
    * @param content content string / строка содержимого
+   * @protected
    */
   protected addDate(content: string): string {
     if (this.isDate) {

package/src/classes/Component/__tests__/ComponentCreator.test.ts

@@ -0,0 +1,71 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { ComponentCreator } from '../ComponentCreator'
+import { PropertiesFile } from '../../Properties/PropertiesFile'
+import { ComponentItem } from '../ComponentItem'
+import { getComponentPaths } from '../../../functions/getComponentPaths'
+import { UI_DIRS_COMPONENTS } from '../../../config'
+
+vi.mock('../../Properties/PropertiesFile', () => ({
+  PropertiesFile: {
+    readDirOnlyRecursive: vi.fn(),
+    readDir: vi.fn()
+  }
+}))
+
+vi.mock('../ComponentItem', () => ({
+  ComponentItem: vi.fn().mockImplementation(function () {
+    return {
+      make: vi.fn()
+    }
+  })
+}))
+
+vi.mock('../../../functions/getComponentPaths', () => ({
+  getComponentPaths: vi.fn(path => [path, 'full'])
+}))
+
+describe('ComponentCreator', () => {
+  let creator: ComponentCreator
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+    creator = new ComponentCreator()
+  })
+
+  it('make should call ComponentItem.make for each empty directory', () => {
+    vi.mocked(PropertiesFile.readDirOnlyRecursive).mockReturnValue(['dir1', 'dir2', 'dir3'])
+    vi.mocked(PropertiesFile.readDir).mockImplementation((path) => {
+      if (Array.isArray(path) && path[0] === 'dir2') return ['file.ts']
+      return []
+    })
+
+    creator.make()
+
+    expect(ComponentItem).toHaveBeenCalledWith('dir1')
+    expect(ComponentItem).not.toHaveBeenCalledWith('dir2')
+    expect(ComponentItem).toHaveBeenCalledWith('dir3')
+
+    const mockInstance1 = vi.mocked(ComponentItem).mock.results[0]?.value
+    const mockInstance2 = vi.mocked(ComponentItem).mock.results[1]?.value
+
+    expect(mockInstance1?.make).toHaveBeenCalled()
+    expect(mockInstance2?.make).toHaveBeenCalled()
+  })
+
+  it('getDirs should return only empty directories', () => {
+    vi.mocked(PropertiesFile.readDirOnlyRecursive).mockReturnValue(['empty', 'not-empty'])
+    vi.mocked(PropertiesFile.readDir).mockImplementation((path) => {
+      if (Array.isArray(path) && path[0] === 'not-empty') return ['index.ts']
+      return []
+    })
+
+    // Access protected method for testing
+    const dirs = (creator as any).getDirs()
+
+    expect(dirs).toContain('empty')
+    expect(dirs).not.toContain('not-empty')
+    expect(dirs).toHaveLength(1)
+    expect(PropertiesFile.readDirOnlyRecursive).toHaveBeenCalledWith(UI_DIRS_COMPONENTS)
+    expect(getComponentPaths).toHaveBeenCalledWith('empty')
+  })
+})

package/src/classes/Component/__tests__/ComponentItem.test.ts

@@ -0,0 +1,71 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { ComponentItem } from '../ComponentItem'
+import { PropertiesFile } from '../../Properties/PropertiesFile'
+import { toKebabCase } from '@dxtmisha/functional-basic'
+
+vi.mock('../../Properties/PropertiesFile', () => ({
+  PropertiesFile: {
+    splitForDir: vi.fn(path => path.split('/')),
+    readFile: vi.fn(),
+    writeByPath: vi.fn(),
+    chmod: vi.fn(),
+    readDirRecursive: vi.fn()
+  }
+}))
+
+vi.mock('../../../functions/getComponentPaths', () => ({
+  getComponentPaths: vi.fn(path => [path, 'full'])
+}))
+
+describe('ComponentItem', () => {
+  let item: ComponentItem
+  const mockPath = 'src/components/TestComponent'
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+    item = new ComponentItem(mockPath)
+  })
+
+  it('getName should return the last part of the path', () => {
+    const name = (item as any).getName()
+    expect(name).toBe('TestComponent')
+    expect(PropertiesFile.splitForDir).toHaveBeenCalledWith(mockPath)
+  })
+
+  it('getProjectName should return package name or "Project"', () => {
+    vi.mocked(PropertiesFile.readFile).mockReturnValue({ name: 'test-project' })
+    const projectName = (item as any).getProjectName()
+    expect(projectName).toBe('test-project')
+
+    vi.mocked(PropertiesFile.readFile).mockReturnValue(undefined)
+    expect((item as any).getProjectName()).toBe('Project')
+  })
+
+  it('replacement should replace placeholders correctly', () => {
+    vi.mocked(PropertiesFile.readFile).mockReturnValue({ name: 'test-project' })
+    const content = 'Name: ComponentDoc, kebab: component-doc, project: [project], path: [path]'
+    const result = (item as any).replacement(content)
+
+    expect(result).toContain('Name: TestComponent')
+    expect(result).toContain(`kebab: ${toKebabCase('TestComponent')}`)
+    expect(result).toContain('project: test-project')
+    expect(result).toContain(`path: ${mockPath}`)
+  })
+
+  it('make should read templates and write files with replacements', () => {
+    vi.mocked(PropertiesFile.readDirRecursive).mockReturnValue(['Template.ts'])
+    vi.mocked(PropertiesFile.readFile).mockImplementation((path) => {
+      if (Array.isArray(path) && path.includes('package.json')) return { name: 'test-project' }
+      return 'export class ComponentDoc {}'
+    })
+
+    item.make()
+
+    expect(PropertiesFile.readDirRecursive).toHaveBeenCalled()
+    expect(PropertiesFile.writeByPath).toHaveBeenCalledWith(
+      expect.arrayContaining([mockPath, 'Template.ts']),
+      'export class TestComponent {}'
+    )
+    expect(PropertiesFile.chmod).toHaveBeenCalled()
+  })
+})

package/src/classes/Design/DesignCommand.ts

@@ -11,7 +11,7 @@ import { PropertiesFile } from '../Properties/PropertiesFile'
 import { DesignStructure } from './DesignStructure'
 import { DesignReplace } from './DesignReplace'
 
-import { UI_FILE_PACKAGE, UI_KEY_CONSTRUCTOR } from '../../config'
+import { UI_FILE_PACKAGE } from '../../config'
 
 const dirnamePath = hasNativeDirname()
   ? __dirname
@@ -20,9 +20,11 @@ const dirnamePath = hasNativeDirname()
 const DIR_SAMPLE = [dirnamePath, '..', '..', 'media', 'templates']
 
 /**
- * Base abstract class for generating script files.
+ * Base abstract class for generating script files and design system components.
+ * Provides unified logic for template reading, data transformation, and file writing.
  *
- * Базовый абстрактный класс для генерации файлов скриптов.
+ * Базовый абстрактный класс для генерации файлов скриптов и компонентов дизайн-системы.
+ * Обеспечивает единую логику чтения шаблонов, трансформации данных и записи файлов.
  */
 export abstract class DesignCommand {
   protected abstract DIR_SAMPLE: string
@@ -31,11 +33,12 @@ export abstract class DesignCommand {
   protected structure?: DesignStructure
 
   /**
-   * Constructor
-   * @param command component name/ названия компонента
-   * @param options additional parameters/ дополнительные параметры
+   * Constructor for DesignCommand.
+   *
+   * Конструктор для DesignCommand.
+   * @param command component name or command identifier / название компонента или идентификатор команды
+   * @param options additional key-value parameters / дополнительные параметры ключ-значение
    */
-
   protected constructor(
     protected readonly command: string,
     protected readonly options: Record<string, string> = {}
@@ -43,9 +46,11 @@ export abstract class DesignCommand {
   }
 
   /**
-   * Entry point for the command.
+   * Main entry point for executing the command.
+   * Validates input and triggers the primary initialization logic.
    *
-   * Точка входа для команды.
+   * Основная точка входа для выполнения команды.
+   * Проверяет входные данные и запускает основную логику инициализации.
    */
   make(): void {
     if (this.command) {
@@ -112,11 +117,7 @@ export abstract class DesignCommand {
    */
   protected getStructure(): DesignStructure {
     if (!this.structure) {
-      const [design, component] = this.getCommand().split('.', 2)
-      this.structure = new DesignStructure(
-        design ?? UI_KEY_CONSTRUCTOR,
-        component ?? 'component'
-      )
+      this.structure = new DesignStructure(this.getCommand())
     }
 
     return this.structure