@dxtmisha/scripts 0.11.7 → 1.0.0

package/src/classes/Design/DesignUi.ts

@@ -1,143 +0,0 @@
-// export:none
-
-import { toCamelCaseFirst, toKebabCase } from '@dxtmisha/functional-basic'
-import { getPackageJson } from '../../functions/getPackageJson'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-import { PropertiesCache } from '../Properties/PropertiesCache'
-import { DesignComponent } from './DesignComponent'
-import { LibraryItems } from '../Library/LibraryItems'
-import { Styles } from '../Styles/Styles'
-
-import { DesignWiki } from './DesignWiki'
-
-import { LibraryAiWiki } from '../Library/LibraryAiWiki'
-import { LibraryMedia } from '../Library/LibraryMedia'
-import { LibraryList } from '../Library/LibraryList'
-import { LibraryPlugin } from '../Library/LibraryPlugin'
-import { LibraryTypes } from '../Library/LibraryTypes'
-
-import { UI_FILE_PACKAGE, UI_FILE_STYLE_PROPERTIES } from '../../config'
-
-/**
- * Orchestrator class for managing and initializing the Design System UI.
- * It coordinates the generation of styles, documentation, component structures, and library-level exports (media, plugins, types).
- *
- * Класс-оркестратор для управления и инициализации пользовательского интерфейса дизайн-системы.
- * Координирует генерацию стилей, документации, структур компонентов и экспортов на уровне библиотеки (медиа, плагины, типы).
- */
-export class DesignUi {
-  protected readonly components: LibraryItems
-
-  /**
-   * Constructor for DesignUi.
-   *
-   * Конструктор для DesignUi.
-   * @param name specific component name to initialize, or empty for all / название конкретного компонента для инициализации или пусто для всех
-   */
-  constructor(
-    protected readonly name: string = ''
-  ) {
-    this.components = new LibraryItems()
-  }
-
-  /**
-   * Returns the component name by its name.
-   *
-   * Возвращает название компонента по имени.
-   */
-  protected get component(): string {
-    return toKebabCase(this.name).trim()
-  }
-
-  /**
-   * Initialization of the component.
-   *
-   * Инициализация компоненты.
-   */
-  make(): void {
-    PropertiesCache.clear()
-
-    new Styles().make()
-    new DesignWiki().make()
-
-    this.makeConstructorComponent()
-      .makePackage()
-      .makeUiProperties()
-
-    new LibraryMedia(this.components).make()
-    new LibraryList(this.components).make()
-    new LibraryPlugin(this.components).make()
-    new LibraryAiWiki(this.components).make()
-    new LibraryTypes(this.components).make()
-  }
-
-  /**
-   * Creates or updates the list of components.
-   *
-   * Создает или обновляет список компонентов.
-   */
-  protected makeConstructorComponent(): this {
-    const componentDef = this.component
-
-    if (componentDef !== '') {
-      new DesignComponent(componentDef).make()
-    } else {
-      this.components.getComponentList()
-        .forEach((component) => {
-          console.log(`Component update: ${component.alias}`)
-
-          new DesignComponent(component.name).make()
-        })
-    }
-
-    return this
-  }
-
-  /**
-   * Updates the package.json file by adding export paths for UI styles and saves the changes.
-   *
-   * Обновляет файл package.json, добавляя пути экспорта для стилей UI, и сохраняет изменения.
-   */
-  protected makePackage(): this {
-    const packageJson = getPackageJson()
-    const projectName = toCamelCaseFirst(PropertiesConfig.getProjectName())
-
-    if (packageJson?.exports) {
-      packageJson.exports['.'] = {
-        types: './dist/library/types.d.ts',
-        default: './dist/types.js'
-      }
-      packageJson.exports['./plugin'] = {
-        types: './dist/library/plugin.d.ts',
-        default: './dist/plugin.js'
-      }
-      packageJson.exports['./media'] = {
-        types: './dist/library/media.d.ts',
-        default: './dist/media.js'
-      }
-      packageJson.exports['./style.css'] = './dist/style.css'
-      packageJson.exports['./style/ui.scss'] = `./src/styles/${projectName}/main.scss`
-      packageJson.exports['./ui-properties'] = {
-        sass: './ui-properties.scss',
-        default: './ui-properties.scss'
-      }
-      packageJson.exports['./types.d.ts'] = './dist/library/types.d.ts'
-      packageJson['web-types'] = './dist/web-types.json'
-
-      PropertiesFile.writeByPath(UI_FILE_PACKAGE, packageJson)
-    }
-
-    return this
-  }
-
-  protected makeUiProperties(): this {
-    PropertiesFile.writeByPath(
-      UI_FILE_STYLE_PROPERTIES,
-      '@forward "./src/styles/Ui/style.scss";'
-    )
-
-    return this
-  }
-}

