@dxtmisha/scripts 0.11.8 → 1.0.0

package/src/classes/Library/LibraryList.ts

@@ -1,189 +0,0 @@
-import { LibraryItems } from './LibraryItems'
-
-import { forEach, toCamelCase, toKebabCase, uniqueArray } from '@dxtmisha/functional-basic'
-import { getPackageJson } from '../../functions/getPackageJson'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-
-import { UI_DIRS_STYLES, UI_FILE_NAME_DESIGN } from '../../config'
-
-/**
- * Class for generating the design system overview file, including component imports and regular expressions.
- *
- * Класс для создания обзорного файла дизайн-системы, включая импорты компонентов и регулярные выражения.
- */
-export class LibraryList {
-  protected readonly packageName: string
-
-  /**
-   * Constructor for LibraryList.
-   *
-   * Конструктор для LibraryList.
-   * @param items object for working with the list of components / объект для работы со списком компонентов
-   */
-  constructor(
-    protected readonly items: LibraryItems
-  ) {
-    this.packageName = getPackageJson()?.name
-  }
-
-  /**
-   * Creates the design system overview file (`design.ts`) with metadata and component lists.
-   *
-   * Создает обзорный файл дизайн-системы (`design.ts`) с метаданными и списками компонентов.
-   * @returns this
-   */
-  make(): this {
-    const list = this.getComponents()
-    const listReg = this.getComponentsReg()
-
-    this.items.write(
-      UI_FILE_NAME_DESIGN,
-      [
-        'import type { PluginComponentImports } from \'@dxtmisha/constructor/plugin\'',
-        '',
-        `// count: ${this.items.getCount()}`,
-        `export const designName: string = '${PropertiesConfig.getDesignName()}'`,
-        `export const packageName: string = '${this.packageName}'`,
-        `export const componentsReg: RegExp = ${listReg}`,
-        `export const styleVarsReg: RegExp = ${this.getVarsReg()}`,
-        '',
-        'export const componentsList: PluginComponentImports = [',
-        list.join(',\r\n'),
-        ']'
-      ]
-    )
-
-    return this
-  }
-
-  /**
-   * Returns a list of components for the file.
-   *
-   * Возвращает список компонентов для файла.
-   */
-  protected getComponents(): string[] {
-    const list: string[] = []
-
-    if (this.packageName) {
-      forEach(
-        this.items.getComponentList(),
-        (item) => {
-          list.push(`  {
-    name: '${item.codeFull}',
-    reg: ${this.getReg([item.name], true)}
-  }`
-          )
-        })
-    }
-
-    return list
-  }
-
-  /**
-   * Returns a regular expression for all components.
-   *
-   * Возвращает регулярное выражение для всех компонентов.
-   */
-  protected getComponentsReg(): string {
-    const names: string[] = forEach(
-      this.items.getComponentList(),
-      item => item.name
-    )
-
-    return this.getReg(names)
-  }
-
-  /**
-   * Returns a list of design names.
-   *
-   * Возвращает список названий дизайнов.
-   */
-  protected getDesigns(): string[] {
-    return [
-      PropertiesConfig.getDesignName(),
-      ...(PropertiesConfig.getDesignAlternativeName() ?? [])
-    ]
-  }
-
-  /**
-   * Generates a regular expression for the list of names.
-   *
-   * Генерирует регулярное выражение для списка имен.
-   * @param names list of names / список имен
-   * @param only exact match / точное совпадение
-   */
-  protected getReg(
-    names: string[],
-    only: boolean = false
-  ): string {
-    const designs = this.getDesigns().join('|')
-    const namesReg = this.getRegName(names)
-    let code = `((${designs})-?(${namesReg}))`
-
-    if (only) {
-      code = `^${code}$`
-    } else {
-      code = `${code}(?![\\w-])`
-    }
-
-    return `/${code}/ig`
-  }
-
-  /**
-   * Formats names for regular expression.
-   *
-   * Форматирует имена для регулярного выражения.
-   * @param names list of names / список имен
-   */
-  protected getRegName(names: string[]): string {
-    return forEach(
-      names,
-      name => toKebabCase(name)
-        .replace('-', '-?')
-    ).join('|')
-  }
-
-  /**
-   * Returns a list of CSS variables.
-   *
-   * Возвращает список CSS переменных.
-   */
-  protected getVars(): string[] {
-    const design: string = toCamelCase(PropertiesConfig.getDesignName())
-    const path = [...UI_DIRS_STYLES, PropertiesConfig.getProjectName(), 'vars.scss']
-    const context = PropertiesFile.readFileOnly(path)
-    const data: string[] = []
-
-    if (context) {
-      const vars = context.match(/(?<=--)[^: ]+(?=:)/g)
-
-      if (vars) {
-        vars.forEach((varName) => {
-          const value = varName.match(/^([^-]+)-(.*?)$/)
-
-          if (
-            value
-            && value?.[1] === design
-            && value?.[2]
-          ) {
-            const varName = value[2].split('-')
-
-            if (varName.length > 2) {
-              varName.pop()
-            }
-
-            data.push(varName.join('-'))
-          }
-        })
-      }
-    }
-
-    return uniqueArray(data)
-  }
-
-  protected getVarsReg(): string {
-    return `/(?<=var\\(--)(${this.getVars().join('|')})/ig`
-  }
-}

