@dxtmisha/scripts 0.7.2 → 0.7.6

package/src/classes/Properties/PropertiesScss.ts

@@ -20,22 +20,24 @@ const NAME_SHADE = 'setDesignShade'
 const NAME_PROPERTIES = 'setDesignsProperties'
 
 /**
- * Class for working with SCSS.
+ * Class for generating SCSS structures from design tokens.
  *
- * Класс для работы с SCSS.
+ * Класс для генерации структур SCSS из токенов дизайна.
  */
 export class PropertiesScss {
   /**
-   * Constructor
-   * @param items
+   * Constructor for initializing the SCSS generator.
+   *
+   * Конструктор для инициализации генератора SCSS.
+   * @param items property management instance / экземпляр управления свойствами
    */
   constructor(private items: PropertiesItems) {
   }
 
   /**
-   * Returns a formatted string for SCSS.
+   * Returns a complete SCSS formatted string containing all configuration mixins.
    *
-   * Возвращает отформатированную строку для SCSS.
+   * Возвращает полную отформатированную строку SCSS, содержащую все миксины конфигурации.
    */
   get() {
     let data = '@use "@dxtmisha/styles" as variables;\r\n\r\n'
@@ -145,9 +147,9 @@ export class PropertiesScss {
   }
 
   /**
-   * Returns a list of properties.
+   * Generates a SCSS map structure for all identified properties.
    *
-   * Возвращает список свойств.
+   * Генерирует структуру карты SCSS для всех определенных свойств.
    */
   getProperties(): string {
     return this.getPropertiesValue(NAME_PROPERTIES, this.to())

package/src/classes/Properties/PropertiesSeparator.ts

@@ -12,19 +12,17 @@ import {
 } from '../../types/propertyTypes'
 
 /**
- * Class for working with property splitting into multiple sub-properties.
+ * Class for handling the splitting of property names with separators into nested sub-properties.
  *
- * Класс для работы с разделением свойства на множество под-свойств.
+ * Класс для работы с разделением названий свойств с разделителями на вложенные под-свойства.
  */
 export class PropertiesSeparator {
   /**
-   * Checks if the structure has grouped records.
+   * Checks if the property list contains any keys that require splitting (contain separators).
    *
-   * Проверяет, есть ли у структуры сгруппированные записи.
-   * @param properties an array that needs to be transformed/
-   * массив, который нужно преобразовать
-   * @param limit the maximum permissible level of verification/
-   * максимальный допустимый уровень проверки
+   * Проверяет, содержит ли список свойств ключи, требующие разделения (содержащие разделители).
+   * @param properties list of properties to check / список свойств для проверки
+   * @param limit maximum recursion depth for verification / максимальная глубина рекурсии для проверки
    */
   static is(
     properties: PropertyList,
@@ -52,10 +50,10 @@ export class PropertiesSeparator {
   }
 
   /**
-   * Transforming a property with long names with separators into a set of sub-properties.
+   * Transforms properties with separator-containing keys into a nested object structure.
    *
-   * Преобразование свойства с длинными названиями с разделителями на множество под-свойств.
-   * @param properties an array that needs to be transformed/ массив, который нужно преобразовать
+   * Преобразует свойства с ключами, содержащими разделители, во вложенную структуру объектов.
+   * @param properties the property list to transform / список свойств для преобразования
    */
   static to(properties: PropertyList): PropertyList {
     let data: PropertyList = {}

package/src/classes/Properties/PropertiesSettings.ts

@@ -16,14 +16,16 @@ import { UI_DIRS_COMPONENTS, UI_DIRS_CONSTRUCTOR, UI_KEY_CONSTRUCTOR } from '../
 const DIR_NAME = 'settings'
 
 /**
- * Class for searching all components.
+ * Class for searching and loading global component settings.
  *
- * Класс для поиск всех компоненты.
+ * Класс для поиска и загрузки глобальных настроек компонентов.
  */
 export class PropertiesSettings {
   /**
-   * Constructor
-   * @param path object of the class for working with paths/ объект класса для работы с путями
+   * Constructor for initializing the settings resolver.
+   *
+   * Конструктор для инициализации резолвера настроек.
+   * @param path path handler instance / экземпляр обработчика путей
    */
   constructor(
     private readonly path: PropertiesPath
@@ -31,9 +33,9 @@ export class PropertiesSettings {
   }
 
   /**
-   * Returns the basic settings of the component.
+   * Returns a unified list of settings for all identified components and constructors.
    *
-   * Возвращает базовые настройки у компонента.
+   * Возвращает унифицированный список настроек для всех определенных компонентов и конструкторов.
    */
   get(): PropertyList {
     return {

package/src/classes/Properties/PropertiesStandard.ts

@@ -16,17 +16,16 @@ import {
 } from '../../types/propertyTypes'
 
 /**
- * A class for transforming a property into a basic structure for work.
+ * Class for transforming raw property data into a standardized structure for internal processing.
  *
- * Класс для преобразования свойства в базовую структуру для работы.
+ * Класс для преобразования сырых данных свойств в стандартизированную структуру для внутренней обработки.
  */
 export class PropertiesStandard {
   /**
-   * Transforms an array into the required data structure.
+   * Transforms a property list or raw data into a standardized PropertyList structure.
    *
-   * Преобразует массив в нужную структуру.
-   * @param properties an array that needs to be transformed/
-   * массив, который нужно преобразовать
+   * Преобразует список свойств или сырые данные в стандартизированную структуру PropertyList.
+   * @param properties the property list or data to transform / список свойств или данные для преобразования
    */
   static to(properties: PropertyListOrData): PropertyList {
     const data: PropertyList = {}

package/src/classes/Properties/PropertiesTool.ts

@@ -12,16 +12,16 @@ import basicProperties from '../../media/properties.json'
 import { UI_KEY_CONSTRUCTOR, UI_FILE_PROPERTY } from '../../config'
 
 /**
- * A class for static methods of obtaining various data.
+ * Utility class for naming components and reading design system property files.
  *
- * Класс для статических методов получения различных данных.
+ * Утилитарный класс для именования компонентов и чтения файлов свойств дизайн-системы.
  */
 export class PropertiesTool {
   /**
-   * Checks if the names of the design relate to the construction.
+   * Checks if the design name identifies as a constructor.
    *
-   * Проверяет, относятся ли названия дизайна к конструкции.
-   * @param design design name/ название дизайна
+   * Проверяет, идентифицирует ли название дизайна конструктор.
+   * @param design design name / название дизайна
    */
   static isConstructor(design: string): boolean {
     return design === UI_KEY_CONSTRUCTOR
@@ -37,11 +37,11 @@ export class PropertiesTool {
   }
 
   /**
-   * Return a list of component names.
+   * Generates a camelCase component name string based on design and component name.
    *
-   * Возвращаем список названий компонентов.
-   * @param design design name/ название дизайна
-   * @param component component name/ название компонента
+   * Генерирует строку названия компонента в стиле camelCase на основе дизайна и названия компонента.
+   * @param design design name / название дизайна
+   * @param component component name / название компонента
    */
   static getComponentName(design: string, component?: string): string {
     return `${design}${component ? `-${toCamelCase(component)}` : ''}`
@@ -58,6 +58,13 @@ export class PropertiesTool {
     return `.${this.getComponentName(design, component)}`
   }
 
+  /**
+   * Reads a property list from a specified path, with special handling for constructors.
+   *
+   * Считывает список свойств по указанному пути с особой обработкой для конструкторов.
+   * @param design design name / название дизайна
+   * @param path array representing the directory path / массив, представляющий путь к директории
+   */
   static readFile(
     design: string,
     path: string[] | undefined

package/src/classes/Properties/PropertiesTypes.ts

@@ -8,9 +8,9 @@ import {
 } from '../../types/propertyTypes'
 
 /**
- * Class with a list of available types.
+ * Utility class for identifying and managing property types based on naming conventions and symbols.
  *
- * Класс со списком доступных типов.
+ * Утилитарный класс для идентификации и управления типами свойств на основе соглашений об именовании и символов.
  */
 export class PropertiesTypes {
   private static readonly SYMBOLS: Record<string, string> = {
@@ -27,11 +27,11 @@ export class PropertiesTypes {
   }
 
   /**
-   * Checks if the list contains such a type.
+   * Checks if the property type matches the specified list of allowed types.
    *
-   * Проверяет, входит ли в список такой тип.
-   * @param type property type/ тип свойства
-   * @param name key name/ название ключа
+   * Проверяет, соответствует ли тип свойства указанному списку разрешенных типов.
+   * @param type current property type / текущий тип свойства
+   * @param name list of allowed types / список разрешенных типов
    */
   static isInType(
     type?: PropertyItem['_type'],
@@ -48,10 +48,10 @@ export class PropertiesTypes {
   }
 
   /**
-   * Checks if there is a type in the name of the property.
+   * Determines if the property name contains a type-identifying symbol or specific prefix.
    *
-   * Проверяет, если есть тип в названии свойства.
-   * @param name key name/ название ключа
+   * Определяет, содержит ли название свойства символ-идентификатор типа или специфический префикс.
+   * @param name property key name / название ключа свойства
    */
   static isTypeInName(name: string): boolean {
     return Boolean(name.match(this.getExpSymbols()))
@@ -98,10 +98,10 @@ export class PropertiesTypes {
   }
 
   /**
-   * Returns the variable type name from the property name.
+   * Extracts and returns the property type identifier from its name string.
    *
-   * Возвращает название типа переменной из названия свойства.
-   * @param name key name/ название ключа
+   * Извлекает и возвращает идентификатор типа свойства из строки его названия.
+   * @param name property key name / название ключа свойства
    */
   static getTypeInName(name: string): PropertyItem['_type'] {
     if (this.isTypeInName(name)) {

package/src/classes/Properties/PropertiesValues.ts

@@ -3,26 +3,26 @@
 import { type PropertyItemPartial } from '../../types/propertyTypes'
 
 /**
- * Class for working with the values.
+ * Utility class for validating and normalizing design system property values.
  *
- * Класс для работы со значениями.
+ * Утилитарный класс для валидации и нормализации значений свойств дизайн-системы.
  */
 export class PropertiesValues {
   /**
-   * Checks if the values are complete.
+   * Checks if the value is marked as "full" (starting with `=`), meaning it doesn't require further processing.
    *
-   * Проверяет, является ли значение полным.
-   * @param value property value/ значение свойства
+   * Проверяет, помечено ли значение как «полное» (начинается с `=`), что означает отсутствие необходимости дальнейшей обработки.
+   * @param value property value / значение свойства
    */
   static isFull(value: PropertyItemPartial['value']): value is string {
     return typeof value === 'string' && Boolean(value.match(this.getExpFull()))
   }
 
   /**
-   * Checks if the value is a color value.
+   * Identifies if the value is a hex color string.
    *
-   * Проверяет, является ли значение цветом.
-   * @param value property value/ значение свойства
+   * Определяет, является ли значение строкой цвета в формате HEX.
+   * @param value property value / значение свойства
    */
   static isColor(value: PropertyItemPartial['__c']): boolean {
     return Boolean(
@@ -33,10 +33,10 @@ export class PropertiesValues {
   }
 
   /**
-   * Checks if the value is a color with transparency.
+   * Identifies if the value is a hex color string with an alpha channel (opacity).
    *
-   * Проверяет, является ли значение цветом с прозрачности.
-   * @param value property value/ значение свойства
+   * Определяет, является ли значение строкой цвета HEX с альфа-каналом (прозрачностью).
+   * @param value property value / значение свойства
    */
   static isColorWithOpacity(value: PropertyItemPartial['__c']): boolean {
     return Boolean(
@@ -47,10 +47,10 @@ export class PropertiesValues {
   }
 
   /**
-   * Removes unnecessary values from the values.
+   * Cleans up the value by removing the "full" marker or converting numeric values to strings.
    *
-   * Убирает лишние значения из значений.
-   * @param value property value/ значение свойства
+   * Очищает значение, удаляя маркер «полноты» или преобразовывая числовые значения в строки.
+   * @param value property value / значение свойства
    */
   static reValue(value: PropertyItemPartial['value']): PropertyItemPartial['value'] {
     if (this.isFull(value)) {

package/src/classes/Properties/PropertiesWrap.ts

@@ -11,17 +11,16 @@ import {
 } from '../../types/propertyTypes'
 
 /**
- * A class for moving data up the level, if the property is used in all records at the same level.
+ * Utility class for optimizing the property structure by moving duplicated data to a higher level.
  *
- * Класс для переноса данных выше по уровню, если свойство используется во всех записях на одном уровне.
+ * Утилитарный класс для оптимизации структуры свойств путем переноса дублирующихся данных на более высокий уровень.
  */
 export class PropertiesWrap {
   /**
-   * Drag the duplicate properties to the top level to reduce the record.
+   * Analyzes the property list and moves duplicate properties to the parent level to reduce redundancy.
    *
-   * Перетаскивает дублирующиеся свойства на верхний уровень для уменьшения записи.
-   * @param properties an array that needs to be transformed/
-   * массив, который нужно преобразовать
+   * Анализирует список свойств и переносит дублирующиеся свойства на родительский уровень для уменьшения избыточности.
+   * @param properties property list to transform / список свойств для преобразования
    */
   static to(properties: PropertyList): void {
     forEach(properties, (item) => {

package/src/classes/Properties/convector/convectorColor.ts

@@ -6,10 +6,12 @@ import {
 } from '../../../types/propertyTypes'
 
 /**
- * Data conversion into colors.
+ * Convector for transforming design token color metadata into internal property structures.
+ * Supports opacity modification based on 'studio.tokens' extensions.
  *
- * Преобразование данных в цвета.
- * @param item values for conversion/ значения для преобразования
+ * Конвектор для преобразования метаданных цвета токенов дизайна во внутренние структуры свойств.
+ * Поддерживает модификацию прозрачности на основе расширений 'studio.tokens'.
+ * @param item property input object for conversion / входной объект свойства для преобразования
  */
 export function convectorColor(item: PropertyItemInput): void {
   const type: string | undefined = item?.$extensions?.['studio.tokens']?.modify?.type

package/src/classes/Properties/to/PropertiesToAbstract.ts

@@ -3,22 +3,36 @@
 import { PropertiesItems } from '../PropertiesItems'
 
 /**
- * Abstract class for conversion.
+ * Abstract base class for data transformation processes.
+ * Provides the core orchestration for initializing and writing transformed property data.
  *
- * Абстрактный класс для преобразования.
+ * Абстрактный базовый класс для процессов преобразования данных.
+ * Обеспечивает основную оркестровку инициализации и записи преобразованных данных свойств.
  */
 export abstract class PropertiesToAbstract {
+  /**
+   * Abstract property defining the cache file path for the specific transformation.
+   *
+   * Абстрактное свойство, определяющее путь к файлу кэша для конкретного преобразования.
+   */
   protected readonly abstract FILE_CACHE: string
 
   /**
-   * Constructor
-   * @param items data for processing/ данные для обработки
+   * Constructor that initializes the transformation with a set of property items.
+   *
+   * Конструктор, который инициализирует преобразование набором элементов свойств.
+   * @param items data for processing / данные для обработки
    */
   constructor(
     protected items: PropertiesItems
   ) {
   }
 
+  /**
+   * Executes the full transformation pipeline: initialization followed by writing the output.
+   *
+   * Выполняет полный конвейер преобразования: инициализацию с последующей записью результата.
+   */
   to(): void {
     this.init()
     this.write()

package/src/composables/__tests__/useAi.test.ts

@@ -0,0 +1,75 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { useAi } from '../useAi'
+import { PropertiesConfig } from '../../classes/Properties/PropertiesConfig'
+import { AiGoogle } from '../../classes/Ai/AiGoogle'
+import { AiGoogleCli } from '../../classes/Ai/AiGoogleCli'
+
+vi.mock('../../classes/Properties/PropertiesConfig', () => ({
+  PropertiesConfig: {
+    getAiType: vi.fn()
+  }
+}))
+
+vi.mock('../../classes/Ai/AiGoogle', () => {
+  return {
+    AiGoogle: vi.fn().mockImplementation(function () {
+      return { name: 'AiGoogleInstance' }
+    })
+  }
+})
+
+vi.mock('../../classes/Ai/AiGoogleCli', () => {
+  return {
+    AiGoogleCli: vi.fn().mockImplementation(function () {
+      return { name: 'AiGoogleCliInstance' }
+    })
+  }
+})
+
+describe('useAi', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should return an instance of AiGoogle when the type is gemini', () => {
+    vi.mocked(PropertiesConfig.getAiType).mockReturnValue('gemini')
+    const mockInstance = { name: 'AiGoogleInstance' }
+    vi.mocked(AiGoogle).mockImplementation(function () {
+      return mockInstance as any
+    })
+
+    const result = useAi()
+
+    expect(result).toEqual(mockInstance)
+    expect(AiGoogle).toHaveBeenCalled()
+  })
+
+  it('should return an instance of AiGoogleCli when the type is gemini-cli', () => {
+    vi.mocked(PropertiesConfig.getAiType).mockReturnValue('gemini-cli')
+    const mockInstance = { name: 'AiGoogleCliInstance' }
+    vi.mocked(AiGoogleCli).mockImplementation(function () {
+      return mockInstance as any
+    })
+
+    const result = useAi()
+
+    expect(result).toEqual(mockInstance)
+    expect(AiGoogleCli).toHaveBeenCalled()
+  })
+
+  it('should return undefined for an unknown type', () => {
+    vi.mocked(PropertiesConfig.getAiType).mockReturnValue('unknown' as any)
+
+    const result = useAi()
+
+    expect(result).toBeUndefined()
+  })
+
+  it('should return undefined if no type is configured', () => {
+    vi.mocked(PropertiesConfig.getAiType).mockReturnValue(undefined as any)
+
+    const result = useAi()
+
+    expect(result).toBeUndefined()
+  })
+})

package/src/config.ts

@@ -79,6 +79,7 @@ export const UI_FILE_NAME_MEDIA = 'media'
 /** File name for the list of component descriptions/ Название файла для список описаний компонентов */
 export const UI_FILE_NAME_DESIGN = 'design'
 export const UI_FILE_NAME_PLUGIN = 'plugin'
+export const UI_FILE_NAME_STYLE = 'style'
 
 /** File name for the list of component descriptions for the wiki/ Название файла для список описаний компонентов для wiki */
 export const UI_FILE_NAME_WIKI = 'wiki'
@@ -91,6 +92,7 @@ export const UI_FILE_INDEX = 'index.ts'
 
 export const UI_FILE_AI_TYPES = 'ai-types.txt'
 export const UI_FILE_STYLE_SCSS = 'style.scss'
+export const UI_FILE_STYLE_PROPERTIES = 'ui-properties.scss'
 
 /** SCSS file extension/ Расширение файлов SCSS */
 export const UI_EXTENSION_STYLE = 'scss'

package/src/functions/__tests__/getComponentPaths.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest'
+import { getComponentPaths } from '../getComponentPaths'
+import { UI_DIRS_COMPONENTS } from '../../config'
+
+describe('getComponentPaths', () => {
+  it('should return an array containing UI_DIRS_COMPONENTS and the given path', () => {
+    const path = 'test-component'
+    const result = getComponentPaths(path)
+
+    expect(result).toEqual([...UI_DIRS_COMPONENTS, path])
+  })
+
+  it('it should work with nested paths', () => {
+    const path = 'nested/test-component'
+    const result = getComponentPaths(path)
+
+    expect(result).toEqual([...UI_DIRS_COMPONENTS, path])
+  })
+})

package/src/functions/__tests__/getConfigAi.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it, vi } from 'vitest'
+import { getConfigAi } from '../getConfigAi'
+import { PropertiesConfig } from '../../classes/Properties/PropertiesConfig'
+
+vi.mock('../../classes/Properties/PropertiesConfig', () => ({
+  PropertiesConfig: {
+    getAiKey: vi.fn(),
+    getAiModel: vi.fn()
+  }
+}))
+
+describe('getConfigAi', () => {
+  it('should return AI key and model from PropertiesConfig', () => {
+    const mockKey = 'test-key'
+    const mockModel = 'test-model'
+
+    vi.mocked(PropertiesConfig.getAiKey).mockReturnValue(mockKey)
+    vi.mocked(PropertiesConfig.getAiModel).mockReturnValue(mockModel)
+
+    const result = getConfigAi()
+
+    expect(result).toEqual([mockKey, mockModel])
+    expect(PropertiesConfig.getAiKey).toHaveBeenCalled()
+    expect(PropertiesConfig.getAiModel).toHaveBeenCalled()
+  })
+})

package/src/functions/__tests__/getConstructorProperties.test.ts

@@ -0,0 +1,51 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { getConstructorProperties } from '../getConstructorProperties'
+import { PropertiesFile } from '../../classes/Properties/PropertiesFile'
+import { hasNativeDirname } from '../hasNativeDirname'
+
+vi.mock('../../classes/Properties/PropertiesFile', () => ({
+  PropertiesFile: {
+    readFile: vi.fn()
+  }
+}))
+
+vi.mock('../hasNativeDirname', () => ({
+  hasNativeDirname: vi.fn()
+}))
+
+describe('getConstructorProperties', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should return properties for given constructor names', () => {
+    const mockItem = { some: 'property' }
+    vi.mocked(hasNativeDirname).mockReturnValue(true)
+    vi.mocked(PropertiesFile.readFile).mockReturnValue(mockItem)
+
+    const result = getConstructorProperties(['Button', 'Input'])
+
+    expect(result).toEqual({
+      Button: mockItem,
+      Input: mockItem
+    })
+    expect(PropertiesFile.readFile).toHaveBeenCalledTimes(2)
+  })
+
+  it('should return an empty object if no constructors found or error occurs', () => {
+    vi.mocked(hasNativeDirname).mockReturnValue(true)
+    vi.mocked(PropertiesFile.readFile).mockReturnValue(undefined)
+
+    const result = getConstructorProperties(['NonExistent'])
+
+    expect(result).toEqual({})
+  })
+
+  it('should handles non-native dirname environment', () => {
+    vi.mocked(hasNativeDirname).mockReturnValue(false)
+    vi.mocked(PropertiesFile.readFile).mockReturnValue({ status: 'ok' })
+
+    const result = getConstructorProperties(['Button'])
+    expect(result).toEqual({ Button: { status: 'ok' } })
+  })
+})

package/src/functions/__tests__/getDirname.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest'
+import { getDirname } from '../getDirname'
+import { hasNativeDirname } from '../hasNativeDirname'
+
+vi.mock('../hasNativeDirname', () => ({
+  hasNativeDirname: vi.fn()
+}))
+
+// We can't easily mock import.meta.url or __dirname globally in a way that affects the module internally without ESM tricks,
+// but we can at least test that it calls the right path based on hasNativeDirname
+describe('getDirname', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should return __dirname when hasNativeDirname is true', () => {
+    vi.mocked(hasNativeDirname).mockReturnValue(true)
+
+    // In a vitest environment with native support, __dirname should be defined
+    // We expect it to not throw and return a string
+    const result = getDirname()
+    expect(typeof result).toBe('string')
+  })
+
+  it('should return a path via fileURLToPath when hasNativeDirname is false', () => {
+    vi.mocked(hasNativeDirname).mockReturnValue(false)
+
+    const result = getDirname()
+    expect(typeof result).toBe('string')
+  })
+})