package/src/classes/Design/DesignWiki.ts

@@ -1,52 +0,0 @@
-// export:none
-
-import { toCamelCaseFirst } from '@dxtmisha/functional-basic'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-
-import {
-  UI_DIRS_WIKI,
-  UI_FILE_NAME_WIKI
-} from '../../config'
-
-/**
- * Utility for managing and generating the central wiki configuration for the design system.
- * It ensures that the primary registry for storybook arguments and component descriptions is correctly initialized and synchronized with the project's design configuration.
- *
- * Утилита для управления и генерации центральной конфигурации вики для дизайн-системы.
- * Гарантирует, что основной реестр аргументов Storybook и описаний компонентов правильно инициализирован и синхронизирован с конфигурацией дизайна проекта.
- */
-export class DesignWiki {
-  /**
-   * Executes the initialization of the file with component descriptions for the wiki.
-   *
-   * Выполняет инициализацию файла с описанием компонентов для wiki.
-   */
-  make(): void {
-    this.initWikiFile()
-  }
-
-  /**
-   * Creates a file with component descriptions for the wiki.
-   *
-   * Создает файл с описанием компонентов для wiki.
-   */
-  protected initWikiFile(): void {
-    if (!PropertiesFile.is([...UI_DIRS_WIKI, `${UI_FILE_NAME_WIKI}.ts`])) {
-      const designName = PropertiesConfig.getDesignName()
-
-      PropertiesFile.write(
-        UI_DIRS_WIKI,
-        UI_FILE_NAME_WIKI,
-        [
-          'import type { StorybookArgsToList } from \'@dxtmisha/wiki\'',
-          '',
-          `export const wiki${toCamelCaseFirst(designName)}: StorybookArgsToList = {}`,
-          ''
-        ].join('\r\n'),
-        'ts'
-      )
-    }
-  }
-}

package/src/classes/Design/DesignWikiStorm.ts

@@ -1,95 +0,0 @@
-import { ServerStorage, toCamelCaseFirst } from '@dxtmisha/functional-basic'
-import { getPackageJson } from '../../functions/getPackageJson'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-import { LibraryItems } from '../Library/LibraryItems'
-import { DesignWikiStormItem } from './DesignWikiStormItem'
-
-import type { WebTypesVueComponentItem, WebTypesVueJson } from '../../types/webTypes'
-
-/**
- * Engine for generating `web-types.json` to provide rich metadata and IDE support (IntelliSense) for the design system components in JetBrains editors (IntelliJ IDEA, WebStorm).
- * It aggregates component tags, attributes, and events from the entire library and formats them into the standard Web-Types schema.
- *
- * Движок для генерации `web-types.json`, обеспечивающий расширенные метаданные и поддержку IDE (IntelliSense) для компонентов дизайн-системы в редакторах JetBrains (IntelliJ IDEA, WebStorm).
- * Он агрегирует теги компонентов, атрибуты и события из всей библиотеки и форматирует их в стандартную схему Web-Types.
- */
-export class DesignWikiStorm {
-  protected readonly components: LibraryItems
-
-  /**
-   * Constructor for DesignWikiStorm.
-   *
-   * Конструктор для DesignWikiStorm.
-   * @param dir target directory for saving the `web-types.json` file / целевая директория для сохранения файла `web-types.json`
-   */
-  constructor(
-    protected dir: string = 'dist'
-  ) {
-    ServerStorage.setErrorStatus(true)
-    this.components = new LibraryItems()
-  }
-
-  /**
-   * Generates the web-types.json file.
-   *
-   * Генерирует файл web-types.json.
-   */
-  async make(): Promise<void> {
-    const packageFile = getPackageJson()
-
-    console.log('[DesignWikiStorm] make')
-
-    if (packageFile) {
-      const data: WebTypesVueJson = {
-        '$schema': 'https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json',
-        'framework': 'vue',
-        'name': toCamelCaseFirst(PropertiesConfig.getDesignName()),
-        'version': packageFile.version,
-        'js-types-syntax': 'typescript',
-        'contributions': {
-          html: {
-            'description-markup': 'markdown',
-            'vue-components': await this.getComponents()
-          }
-        }
-      }
-
-      PropertiesFile.writeByPath(
-        [this.dir, 'web-types.json'],
-        data
-      )
-    }
-  }
-
-  /**
-   * Creates or updates the list of components.
-   *
-   * Создает или обновляет список компонентов.
-   */
-  protected async getComponents(): Promise<WebTypesVueComponentItem[]> {
-    const packageFile = getPackageJson()
-    const tags: WebTypesVueComponentItem[] = []
-
-    if (packageFile) {
-      for (const component of this.components.getComponentList()) {
-        const item = new DesignWikiStormItem(
-          packageFile.name,
-          this.components.getComponentsPath(),
-          component
-        )
-
-        await item.init()
-
-        const tag = await item.get()
-
-        if (tag) {
-          tags.push(tag as any)
-        }
-      }
-    }
-
-    return tags
-  }
-}