package/src/classes/Library/LibraryMedia.ts

@@ -1,139 +0,0 @@
-// export:none
-
-import { toCamelCase, toCamelCaseFirst } from '@dxtmisha/functional-basic'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-
-import { LibraryItems } from './LibraryItems'
-
-import { UI_DIRS_ICONS, UI_FILE_NAME_MEDIA, UI_FILE_NAME_STYLE } from '../../config'
-import type { LibraryIconItem } from '../../types/libraryTypes'
-
-/**
- * Class for generating connection files for media data (primarily icons) and style entry points.
- *
- * Класс для формирования файлов подключения медиа-данных (прежде всего иконок) и точек входа стилей.
- */
-export class LibraryMedia {
-  /**
-   * Constructor for LibraryMedia.
-   *
-   * Конструктор для LibraryMedia.
-   * @param items object for working with the list of components / объект для работы со списком компонентов
-   */
-  constructor(
-    protected readonly items: LibraryItems
-  ) {
-  }
-
-  /**
-   * Generates media connection files and style entries.
-   *
-   * Генерирует файлы подключения медиа и записи стилей.
-   */
-  make(): void {
-    const projectName = toCamelCaseFirst(PropertiesConfig.getProjectName())
-    const name = toCamelCase(PropertiesConfig.getDesignName())
-    const isIcons = this.getIconImport().length > 0
-
-    if (isIcons) {
-      this.items.write(
-        UI_FILE_NAME_MEDIA,
-        [
-          'import { Icons } from \'@dxtmisha/functional\'',
-          '',
-          ...this.initIconImport(),
-          '',
-          `export const ${name}MakeIcons = (): void => {`,
-          ...this.initIcon(),
-          '}'
-        ]
-      )
-    }
-
-    this.items.write(
-      UI_FILE_NAME_STYLE,
-      [
-        `import '../styles/${projectName}/main.scss'`
-      ]
-    )
-  }
-
-  /**
-   * Returns the list of available icons.
-   *
-   * Возвращает список доступных иконок.
-   */
-  private getIconImport() {
-    const data: LibraryIconItem[] = []
-    const path = [PropertiesFile.getRoot(), ...UI_DIRS_ICONS]
-
-    if (PropertiesFile.is(path)) {
-      PropertiesFile
-        .readDirRecursive(path)
-        .forEach((iconPath) => {
-          const icon = iconPath.replace('/', '-')
-
-          data.push({
-            name: toCamelCase(this.getIconName(icon)),
-            path: this.getIconPath(iconPath),
-            value: this.getIconName(icon)
-          })
-        })
-    }
-
-    return data
-  }
-
-  /**
-   * Returns the icon name.
-   *
-   * Возвращает название иконки.
-   * @param icon icon name/ название иконки
-   */
-  private getIconName(icon: string): string {
-    return icon
-      .replace(/\.[^.]+$/, '')
-  }
-
-  /**
-   * Returns the path to the icon.
-   *
-   * Возвращает путь к иконке.
-   * @param icon icon name/ название иконки
-   */
-  private getIconPath(icon: string): string {
-    return PropertiesFile.joinPath(['.', '..', '..', ...UI_DIRS_ICONS, icon])
-  }
-
-  /**
-   * Generates the code to add the icon.
-   *
-   * Создаёт код для добавления иконки.
-   */
-  private initIcon(): string[] {
-    const data: string[] = []
-
-    this.getIconImport().forEach((item) => {
-      data.push(`  Icons.add('${item.value}', ${item.name})`)
-    })
-
-    return data
-  }
-
-  /**
-   * Generates the code to connect the icon.
-   *
-   * Создаёт код для подключения иконки.
-   */
-  private initIconImport(): string[] {
-    const data: string[] = []
-
-    this.getIconImport().forEach((item) => {
-      data.push(`const ${item.name} = async () => (await import('${item.path}'))?.default`)
-    })
-
-    return data
-  }
-}

package/src/classes/Library/LibraryPlugin.ts

