@dxtmisha/scripts 0.11.8 → 1.0.0

package/src/classes/Properties/PropertiesFile.ts

@@ -1,522 +0,0 @@
-import requireFs from 'node:fs'
-import requirePath from 'node:path'
-import { fileURLToPath } from 'node:url'
-import { Datetime, forEach, toArray, toKebabCase, transformation } from '@dxtmisha/functional-basic'
-import { hasNativeDirname } from '../../functions/hasNativeDirname'
-
-import { UI_FILE_INDEX, UI_MODULES, UI_PROJECT_NAME } from '../../config'
-
-export type PropertiesFilePath = string | string[]
-export type PropertiesFileValue<T = any> = string | Record<string, T> | Buffer
-
-const dirnamePath = hasNativeDirname() ? __dirname : requirePath.dirname(fileURLToPath(import.meta.url))
-
-/**
- * Universal static utility for filesystem orchestration.
- * This class provides a standardized interface for all IO operations within the design system, including path normalization, recursive directory traversal, synchronized file reading/writing, and metadata retrieval. It abstracts platform-specific path differences and ensures consistent data handling across the toolchain.
- *
- * Универсальная статическая утилита для оркестрации файловой системы.
- * Этот класс предоставляет стандартизированный интерфейс для всех операций ввода-вывода в рамках дизайн-системы, включая нормализацию путей, рекурсивный обход директорий, синхронное чтение/запись файлов и получение метаданных. Он абстрагирует различия путей в разных ОС и обеспечивает согласованную обработку данных во всей цепочке инструментов.
- */
-export class PropertiesFile {
-  protected static root: string
-  protected static module: boolean
-
-  /**
-   * Synchronously checks for the existence of a file or directory at the specified path.
-   *
-   * Синхронно проверяет существование файла или директории по указанному пути.
-   * @param path target filesystem path to verify / целевой путь в файловой системе для проверки
-   */
-  static is(path: PropertiesFilePath): boolean {
-    return requireFs.existsSync(this.joinPath(path))
-  }
-
-  /**
-   * Determines if the specified path points to a directory.
-   *
-   * Определяет, указывает ли указанный путь на директорию.
-   * @param path path to the filesystem element / путь к элементу файловой системы
-   */
-  static isDir(path: PropertiesFilePath): boolean {
-    if (this.is(path)) {
-      return requireFs.statSync(this.joinPath(path))?.isDirectory() ?? false
-    }
-
-    return !this.joinPath(path).match(/\.\w+$/)
-  }
-
-  /**
-   * Determines whether the package is connected as a module.
-   *
-   * Определяет, является ли пакет подключенным как модуль.
-   */
-  static isModule(): boolean {
-    return this.module
-  }
-
-  /**
-   * Joins multiple path segments into a single normalized path string using the OS separator.
-   *
-   * Объединяет несколько сегментов пути в одну нормализованную строку пути, используя разделитель ОС.
-   * @param path array or string of path segments / массив или строка сегментов пути
-   */
-  static joinPath(path: PropertiesFilePath): string {
-    const pathArray = forEach(
-      toArray(path),
-      item => this.toSep(item)
-    ) as string[]
-
-    return requirePath.join(...pathArray)
-  }
-
-  /**
-   * Getting the path to the file by its name and the path to the directory.
-   *
-   * Получение пути к файлу по его названию и пути к директории.
-   * @param path path to the file/ путь к файлу
-   * @param name file name/ название файла
-   * @param extension file extension by default is json/ расширение файла по умолчанию - json
-   */
-  static joinPathByName(
-    path: PropertiesFilePath,
-    name: string,
-    extension = 'json'
-  ): string {
-    return this.joinPath([...toArray(path), this.getFileName(name, extension)])
-  }
-
-  /**
-   * Returns the root path.
-   *
-   * Возвращает корневой путь.
-   */
-  static getRoot(): string {
-    return this.root
-  }
-
-  /**
-   * Returns the root project path
-   *
-   * Возвращает корневой путь проекта
-   * @param rootProject root project path/ путь к корневому проекту
-   * @param maxDepth maximum depth of search for the root project/ максимальная глубина поиска корневого проекта
-   */
-  static getRootProject(
-    rootProject: string = this.root,
-    maxDepth: number = 10
-  ): string | undefined {
-    const path = this.joinPath([rootProject, UI_MODULES, UI_PROJECT_NAME])
-
-    if (this.readDir(path).length > 0) {
-      return path
-    } else if (
-      rootProject.match(requirePath.sep)
-      && maxDepth > 0
-    ) {
-      return this.getRootProject(
-        rootProject.replace(/\/[^/]+$/, ''),
-        maxDepth - 1
-      )
-    }
-
-    return undefined
-  }
-
-  static getDirname(): string {
-    return dirnamePath
-  }
-
-  /**
-   * Returns the file name.
-   *
-   * Возвращает имя файла.
-   * @param name element name/ название элемента
-   * @param extension file extension by default is json/ расширение файла по умолчанию - json
-   */
-  static getFileName(
-    name: string,
-    extension = 'json'
-  ): string {
-    if (extension && extension !== '') {
-      return `${toKebabCase(name)}.${extension}`
-    } else {
-      return name
-    }
-  }
-
-  /**
-   * Returns the path to the directory, removing the file name from the path.
-   *
-   * Возвращает путь к директории, убрав название файла из пути.
-   * @param path path to the file/ путь к файлу
-   */
-  static getPathDir(path: PropertiesFilePath): string {
-    if (this.isDir(path)) {
-      return this.joinPath(path)
-    } else {
-      return requirePath.dirname(this.joinPath(path))
-    }
-  }
-
-  /**
-   * Returns the path to the file.
-   *
-   * Возвращает путь к файлу.
-   * @param path path to the file/ путь к файлу
-   * @param name element name/ название элемента
-   * @param extension file extension by default is json/ расширение файла по умолчанию - json
-   */
-  static getPathFile(
-    path: PropertiesFilePath,
-    name: string,
-    extension = 'json'
-  ): string[] {
-    return [...toArray(path), this.getFileName(name, extension)]
-  }
-
-  /**
-   * The method splits the path into an array of components.
-   *
-   * Метод разбивает путь на массив компонентов.
-   * @param path path to the directory/ путь к директории
-   */
-  static splitForDir(path: PropertiesFilePath): string[] {
-    const dir = this.isDir(path) ? path : this.parse(path)?.dir
-    return (this.joinPath(dir || '')).split(requirePath.sep)
-  }
-
-  /**
-   * Method returns an object whose properties represent significant elements of the path.
-   *
-   * Метод возвращает объект, свойства которого представляют существенные элементы пути.
-   * @param path filename/ имя файла
-   */
-  static parse(path: PropertiesFilePath): requirePath.ParsedPath {
-    return requirePath.parse(this.joinPath(path))
-  }
-
-  /**
-   * Returns the directory separator symbol.
-   *
-   * Возвращает символ разделителя директории.
-   */
-  static sep(): string {
-    return requirePath.sep
-  }
-
-  /**
-   * Getting information about the file.
-   *
-   * Получение информации о файле.
-   * @param path path to the file/ путь к файлу
-   */
-  static stat(path: PropertiesFilePath): requireFs.Stats | undefined {
-    if (this.is(path)) {
-      return { ...requireFs.statSync(this.joinPath(path)) }
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the time the file was last modified.
-   *
-   * Возвращает время последнего изменения файла.
-   * @param path path to the file/ путь к файлу
-   */
-  static getTime(path: PropertiesFilePath): string | undefined {
-    return new Datetime(this.stat(path)?.mtimeMs, 'full').standard()
-  }
-
-  /**
-   * Converts the path to use the current OS separator.
-   *
-   * Преобразует путь для использования текущего разделителя ОС.
-   * @param path path to the directory/ путь к директории
-   */
-  static toSep(path: string): PropertiesFilePath {
-    const sep = this.sep()
-
-    if (sep === '/') {
-      return path
-    }
-
-    return path.replace('/', this.sep())
-  }
-
-  /**
-   * Reads the contents of the directory.
-   *
-   * Читает содержимое директории.
-   * @param path path to the directory/ путь к директории
-   */
-  static readDir(path: PropertiesFilePath): string[] {
-    return this.is(path) ? requireFs.readdirSync(this.joinPath(path)) : []
-  }
-
-  /**
-   * Reads the contents of the directory recursively.
-   *
-   * Читает содержимое директории рекурсивно.
-   * @param path path to the directory/ путь к директории
-   */
-  static readDirRecursive(
-    path: PropertiesFilePath
-  ): string[] {
-    return this
-      .readDirAndFileRecursive(path)
-      .filter(paths => !this.isDir(paths))
-  }
-
-  /**
-   * Reads the contents of the directory recursively.
-   *
-   * Читает содержимое директории рекурсивно.
-   * @param path path to the directory/ путь к директории
-   */
-  static readDirRecursiveWithIndex(
-    path: PropertiesFilePath
-  ): string[] {
-    return this
-      .readDirAndFileRecursive(path, undefined, true)
-      .filter(paths => !this.isDir(paths))
-  }
-
-  /**
-   * Reads only directories recursively.
-   *
-   * Читает только директории рекурсивно.
-   * @param path path to the directory/ путь к директории
-   */
-  static readDirOnlyRecursive(
-    path: PropertiesFilePath
-  ): string[] {
-    return this
-      .readDirAndFileRecursive(path)
-      .filter(paths => this.isDir(paths))
-  }
-
-  /**
-   * Reads the contents of the directory and files recursively.
-   *
-   * Читает содержимое директории и файлы рекурсивно.
-   * @param path path to the directory/ путь к директории
-   * @param fullPath full path for recursion/ полный путь для рекурсии
-   * @param isIndex whether to include the root directory in the list/ включать ли корневую директорию в список
-   */
-  static readDirAndFileRecursive(
-    path: PropertiesFilePath,
-    fullPath: PropertiesFilePath = [],
-    isIndex: boolean = false
-  ): string[] {
-    const dirs = this.readDir(path)
-    const data: string[] = []
-
-    dirs.forEach((dir) => {
-      const paths = [...toArray(path), dir]
-      const fullPaths = [...fullPath, dir]
-
-      data.push(this.joinPath(fullPaths))
-
-      if (this.isDir(paths)) {
-        if (
-          isIndex
-          && this.is([...paths, UI_FILE_INDEX])
-        ) {
-          data.push(this.joinPath([...fullPaths, UI_FILE_INDEX]))
-        } else {
-          data.push(...this.readDirAndFileRecursive(
-            paths,
-            [...fullPath, dir]
-          ))
-        }
-      }
-    })
-
-    return data
-  }
-
-  /**
-   * Synchronously reads and parses the contents of a file (JSON or raw text).
-   *
-   * Синхронно читает и парсит содержимое файла (JSON или обычный текст).
-   * @param path path to the target file / путь к целевому файлу
-   */
-  static readFile<R>(path: PropertiesFilePath): R | undefined {
-    if (this.is(path)) {
-      return transformation(
-        requireFs.readFileSync(this.joinPath(path)).toString()
-      )
-    }
-
-    return undefined
-  }
-
-  /**
-   * Returns the content of the file, without converting the value.
-   *
-   * Возвращает содержимое файла, без преобразования значения.
-   * @param path filename/ имя файла
-   */
-  static readFileOnly(path: PropertiesFilePath): string | undefined {
-    if (this.is(path)) {
-      return requireFs.readFileSync(this.joinPath(path)).toString()
-    }
-
-    return undefined
-  }
-
-  /**
-   * Synchronously creates a directory.
-   *
-   * Синхронно создает директорию.
-   * @param path path to the directory/ путь к директории
-   */
-  static createDir(path: PropertiesFilePath): void {
-    const dir: string[] = [this.root]
-
-    this.splitForDir(this.removeRootInPath(path)).forEach((name) => {
-      dir.push(name)
-      if (!this.is(dir)) {
-        requireFs.mkdirSync(this.joinPath(dir))
-      }
-    })
-  }
-
-  /**
-   * Writes data to a file at the specified location, automatically creating directories and formatting objects as JSON by default.
-   *
-   * Записывает данные в файл по указанному адресу, автоматически создавая директории и форматируя объекты в JSON по умолчанию.
-   * @param path base directory path / путь к базовой директории
-   * @param name target filename (without extension if extension provided) / имя целевого файла
-   * @param value data to be stored / данные для хранения
-   * @param extension file extension (defaults to 'json') / расширение файла (по умолчанию 'json')
-   */
-  static write<T extends PropertiesFileValue>(
-    path: PropertiesFilePath,
-    name: string,
-    value: T,
-    extension = 'json'
-  ): void {
-    this.writeByPath(
-      this.joinPathByName(path, name, extension),
-      value
-    )
-  }
-
-  /**
-   * Writes to the selected path.
-   *
-   * Записывает по выбранному пути.
-   * @param path path to the file/ путь к файлу
-   * @param value values for storage/ значения для хранения
-   * @param transform whether to transform the value/ преобразовывать ли значение
-   */
-  static writeByPath<T extends PropertiesFileValue>(
-    path: PropertiesFilePath,
-    value: T,
-    transform: boolean = true
-  ): void {
-    this.createDir(path)
-
-    requireFs.writeFileSync(
-      this.joinPath(path),
-      transform && typeof value === 'object' ? JSON.stringify(value, undefined, 2) : value as any
-    )
-  }
-
-  /**
-   * Copy a file from the source path to the destination path.
-   *
-   * Копирования файла из исходного пути в целевой путь.
-   * @param path path to the file/ путь к файлу
-   * @param pathsSrc source filename to copy/ исходное имя файла для копирования
-   */
-  static copy(
-    path: PropertiesFilePath,
-    pathsSrc: PropertiesFilePath
-  ): void {
-    this.createDir(path)
-
-    requireFs.copyFileSync(
-      this.joinPath(pathsSrc),
-      this.joinPath(path)
-    )
-  }
-
-  /**
-   * Directory deletion.
-   *
-   * Удаление директории.
-   * @param path path to the directory/ путь к директории
-   */
-  static removeDir(
-    path: PropertiesFilePath
-  ): void {
-    if (this.isDir(path)) {
-      requireFs.rmSync(this.joinPath(path), {
-        recursive: true,
-        force: true
-      })
-    }
-  }
-
-  /**
-   * File deletion.
-   *
-   * Удаление файла.
-   * @param path path to the file/ путь к файлу
-   */
-  static removeFile(
-    path: PropertiesFilePath
-  ): void {
-    if (this.is(path)) {
-      requireFs.unlinkSync(this.joinPath(path))
-    }
-  }
-
-  static rename(
-    path: PropertiesFilePath,
-    newPath: PropertiesFilePath
-  ): void {
-    requireFs.renameSync(
-      this.joinPath(path),
-      this.joinPath(newPath)
-    )
-  }
-
-  /**
-   * Changing file permissions.
-   *
-   * Изменение прав доступа к файлу.
-   * @param path path to the file/ путь к файлу
-   * @param mode file permissions/ права доступа к файлу
-   */
-  static chmod(
-    path: PropertiesFilePath,
-    mode: string | number = 0o755
-  ): void {
-    requireFs.chmodSync(
-      this.joinPath(path),
-      mode
-    )
-  }
-
-  /**
-   * Removing root from the path.
-   *
-   * Удаление root из пути.
-   * @param path path to the directory/ путь к директории
-   */
-  private static removeRootInPath(path: PropertiesFilePath): string {
-    return this.joinPath(path)
-      .replace(`${this.root}${requirePath.sep}`, '')
-      .replace(`${this.root}`, '')
-  }
-
-  static {
-    this.module = Boolean(dirnamePath.match('node_modules'))
-    this.root = process.cwd()
-  }
-}

package/src/classes/Properties/PropertiesImport.ts

@@ -1,182 +0,0 @@
-// export:none
-
-import { forEach, isFilled, isObjectNotArray, replaceRecursive } from '@dxtmisha/functional-basic'
-
-import {
-  PropertiesFile,
-  type PropertiesFilePath
-} from './PropertiesFile'
-import { PropertiesCache } from './PropertiesCache'
-import { PropertiesTypes } from './PropertiesTypes'
-
-import { PropertiesConvector } from './PropertiesConvector'
-import { PropertiesStandard } from './PropertiesStandard'
-
-import {
-  PropertyKey,
-  type PropertyList,
-  type PropertyListOrData,
-  PropertyType
-} from '../../types/propertyTypes'
-
-/**
- * Resolver for external property references.
- * This class orchestrates the inclusion of external design tokens into the primary property tree. It identifies file references, resolves paths (including nested directory imports and specific object path deep-linking via hashes), and merges the external data into the current configuration cluster.
- *
- * Резолвер внешних ссылок на свойства.
- * Этот класс координирует включение внешних токенов дизайна в основное дерево свойств. Он идентифицирует ссылки на файлы, разрешает пути (включая импорт вложенных директорий и глубокие ссылки на конкретные объекты через хеш) и объединяет внешние данные с текущим кластером конфигурации.
- */
-export class PropertiesImport {
-  /**
-   * Constructor
-   * @param properties array with all property records/ массив со всеми записями свойств
-   * @param root path to the directory/ путь к директории
-   */
-
-  constructor(
-    private properties: PropertyList,
-    private root: string[]
-  ) {
-  }
-
-  /**
-   * Resolves and merges external file references within a property cluster.
-   * Iterates through the properties, looks for items of type 'file', and recursively imports their content, supporting deep-linking (e.g., 'file.json#path.to.data').
-   *
-   * Разрешает и объединяет ссылки на внешние файлы внутри кластера свойств.
-   * Итерирует по свойствам, ищет элементы типа 'file' и рекурсивно импортирует их содержимое, поддерживая глубокие ссылки (например, 'file.json#path.to.data').
-   * @param properties the property list to process / список свойств для обработки
-   * @param root the base path segments for resolution / базовые сегменты пути для разрешения
-   */
-  to(
-    properties = this.properties,
-    root = this.root
-  ) {
-    let data: PropertyList = {}
-
-    forEach(properties, (item, name) => {
-      if (
-        typeof item.value === 'string'
-        && PropertiesTypes.isInType(item[PropertyKey.type], [PropertyType.file])
-      ) {
-        const {
-          path,
-          link
-        } = this.initLink(root, item.value)
-        const read = this.readByLink(this.read(path), link)
-
-        if (isFilled(read)) {
-          PropertiesConvector.to(read)
-
-          data = replaceRecursive(data, this.to(
-            PropertiesStandard.to(read),
-            [PropertiesFile.getPathDir(path)]
-          ))
-        }
-      } else if (isObjectNotArray(item.value)) {
-        data = replaceRecursive(data, {
-          [name]: {
-            ...item,
-            value: this.to(item.value, root)
-          }
-        } as PropertyList)
-      } else {
-        data = replaceRecursive(data, { [name]: item })
-      }
-    })
-
-    return data
-  }
-
-  /**
-   * Returns the path to the file.
-   *
-   * Возвращает путь к файлу.
-   * @param root path to the directory/ путь к директории
-   * @param value object with data/ объект с данными
-   */
-  private getPath(root: string[], value: string): string[] {
-    return [
-      ...root,
-      ...value.split('/')
-    ]
-  }
-
-  /**
-   * Generates the path to the file and prepares entries in the tree to go through.
-   *
-   * Генерирует путь к файлу и подготавливает записи в дереве, по которому надо пройтись.
-   * @param root path to the directory/ путь к директории
-   * @param value object with data/ объект с данными
-   */
-  private initLink(root: string[], value: string) {
-    const link = value.split('#', 2)
-
-    return {
-      path: this.getPath(root, link[0] as string),
-      link: link?.[1]
-    }
-  }
-
-  /**
-   * Reads a file or an entire directory.
-   *
-   * Читает файл или всю директорию.
-   * @param path path to file/ путь к файлу
-   */
-  private read(path: PropertiesFilePath): PropertyListOrData | undefined {
-    if (PropertiesFile.isDir(path)) {
-      return this.readByDir(path)
-    }
-
-    return PropertiesCache.read<PropertyListOrData>(path) ?? {}
-  }
-
-  /**
-   * Reads the file and leaves the data only along the selected path.
-   *
-   * Читает файл и оставляет данные только по выделенному пути.
-   * @param read read data/ прочитанные данные
-   * @param link the path to the entry that needs to be used/ путь к записи, который надо использовать
-   */
-  private readByLink(
-    read: PropertyListOrData | undefined,
-    link?: string
-  ): PropertyListOrData | undefined {
-    let data = read
-
-    if (link) {
-      for (const name of link.split('.')) {
-        if (data && (name in data)) {
-          data = data[name]
-        } else {
-          return undefined
-        }
-      }
-    }
-
-    return data
-  }
-
-  /**
-   * Reads a directory.
-   *
-   * Читает директорию.
-   * @param path path to file/ путь к файлу
-   */
-  private readByDir(path: PropertiesFilePath): PropertyListOrData {
-    const files = PropertiesFile.readDir(path)
-    const data: PropertyListOrData = {}
-
-    files?.sort()
-    files?.forEach((file) => {
-      const parse = PropertiesFile.parse(file)
-
-      if (parse.ext === '.json') {
-        data[parse.name] = PropertiesCache.read<PropertyListOrData>([...path, file]) ?? {}
-      }
-    })
-
-    return data
-  }
-}