package/src/classes/Design/DesignWikiStormItem.ts

@@ -1,316 +0,0 @@
-import { toCamelCaseFirst } from '@dxtmisha/functional'
-import { type WikiDataItem, WikiStorybook, WikiStorybookProp } from '@dxtmisha/wiki'
-import { wiki, wikiDescriptions } from '@dxtmisha/wiki/media'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-
-import type { LibraryData } from '../../types/libraryTypes'
-import type { WebTypesVueComponentItem, WebTypesPropItem, WebTypesSlots, WebTypesEventItem, WebTypesProperty } from '../../types/webTypes'
-import { forEach } from '@dxtmisha/functional-basic'
-
-/**
- * List of basic types that do not need to be wrapped in quotes for web-types/
- * Список базовых типов, которые не нужно оборачивать в кавычки для web-types
- */
-const BASE_TYPES = /^(boolean|number|string|null|any|void|object|unknown|never)$/
-
-/**
- * Resolver for extracting and formatting IDE metadata for a specific component.
- * It coordinates the transformation of Storybook-specific wiki data into JetBrains Web-Types tag and attribute definitions.
- *
- * Резолвер для извлечения и форматирования метаданных IDE для конкретного компонента.
- * Координирует преобразование данных вики для Storybook в определения тегов и атрибутов JetBrains Web-Types.
- */
-export class DesignWikiStormItem {
-  protected wiki?: WikiStorybook
-  protected dataComponent?: WikiDataItem
-
-  /**
-   * Constructor for DesignWikiStormItem.
-   *
-   * Конструктор для DesignWikiStormItem.
-   * @param project name of the project for module mapping / имя проекта для маппинга модулей
-   * @param path array of directory path segments to the component / массив сегментов пути к директории компонента
-   * @param data component metadata from the library / метаданные компонента из библиотеки
-   */
-  constructor(
-    protected readonly project: string,
-    protected readonly path: string[],
-    protected readonly data: LibraryData
-  ) {
-  }
-
-  /**
-   * Returns the tag definition for web-types.
-   *
-   * Возвращает определение тега для web-types.
-   */
-  async get(): Promise<WebTypesVueComponentItem | undefined> {
-    if (this.wiki) {
-      const name = `${toCamelCaseFirst(PropertiesConfig.getDesignName())}${this.wiki.getName()}`
-
-      const component: WebTypesVueComponentItem = {
-        name,
-        description: this.wiki.getDescription(),
-        source: {
-          module: `${this.project}/${name}`,
-          symbol: name
-        },
-        props: this.getProps()
-      }
-
-      const slots = await this.getSlots()
-
-      if (slots) {
-        component.slots = slots
-      }
-
-      const events = await this.getEvents()
-
-      if (events && events.length > 0) {
-        component.js = {
-          events
-        }
-      }
-
-      return component
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the prop definition.
-   *
-   * Возвращает определение свойства.
-   * @param item prop item / элемент свойства
-   */
-  getProp(item: WikiStorybookProp): WebTypesPropItem {
-    const type = this.prepareType(item.getType())
-    const cleaned = type ? this.cleanType(type) : undefined
-    return {
-      name: item.getName(),
-      description: item.getDescription(),
-      default: item.getDefaultValue() ?? undefined,
-      type: cleaned
-    }
-  }
-
-  /**
-   * Returns a list of props.
-   *
-   * Возвращает список свойств.
-   */
-  getProps(): WebTypesPropItem[] {
-    const props: WebTypesPropItem[] = []
-
-    if (this.wiki) {
-      this.wiki.getWikiObject()
-        .forEach(
-          item => props.push(this.getProp(item))
-        )
-    }
-
-    return props
-  }
-
-  /**
-   * Returns a list of slots.
-   *
-   * Возвращает список слотов.
-   */
-  async getSlots(): Promise<WebTypesSlots | undefined> {
-    const data = await this.getData()
-
-    if (data && data.slots) {
-      const slots: WebTypesSlots = []
-
-      data.slots.forEach(
-        (slot) => {
-          const vueProperties: WebTypesProperty[] = (slot.properties ?? []).map(p => ({
-            name: p.name,
-            type: p.type ? this.cleanType(p.type) : undefined,
-            description: p.description
-          }))
-
-          slots.push({
-            'name': slot.name,
-            'description': slot.description,
-            'vue-properties': vueProperties
-          })
-        }
-      )
-
-      return slots
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns a list of events.
-   *
-   * Возвращает список событий.
-   */
-  async getEvents(): Promise<WebTypesEventItem[] | undefined> {
-    const data = await this.getData()
-
-    if (data && data.events) {
-      const events: WebTypesEventItem[] = []
-
-      data.events.forEach(
-        (event) => {
-          let typeString = '() => void'
-          if (event.properties && event.properties.length > 0) {
-            const args = event.properties
-              .map(p => `${p.name}: ${p.type ? this.cleanType(p.type) : 'any'}`)
-              .join(', ')
-            typeString = `(${args}) => void`
-          }
-
-          events.push({
-            name: event.name,
-            description: event.description,
-            type: typeString
-          })
-        }
-      )
-
-      return events
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the directory name.
-   *
-   * Возвращает имя директории.
-   */
-  getDirName() {
-    return this.data.dir
-  }
-
-  /**
-   * Initializes the class.
-   *
-   * Инициализирует класс.
-   */
-  async init(): Promise<this> {
-    this.wiki = await this.initWiki()
-    return this
-  }
-
-  /**
-   * Gets data from wikiData.ts.
-   *
-   * Получает данные из wikiData.ts.
-   */
-  protected async getData(): Promise<WikiDataItem | undefined> {
-    if (!this.dataComponent) {
-      const filePath = this.getPaths(['wikiData.ts'])
-
-      if (PropertiesFile.is(filePath)) {
-        try {
-          const wiki: Record<string, any> = await import(filePath.join('/'))
-          this.dataComponent = Object.values(wiki).find(item => 'component' in item)
-        } catch (error) {
-          console.error(filePath, error)
-        }
-      }
-    }
-
-    return this.dataComponent
-  }
-
-  /**
-   * Returns the list of directories.
-   *
-   * Возвращает список директорий.
-   */
-  protected getDirs(): string[] {
-    return [
-      '.',
-      ...this.path,
-      this.getDirName()
-    ]
-  }
-
-  /**
-   * Returns the full path to the file.
-   *
-   * Возвращает полный путь к файлу.
-   * @param paths path segments / сегменты пути
-   */
-  protected getPaths(paths: string[]): string[] {
-    return [
-      ...this.getDirs(),
-      ...paths
-    ]
-  }
-
-  /**
-   * Formats a type string for web-types.
-   *
-   * Форматирует строку типа для web-types.
-   * @param type original type string / исходная строка типа
-   */
-  protected prepareType(type?: string): string | undefined {
-    if (type) {
-      return forEach(
-        type.split('|'),
-        (item) => {
-          const trimmed = item.trim()
-
-          if (trimmed === 'undefined') {
-            return undefined
-          }
-
-          if (BASE_TYPES.test(trimmed)) {
-            return trimmed
-          }
-
-          return `'${trimmed}'`
-        }
-      )
-        .join(' | ')
-    }
-
-    return type
-  }
-
-  /**
-   * Cleans a type string by removing redundant parentheses, e.g., (CellClassesSub) | undefined -> CellClassesSub | undefined
-   *
-   * Очищает строку типа, удаляя лишние скобки, например: (CellClassesSub) | undefined -> CellClassesSub | undefined
-   */
-  protected cleanType(type: string): string {
-    return type
-      .replace(/^\(([^()]+)\)$/, '$1')
-      .replace(/^\(([^()]+)\)\s*\|\s*undefined$/, '$1 | undefined')
-      .trim()
-  }
-
-  /**
-   * Initializes the wiki object.
-   *
-   * Инициализирует объект wiki.
-   */
-  protected async initWiki(): Promise<WikiStorybook | undefined> {
-    const data = await this.getData()
-
-    if (data) {
-      return new WikiStorybook(
-        data.component,
-        data.props,
-        data.defaults,
-        data.wikiDesign,
-        wiki,
-        wikiDescriptions
-      )
-    }
-
-    return undefined
-  }
-}