@@ -1,73 +0,0 @@
-import { toCamelCaseFirst, toKebabCase } from '@dxtmisha/functional-basic'
-
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { LibraryItems } from './LibraryItems'
-
-import { UI_FILE_NAME_PLUGIN } from '../../config'
-
-/**
- * Class for creating a plugin file for the design system.
- *
- * Класс для создания файла плагина для дизайн-системы.
- */
-export class LibraryPlugin {
-  /**
-   * Constructor for LibraryPlugin.
-   *
-   * Конструктор для LibraryPlugin.
-   * @param items object for working with the list of components / объект для работы со списком компонентов
-   */
-  constructor(
-    protected readonly items: LibraryItems
-  ) {
-  }
-
-  /**
-   * Creates a plugin file that initializes the Vite plugin for the library.
-   *
-   * Создает файл плагина, который инициализирует плагин Vite для библиотеки.
-   * @returns this
-   */
-  make(): this {
-    const design = PropertiesConfig.getDesignName()
-
-    this.items.write(
-      UI_FILE_NAME_PLUGIN,
-      [
-        'import type { Plugin as VitePlugin } from \'vite\'',
-        'import { type PluginOptions, Plugin } from \'@dxtmisha/constructor/plugin\'',
-        '',
-        'import {',
-        '  componentsList,',
-        '  componentsReg,',
-        '  designName,',
-        '  packageName,',
-        '  styleVarsReg',
-        '} from \'./design\'',
-        '',
-        '/**',
-        ' * Initializes the Vite plugin for the design system.',
-        ' *',
-        ' * Инициализирует плагин Vite для дизайн-системы.',
-        ' * @param options plugin options / настройки плагина',
-        ' */',
-        `export function ui${toCamelCaseFirst(design)}VitePlugin(`,
-        '  options: PluginOptions = {}',
-        '): VitePlugin {',
-        '  return new Plugin(',
-        '    designName,',
-        '    packageName,',
-        '    componentsReg,',
-        '    styleVarsReg,',
-        '    componentsList,',
-        `    'vite-plugin-${toKebabCase(design)}-ui',`,
-        '    options',
-        '  )',
-        '    .init()',
-        '}'
-      ]
-    )
-
-    return this
-  }
-}

package/src/classes/Library/LibraryTypes.ts

@@ -1,130 +0,0 @@
-import { PropertiesConfig } from '../Properties/PropertiesConfig'
-import { LibraryItems } from './LibraryItems'
-
-import type { LibraryData } from '../../types/libraryTypes'
-
-/**
- * Class for generating global type definitions for Vue components.
- *
- * Класс для создания глобальных определений типов для компонентов Vue.
- */
-export class LibraryTypes {
-  /**
-   * Constructor for LibraryTypes.
-   *
-   * Конструктор для LibraryTypes.
-   * @param items object for working with the list of components / объект для работы со списком компонентов
-   */
-  constructor(
-    protected readonly items: LibraryItems
-  ) {
-  }
-
-  /**
-   * Creates the type definition file (`types.d.ts`) for global Vue components.
-   *
-   * Создает файл определений типов (`types.d.ts`) для глобальных компонентов Vue.
-   */
-  make(): void {
-    this.items.write(
-      'types',
-      [
-        // 'import { type App } from \'vue\'',
-        ...this.initImports(),
-        // '',
-        // 'export const components = {',
-        // this.initExports(),
-        // '}',
-        // '',
-        // 'export const useVueComponentsPlugin = {',
-        // '  install: async (app: App) => {',
-        // ...this.initIncludeVueComponents(),
-        // '  }',
-        // '}',
-        '',
-        'declare module \'@vue/runtime-core\' {',
-        '  export interface GlobalComponents {',
-        ...this.initGlobalComponentsVue(),
-        '  }',
-        '}'
-      ]
-    )
-  }
-
-  /**
-   * Returns the path to the component.
-   *
-   * Возвращает путь к компоненту.
-   * @param component component data / данные компонента
-   */
-  protected getPathComponent(component: LibraryData): string {
-    return `../components/${PropertiesConfig.getProjectName()}/${component.dir}`
-  }
-
-  /**
-   * Returns a list of imports for the file.
-   *
-   * Возвращает список импортов для файла.
-   */
-  protected initImports(): string[] {
-    const list: string[] = []
-
-    this.items.getComponentList()
-      .forEach((component) => {
-        list.push(
-          `import _${component.codeFull} from '${this.getPathComponent(component)}/${component.codeFull}.vue'`
-        )
-      })
-
-    return list
-  }
-
-  /**
-   * Returns a list of exports for the file.
-   *
-   * Возвращает список экспортов для файла.
-   */
-  protected initExports(): string {
-    const list: string[] = []
-
-    this.items.getComponentList()
-      .forEach((component) => {
-        list.push(
-          `  ${component.codeFull}: _${component.codeFull}`
-        )
-      })
-
-    return list.join(',\r\n')
-  }
-
-  protected initIncludeVueComponents(): string[] {
-    const list: string[] = []
-
-    this.items.getComponentList()
-      .forEach((component) => {
-        list.push(
-          `    app.component('${component.codeFull}', _${component.codeFull})`
-        )
-      })
-
-    return list
-  }
-
-  /**
-   * Returns a list of global components for Vue.
-   *
-   * Возвращает список глобальных компонентов для Vue.
-   */
-  protected initGlobalComponentsVue(): string[] {
-    const list: string[] = []
-
-    this.items.getComponentList()
-      .forEach((component) => {
-        list.push(
-          `    ${component.codeFull}: typeof _${component.codeFull}`
-        )
-      })
-
-    return list
-  }
-}

