@xpack/xpm-lib 3.1.2 → 4.0.0

package/src/lib/liquid-drop.ts

@@ -1,99 +0,0 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/license/mit.
- */
-
-/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
-
-// ----------------------------------------------------------------------------
-
-// https://www.npmjs.com/package/liquidjs
-import { Liquid, Context, Drop } from 'liquidjs'
-
-// https://www.npmjs.com/package/@xpack/logger
-import { Logger } from '@xpack/logger'
-
-import { XpmLiquidSubstitutionsStrings } from './substitutions-variables.js'
-
-// ----------------------------------------------------------------------------
-
-// https://liquidjs.com/
-
-export class XpmLiquidPropertiesDrop extends Drop {
-  // --------------------------------------------------------------------------
-  // Members.
-
-  readonly #log: Logger
-  readonly #properties: XpmLiquidSubstitutionsStrings
-  readonly #engine: Liquid
-
-  // --------------------------------------------------------------------------
-  // Constructor.
-
-  constructor({
-    log,
-    engine,
-    properties,
-  }: {
-    log: Logger
-    engine: Liquid
-    properties: XpmLiquidSubstitutionsStrings
-  }) {
-    super()
-
-    log.trace(`${XpmLiquidPropertiesDrop.name}()`)
-
-    this.#log = log
-    this.#engine = engine
-    this.#properties = properties
-  }
-
-  // --------------------------------------------------------------------------
-  // Methods.
-
-  override async liquidMethodMissing(
-    key: string,
-    context: Context
-  ): Promise<string | string[]> {
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (this.#properties[key] === undefined) {
-      throw new Error(`properties have no ${key} key`)
-    }
-
-    const log = this.#log
-
-    const value = this.#properties[key] ?? ''
-    log.trace(
-      `${XpmLiquidPropertiesDrop.name}.liquidMethodMissing('${key}') value = |`,
-      value,
-      '|'
-    )
-
-    let result: string | string[]
-
-    const valueString = Array.isArray(value) ? value.join('') : value
-    if (valueString.includes('{{') || valueString.includes('{%')) {
-      result = (await this.#engine.parseAndRender(
-        valueString,
-        context
-      )) as string
-    } else {
-      result = value
-    }
-    log.trace(
-      `${XpmLiquidPropertiesDrop.name}.liquidMethodMissing('${key}') ` +
-        `result = |`,
-      result,
-      '|'
-    )
-    return result
-  }
-}
-
-// ----------------------------------------------------------------------------

package/src/lib/liquid-engine.ts

@@ -1,135 +0,0 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/license/mit.
- */
-
-/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
-
-// ----------------------------------------------------------------------------
-
-import * as os from 'node:os'
-import * as path from 'node:path'
-import * as util from 'node:util'
-
-// https://www.npmjs.com/package/liquidjs
-import { Liquid } from 'liquidjs'
-
-// ----------------------------------------------------------------------------
-
-export class XpmLiquidEngine extends Liquid {
-  // --------------------------------------------------------------------------
-  // Members.
-
-  // --------------------------------------------------------------------------
-  // Constructor.
-
-  constructor() {
-    super({
-      strictFilters: true,
-      strictVariables: true,
-      trimTagLeft: false,
-      trimTagRight: false,
-      trimOutputLeft: false,
-      trimOutputRight: false,
-      greedy: false,
-      lenientIf: true,
-    })
-
-    // https://liquidjs.com/api/classes/liquid_.liquid.html#registerFilter
-    // https://nodejs.org/dist/latest-v16.x/docs/api/path.html
-
-    // Add the main path manipulation functions.
-    this.registerFilter('path_basename', (p: string, ...arg) =>
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      path.basename(p, ...arg)
-    )
-
-    this.registerFilter('path_dirname', (p: string) => path.dirname(p))
-
-    this.registerFilter('path_normalize', (p: string) => path.normalize(p))
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-    this.registerFilter('path_join', (p, ...args) => path.join(p, ...args))
-
-    this.registerFilter('path_relative', (from: string, to: string) =>
-      path.relative(from, to)
-    )
-
-    this.registerFilter('path_posix_basename', (p: string, ...arg) =>
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      path.posix.basename(p, ...arg)
-    )
-
-    this.registerFilter('path_posix_dirname', (p: string) =>
-      path.posix.dirname(p)
-    )
-
-    this.registerFilter('path_posix_normalize', (p: string) =>
-      path.posix.normalize(p)
-    )
-
-    this.registerFilter('path_posix_join', (p, ...args) =>
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      path.posix.join(p, ...args)
-    )
-
-    this.registerFilter('path_posix_relative', (from: string, to: string) =>
-      path.posix.relative(from, to)
-    )
-
-    this.registerFilter('path_win32_basename', (p: string, ...arg) =>
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      path.win32.basename(p, ...arg)
-    )
-
-    this.registerFilter('path_win32_dirname', (p: string) =>
-      path.win32.dirname(p)
-    )
-
-    this.registerFilter('path_win32_normalize', (p: string) =>
-      path.win32.normalize(p)
-    )
-
-    this.registerFilter('path_win32_join', (p, ...args) =>
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      path.win32.join(p, ...args)
-    )
-
-    this.registerFilter('path_win32_relative', (from: string, to: string) =>
-      path.win32.relative(from, to)
-    )
-
-    // https://nodejs.org/dist/latest-v16.x/docs/api/util.html
-
-    this.registerFilter('util_format', (format, ...args) => {
-      // console.log([...args])
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      return util.format(format, ...args)
-    })
-
-    // Custom action.
-    this.registerFilter(
-      'to_filename',
-      // Replace non alphanumeric chars with dashes to make the paths
-      // comply with filesystem names.
-      (input: string): string => {
-        /* c8 ignore start */ /* istanbul ignore next */
-        const fixed =
-          os.platform() === 'win32'
-            ? input.replace(/[^a-zA-Z0-9\\:]+/g, '-')
-            : input.replace(/[^a-zA-Z0-9/]+/g, '-')
-        /* c8 ignore stop */
-
-        return fixed.replace(/--/g, '-')
-      }
-    )
-  }
-}
-
-// ----------------------------------------------------------------------------

package/src/lib/liquid-package.ts

@@ -1,108 +0,0 @@
-/*
- * This file is part of the xPack project (http://xpack.github.io).
- * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose is hereby granted, under the terms of the MIT license.
- *
- * If a copy of the license was not distributed with this file, it can
- * be obtained from https://opensource.org/license/mit.
- */
-
-/* eslint max-len: [ "error", 80, { "ignoreUrls": true } ] */
-
-// ----------------------------------------------------------------------------
-
-import assert from 'node:assert'
-import * as os from 'node:os'
-
-import { Liquid } from 'liquidjs'
-
-import { Logger } from '@xpack/logger'
-
-import { isJsonObject } from './functions/utils.js'
-import {
-  xpmLiquidSubstitutionsVariablesBase,
-  XpmLiquidSubstitutionsVariables,
-} from './substitutions-variables.js'
-import { XpmLiquidEngine } from './liquid-engine.js'
-import { XpmLiquidActions } from './liquid-actions.js'
-import { XpmLiquidBuildConfigurations } from './liquid-build-configurations.js'
-import { JsonXpmPackage } from './types.js'
-
-// ----------------------------------------------------------------------------
-
-export const buildFolderRelativePathPropertyName = 'buildFolderRelativePath'
-
-// ----------------------------------------------------------------------------
-
-export class XpmLiquidPackage {
-  // --------------------------------------------------------------------------
-  // Members.
-
-  readonly #log: Logger
-  readonly #engine: Liquid
-  readonly #jsonPackage: JsonXpmPackage
-
-  readonly topLiquidSubstitutionsVariables: XpmLiquidSubstitutionsVariables
-
-  readonly topActions: XpmLiquidActions
-  readonly buildConfigurations: XpmLiquidBuildConfigurations
-
-  // --------------------------------------------------------------------------
-  // Constructor and async initialiser.
-
-  constructor({
-    log,
-    jsonPackage,
-  }: {
-    log: Logger
-    jsonPackage: JsonXpmPackage
-  }) {
-    log.trace(`${XpmLiquidPackage.name}()`)
-
-    this.#log = log
-    this.#engine = new XpmLiquidEngine()
-
-    assert(isJsonObject(jsonPackage.xpack))
-    this.#jsonPackage = jsonPackage
-
-    // os.version() available since 12.x
-    assert(
-      typeof os.version === 'function',
-      'Mandatory os.version available only since 12.x'
-    )
-
-    this.topLiquidSubstitutionsVariables = {
-      ...xpmLiquidSubstitutionsVariablesBase,
-      package: jsonPackage,
-    }
-
-    if (isJsonObject(jsonPackage.xpack.properties)) {
-      this.topLiquidSubstitutionsVariables.properties = {
-        ...jsonPackage.xpack.properties,
-      }
-    }
-
-    // Prevent adding/removing properties.
-    Object.seal(this.topLiquidSubstitutionsVariables)
-
-    // Empty actions.
-    this.topActions = new XpmLiquidActions({
-      log: this.#log,
-      engine: this.#engine,
-      substitutionsVariables: this.topLiquidSubstitutionsVariables,
-      jsonActions: this.#jsonPackage.xpack.actions,
-    })
-
-    // Empty build configurations.
-    this.buildConfigurations = new XpmLiquidBuildConfigurations({
-      log: this.#log,
-      engine: this.#engine,
-      substitutionsVariables: this.topLiquidSubstitutionsVariables,
-      jsonBuildConfigurations: this.#jsonPackage.xpack.buildConfigurations,
-    })
-  }
-}
-
-// ----------------------------------------------------------------------------