package/src/classes/Package/PackageFile.ts

@@ -1,154 +0,0 @@
-import { toArray } from '@dxtmisha/functional-basic'
-import { PropertiesFile } from '../Properties/PropertiesFile'
-import { UI_FILE_PACKAGE } from '../../config'
-
-/**
- * Class for working with the package.json file.
- *
- * Класс для работы с файлом package.json.
- */
-export class PackageFile {
-  protected readonly data?: Record<string, any>
-
-  /**
-   * Constructor
-   * @param path path to the directory containing package.json / путь к директории, содержащей package.json
-   */
-  constructor(
-    protected readonly path: string | string[]
-  ) {
-    if (this.is()) {
-      this.data = PropertiesFile.readFile(this.getPath()) ?? {}
-    }
-  }
-
-  /**
-   * Checks if the directory is a package (contains package.json).
-   *
-   * Проверяет, является ли директория пакетом (содержит package.json).
-   */
-  is(): boolean {
-    return PropertiesFile.is(this.getPath())
-  }
-
-  /**
-   * Checks if the package version matches the specified version.
-   *
-   * Проверяет, соответствует ли версия пакета указанной версии.
-   * @param version version to compare with / версия для сравнения
-   */
-  isVersionConsistency(version?: string): boolean {
-    return Boolean(version) && this.getVersion() === version
-  }
-
-  /**
-   * Checks if the package is a test package.
-   *
-   * Проверяет, является ли пакет тестовым.
-   */
-  isTest(): boolean {
-    return this.get()?.['ui-test'] === true
-  }
-
-  /**
-   * Checks if the package should not be published.
-   *
-   * Проверяет, не должен ли пакет публиковаться.
-   */
-  isNoPublish(): boolean {
-    const data = this.get()
-    return data?.['ui-no-publish'] === true || data?.private === true
-  }
-
-  /**
-   * Returns the package data.
-   *
-   * Возвращает данные пакета.
-   */
-  get(): Record<string, any> {
-    return this.data ?? {}
-  }
-
-  /**
-   * Returns the package name.
-   *
-   * Возвращает имя пакета.
-   */
-  getName(): string {
-    return this.get()?.name ?? PropertiesFile.joinPath(this.getDir())
-  }
-
-  /**
-   * Returns the package version.
-   *
-   * Возвращает версию пакета.
-   */
-  getVersion(): string {
-    return this.get()?.version ?? '0.0.0'
-  }
-
-  /**
-   * Returns the package scripts.
-   *
-   * Возвращает скрипты пакета.
-   */
-  getScripts(): Record<string, string> {
-    return this.get()?.scripts ?? {}
-  }
-
-  /**
-   * Returns the package directory path segments.
-   *
-   * Возвращает сегменты пути к директории пакета.
-   */
-  getDir(): string[] {
-    return toArray(this.path)
-  }
-
-  /**
-   * Returns the package path.
-   *
-   * Возвращает путь к пакету.
-   */
-  getPath(): string[] {
-    return [...this.getDir(), UI_FILE_PACKAGE]
-  }
-
-  /**
-   * Returns the command name for build or build-recovery.
-   *
-   * Возвращает название команды для build или build-recovery.
-   */
-  getCodeBuildOrRecovery(): string | undefined {
-    const scripts = this.getScripts()
-
-    if ('prepublishOnly' in scripts) {
-      return 'prepublishOnly'
-    }
-
-    if ('build-recovery' in scripts) {
-      return 'build-recovery'
-    }
-
-    if ('build' in scripts) {
-      return 'build'
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the command name for publish or publish-to-npm.
-   *
-   * Возвращает название команды для publish или publish-to-npm.
-   */
-  getCodePublish(): string {
-    const scripts = this.getScripts()
-
-    if ('publish-to-npm' in scripts) {
-      return 'npm run publish-to-npm'
-    }
-
-    return 'npm publish --access public'
-  }
-}