@powerlines/core 0.11.0 → 0.11.2

package/dist/plugin-utils/helpers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.mjs","names":[],"sources":["../../src/plugin-utils/helpers.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { isFunction } from \"@stryke/type-checks/is-function\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { AnyFunction } from \"@stryke/types/base\";\nimport {\n  BUILDER_VARIANTS,\n  PLUGIN_HOOKS_FIELDS,\n  UNPLUGIN_BUILDER_VARIANTS\n} from \"../constants/plugin\";\nimport type {\n  PluginConfig,\n  PluginConfigObject,\n  PluginConfigTuple,\n  ResolvedConfig\n} from \"../types/config\";\nimport type { PluginContext, WithUnpluginBuildContext } from \"../types/context\";\nimport type {\n  HookFields,\n  PluginHooksListItem,\n  UnpluginHooksListItem\n} from \"../types/hooks\";\nimport type {\n  Plugin,\n  PluginHook,\n  PluginHookFields,\n  PluginHookObject,\n  PluginHooks\n} from \"../types/plugin\";\nimport type {\n  UnpluginBuilderVariant,\n  UnpluginOptions\n} from \"../types/unplugin\";\n\n/**\n * Type guard to check if an object is a {@link Plugin}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link Plugin}, false otherwise\n */\nexport function isPlugin<\n  TContext extends PluginContext = PluginContext<ResolvedConfig>\n>(value: unknown): value is Plugin<TContext> {\n  return (\n    isSetObject(value) &&\n    \"name\" in value &&\n    isSetString(value.name) &&\n    (isUndefined((value as Plugin<TContext>).api) ||\n      (\"api\" in value && isSetObject(value.api))) &&\n    (isUndefined((value as Plugin<TContext>).applyToEnvironment) ||\n      (\"applyToEnvironment\" in value &&\n        isFunction(value.applyToEnvironment))) &&\n    (isUndefined((value as Plugin<TContext>).dedupe) ||\n      (\"dedupe\" in value && isFunction(value.dedupe))) &&\n    PLUGIN_HOOKS_FIELDS.every(\n      hook =>\n        isUndefined((value as Plugin<TContext>)[hook]) ||\n        (hook in value &&\n          (isPluginHookFunction((value as Plugin<TContext>)[hook]) ||\n            (hook === \"config\" &&\n              isSetObject((value as Plugin<TContext>)[hook]))))\n    ) &&\n    BUILDER_VARIANTS.every(\n      variant =>\n        isUndefined((value as Plugin<TContext>)[variant]) ||\n        (variant in value && isSetObject((value as Plugin<TContext>)[variant]))\n    )\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfigObject}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfigObject}, false otherwise\n */\nexport function isPluginConfigObject<\n  TContext extends PluginContext = PluginContext<ResolvedConfig>\n>(value: unknown): value is PluginConfigObject<TContext> {\n  return (\n    isSetObject(value) &&\n    \"plugin\" in value &&\n    (((isSetString(value.plugin) || isFunction(value.plugin)) &&\n      \"options\" in value &&\n      isSetObject(value.options)) ||\n      isPlugin(value.plugin))\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfigTuple}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfigTuple}, false otherwise\n */\nexport function isPluginConfigTuple<\n  TContext extends PluginContext = PluginContext<ResolvedConfig>\n>(value: unknown): value is PluginConfigTuple<TContext> {\n  return (\n    Array.isArray(value) &&\n    (value.length === 1 || value.length === 2) &&\n    (((isSetString(value[0]) || isFunction(value[0])) &&\n      value.length > 1 &&\n      isSetObject(value[1])) ||\n      isPlugin(value[0]))\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfig}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfig}, false otherwise\n */\nexport function isPluginConfig<\n  TContext extends PluginContext = PluginContext<ResolvedConfig>\n>(value: unknown): value is PluginConfig<TContext> {\n  return (\n    isSetString(value) ||\n    isFunction(value) ||\n    isPlugin<TContext>(value) ||\n    isPluginConfigObject(value) ||\n    isPluginConfigTuple(value) ||\n    (Array.isArray(value) && value.every(item => isPluginConfig(item)))\n  );\n}\n\n/**\n * Type guard to check if an value is a {@link PluginHook} function\n *\n * @param value - The value to check\n * @returns True if the value is a {@link PluginHook} function, false otherwise\n */\nexport function isPluginHookObject(\n  value: unknown\n): value is PluginHookObject<AnyFunction> {\n  return isSetObject(value) && \"handler\" in value && isFunction(value.handler);\n}\n\n/**\n * Type guard to check if an value is a {@link PluginHook} function\n *\n * @param value - The value to check\n * @returns True if the value is a {@link PluginHook} function, false otherwise\n */\nexport function isPluginHookFunction(value: unknown): value is AnyFunction {\n  return isFunction(value) || isPluginHookObject(value);\n}\n\n/**\n * Type guard to check if an object is a {@link PluginHook}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginHook}, false otherwise\n */\nexport function isPluginHook(value: unknown): value is PluginHook<AnyFunction> {\n  return isPluginHookFunction(value) || isPluginHookObject(value);\n}\n\nexport type GetHookHandlerReturnType<\n  TContext extends PluginContext = PluginContext,\n  TField extends HookFields<TContext> = HookFields<TContext>\n> = TField extends PluginHookFields\n  ? PluginHooksListItem<TContext, TField>[\"handler\"]\n  : TField extends UnpluginBuilderVariant\n    ? UnpluginHooksListItem<TContext, TField>[\"handler\"]\n    : never;\n\ntype HooksListItemForField<\n  TContext extends PluginContext = PluginContext,\n  TField extends HookFields<TContext> = HookFields<TContext>\n> =\n  TField extends PluginHookFields<TContext>\n    ? PluginHooksListItem<TContext, Extract<TField, PluginHookFields<TContext>>>\n    : TField extends UnpluginBuilderVariant\n      ? UnpluginHooksListItem<TContext, Extract<TField, UnpluginBuilderVariant>>\n      : never;\n\n/**\n * Extract the hook handler function from a plugin hook\n *\n * @param pluginHook - The plugin hook to extract the handler function from\n * @returns The hook handler function\n */\nexport function getHookHandler<\n  TContext extends PluginContext = PluginContext,\n  TField extends HookFields<TContext> = HookFields<TContext>\n>(\n  pluginHook: PluginHook<AnyFunction>\n): GetHookHandlerReturnType<TContext, TField> {\n  return (\n    isFunction(pluginHook) ? pluginHook : pluginHook.handler\n  ) as GetHookHandlerReturnType<TContext, TField>;\n}\n\n/**\n * Extract a plugin hook from a plugin\n *\n * @param context - The build context\n * @param plugin - The plugin to extract the hook from\n * @param hook - The name of the hook to extract\n * @returns The extracted hook, or undefined if the hook does not exist\n */\nexport function extractPluginHook<\n  TContext extends PluginContext = PluginContext,\n  TPlugin extends Plugin<TContext> = Plugin<TContext>\n>(context: TContext, plugin: TPlugin, hook: keyof PluginHooks<TContext>) {\n  const pluginHook = plugin[hook];\n  if (!isPluginHook(pluginHook)) {\n    return undefined;\n  }\n\n  return isFunction(pluginHook)\n    ? {\n        normal: pluginHook.bind(context)\n      }\n    : {\n        [pluginHook.order ? pluginHook.order : \"normal\"]:\n          pluginHook.handler.bind(context)\n      };\n}\n\n/**\n * Check if a hook is external.\n *\n * @param keys - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isUnpluginHookKey<\n  TUnpluginBuilderVariant extends UnpluginBuilderVariant =\n    UnpluginBuilderVariant\n>(\n  keys: string\n): keys is `${TUnpluginBuilderVariant}:${keyof UnpluginOptions[TUnpluginBuilderVariant] & string}` {\n  return UNPLUGIN_BUILDER_VARIANTS.some(variant =>\n    keys.startsWith(`${variant}:`)\n  );\n}\n\n/**\n * Check if a hook is internal.\n *\n * @param keys - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isPluginHookField<TContext extends PluginContext>(\n  keys: string\n): keys is PluginHookFields<TContext> {\n  return (\n    !isUnpluginHookKey(keys) &&\n    PLUGIN_HOOKS_FIELDS.includes(keys as PluginHookFields<TContext>)\n  );\n}\n\n/**\n * Check if a hook is external.\n *\n * @param field - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isUnpluginHookField<\n  TUnpluginBuilderVariant extends UnpluginBuilderVariant =\n    UnpluginBuilderVariant\n>(field: string): field is TUnpluginBuilderVariant {\n  return (\n    !isPluginHookField(field) &&\n    UNPLUGIN_BUILDER_VARIANTS.includes(field as UnpluginBuilderVariant)\n  );\n}\n\n/**\n * Check if a plugin should be deduplicated.\n *\n * @param plugin - The plugin to check\n * @param plugins - The list of plugins to check against\n * @returns True if the plugin should be deduplicated, false otherwise\n */\nexport function checkDedupe<\n  TResolvedConfig extends ResolvedConfig = ResolvedConfig,\n  TContext extends PluginContext<TResolvedConfig> =\n    PluginContext<TResolvedConfig>\n>(plugin: Plugin<TContext>, plugins: Plugin<TContext>[]) {\n  return (\n    plugin.dedupe === false ||\n    plugins.some(\n      p =>\n        p.dedupe !== false &&\n        ((isFunction(p.dedupe) && p.dedupe(plugin)) || p.name === plugin.name)\n    )\n  );\n}\n\n/**\n * Add a plugin hook to the hooks list.\n *\n * @param context - The plugin context\n * @param plugin - The plugin to add the hook from\n * @param pluginHook - The plugin hook to add\n * @param hooksList - The list of hooks to add to\n */\nexport function addPluginHook<\n  TContext extends PluginContext = PluginContext,\n  TField extends PluginHookFields<TContext> = PluginHookFields<TContext>,\n  TList extends PluginHooksListItem<TContext, TField> = PluginHooksListItem<\n    TContext,\n    TField\n  >\n>(\n  context: TContext,\n  plugin: Plugin<TContext>,\n  pluginHook: PluginHook<AnyFunction>,\n  hooksList: TList[]\n) {\n  if (\n    !checkDedupe(plugin, hooksList.map(hook => hook.plugin).filter(Boolean))\n  ) {\n    const handler = ((...args: unknown[]) =>\n      (\n        getHookHandler<WithUnpluginBuildContext<TContext>, TField>(\n          pluginHook\n        ) as unknown as (...args: unknown[]) => unknown\n      ).apply(context, args)) as HooksListItemForField<\n      TContext,\n      TField\n    >[\"handler\"];\n    if (!handler) {\n      return;\n    }\n\n    hooksList.push({\n      plugin,\n      handler\n    } as any);\n  }\n}\n\n/**\n * Check the provided {@link PluginConfig}, and return a stringified version of the invalid configuration. If an array is provided, check each item in the array.\n *\n * @param config - The plugin configuration to check\n * @returns Null if the configuration is valid, otherwise an array of stringified invalid configurations\n */\nexport function findInvalidPluginConfig<\n  TContext extends PluginContext = PluginContext<ResolvedConfig>\n>(config: PluginConfig<TContext>): string[] | null {\n  if (isPluginConfig<TContext>(config)) {\n    return null;\n  }\n\n  if (Array.isArray(config as PluginConfig<TContext>[])) {\n    const invalidItems: string[] = [];\n    (config as PluginConfig<TContext>[]).forEach(item => {\n      const invalid = findInvalidPluginConfig<TContext>(item);\n      if (invalid) {\n        invalidItems.push(...invalid.map(i => JSON.stringify(i, null, 2)));\n      }\n    });\n\n    return invalidItems.length > 0 ? invalidItems : null;\n  }\n\n  return [JSON.stringify(config, null, 2)];\n}\n"],"mappings":";;;;;;;;;;;;;AA0DA,SAAgB,SAEd,OAA2C;AAC3C,QACE,YAAY,MAAM,IAClB,UAAU,SACV,YAAY,MAAM,KAAK,KACtB,YAAa,MAA2B,IAAI,IAC1C,SAAS,SAAS,YAAY,MAAM,IAAI,MAC1C,YAAa,MAA2B,mBAAmB,IACzD,wBAAwB,SACvB,WAAW,MAAM,mBAAmB,MACvC,YAAa,MAA2B,OAAO,IAC7C,YAAY,SAAS,WAAW,MAAM,OAAO,KAChD,oBAAoB,OAClB,SACE,YAAa,MAA2B,MAAM,IAC7C,QAAQ,UACN,qBAAsB,MAA2B,MAAM,IACrD,SAAS,YACR,YAAa,MAA2B,MAAM,EACvD,IACD,iBAAiB,OACf,YACE,YAAa,MAA2B,SAAS,IAChD,WAAW,SAAS,YAAa,MAA2B,SAAS,CACzE;;;;;;;;AAUL,SAAgB,qBAEd,OAAuD;AACvD,QACE,YAAY,MAAM,IAClB,YAAY,WACT,YAAY,MAAM,OAAO,IAAI,WAAW,MAAM,OAAO,KACtD,aAAa,SACb,YAAY,MAAM,QAAQ,IAC1B,SAAS,MAAM,OAAO;;;;;;;;AAU5B,SAAgB,oBAEd,OAAsD;AACtD,QACE,MAAM,QAAQ,MAAM,KACnB,MAAM,WAAW,KAAK,MAAM,WAAW,QACrC,YAAY,MAAM,GAAG,IAAI,WAAW,MAAM,GAAG,KAC9C,MAAM,SAAS,KACf,YAAY,MAAM,GAAG,IACrB,SAAS,MAAM,GAAG;;;;;;;;AAUxB,SAAgB,eAEd,OAAiD;AACjD,QACE,YAAY,MAAM,IAClB,WAAW,MAAM,IACjB,SAAmB,MAAM,IACzB,qBAAqB,MAAM,IAC3B,oBAAoB,MAAM,IACzB,MAAM,QAAQ,MAAM,IAAI,MAAM,OAAM,SAAQ,eAAe,KAAK,CAAC;;;;;;;;AAUtE,SAAgB,mBACd,OACwC;AACxC,QAAO,YAAY,MAAM,IAAI,aAAa,SAAS,WAAW,MAAM,QAAQ;;;;;;;;AAS9E,SAAgB,qBAAqB,OAAsC;AACzE,QAAO,WAAW,MAAM,IAAI,mBAAmB,MAAM;;;;;;;;AASvD,SAAgB,aAAa,OAAkD;AAC7E,QAAO,qBAAqB,MAAM,IAAI,mBAAmB,MAAM;;;;;;;;AA4BjE,SAAgB,eAId,YAC4C;AAC5C,QACE,WAAW,WAAW,GAAG,aAAa,WAAW;;;;;;;;;;AAYrD,SAAgB,kBAGd,SAAmB,QAAiB,MAAmC;CACvE,MAAM,aAAa,OAAO;AAC1B,KAAI,CAAC,aAAa,WAAW,CAC3B;AAGF,QAAO,WAAW,WAAW,GACzB,EACE,QAAQ,WAAW,KAAK,QAAQ,EACjC,GACD,GACG,WAAW,QAAQ,WAAW,QAAQ,WACrC,WAAW,QAAQ,KAAK,QAAQ,EACnC;;;;;;;;AASP,SAAgB,kBAId,MACiG;AACjG,QAAO,0BAA0B,MAAK,YACpC,KAAK,WAAW,GAAG,QAAQ,GAAG,CAC/B;;;;;;;;AASH,SAAgB,kBACd,MACoC;AACpC,QACE,CAAC,kBAAkB,KAAK,IACxB,oBAAoB,SAAS,KAAmC;;;;;;;;AAUpE,SAAgB,oBAGd,OAAiD;AACjD,QACE,CAAC,kBAAkB,MAAM,IACzB,0BAA0B,SAAS,MAAgC;;;;;;;;;AAWvE,SAAgB,YAId,QAA0B,SAA6B;AACvD,QACE,OAAO,WAAW,SAClB,QAAQ,MACN,MACE,EAAE,WAAW,UACX,WAAW,EAAE,OAAO,IAAI,EAAE,OAAO,OAAO,IAAK,EAAE,SAAS,OAAO,MACpE;;;;;;;;;;AAYL,SAAgB,cAQd,SACA,QACA,YACA,WACA;AACA,KACE,CAAC,YAAY,QAAQ,UAAU,KAAI,SAAQ,KAAK,OAAO,CAAC,OAAO,QAAQ,CAAC,EACxE;EACA,MAAM,YAAY,GAAG,SAEjB,eACE,WACD,CACD,MAAM,SAAS,KAAK;AAIxB,MAAI,CAAC,QACH;AAGF,YAAU,KAAK;GACb;GACA;GACD,CAAQ;;;;;;;;;AAUb,SAAgB,wBAEd,QAAiD;AACjD,KAAI,eAAyB,OAAO,CAClC,QAAO;AAGT,KAAI,MAAM,QAAQ,OAAmC,EAAE;EACrD,MAAM,eAAyB,EAAE;AACjC,EAAC,OAAoC,SAAQ,SAAQ;GACnD,MAAM,UAAU,wBAAkC,KAAK;AACvD,OAAI,QACF,cAAa,KAAK,GAAG,QAAQ,KAAI,MAAK,KAAK,UAAU,GAAG,MAAM,EAAE,CAAC,CAAC;IAEpE;AAEF,SAAO,aAAa,SAAS,IAAI,eAAe;;AAGlD,QAAO,CAAC,KAAK,UAAU,QAAQ,MAAM,EAAE,CAAC"}
+{"version":3,"file":"helpers.mjs","names":[],"sources":["../../src/plugin-utils/helpers.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { isFunction } from \"@stryke/type-checks/is-function\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { isUndefined } from \"@stryke/type-checks/is-undefined\";\nimport { AnyFunction } from \"@stryke/types/base\";\nimport {\n  PLUGIN_HOOKS_FIELDS,\n  PLUGIN_NON_HOOK_FIELDS,\n  UNPLUGIN_BUILDER_VARIANTS\n} from \"../constants/plugin\";\nimport type {\n  PluginConfig,\n  PluginConfigObject,\n  PluginConfigTuple\n} from \"../types/config\";\nimport type { PluginContext, WithUnpluginBuildContext } from \"../types/context\";\nimport type { HooksListItem } from \"../types/hooks\";\nimport type {\n  Plugin,\n  PluginHook,\n  PluginHookFields,\n  PluginHookObject,\n  PluginHooks\n} from \"../types/plugin\";\nimport type {\n  UnpluginBuilderVariant,\n  UnpluginOptions\n} from \"../types/unplugin\";\n\n/**\n * Type guard to check if an object is a {@link Plugin}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link Plugin}, false otherwise\n */\nexport function isPlugin<TContext extends PluginContext = PluginContext>(\n  value: unknown\n): value is Plugin<TContext> {\n  return (\n    isSetObject(value) &&\n    \"name\" in value &&\n    isSetString(value.name) &&\n    (isUndefined((value as Plugin<TContext>).api) ||\n      (\"api\" in value && isSetObject(value.api))) &&\n    (isUndefined((value as Plugin<TContext>).applyToEnvironment) ||\n      (\"applyToEnvironment\" in value &&\n        isFunction(value.applyToEnvironment))) &&\n    (isUndefined((value as Plugin<TContext>).dedupe) ||\n      (\"dedupe\" in value && isFunction(value.dedupe))) &&\n    PLUGIN_HOOKS_FIELDS.every(\n      hook =>\n        isUndefined((value as Record<string, unknown>)[hook]) ||\n        (hook in value &&\n          (isPluginHookFunction((value as Record<string, unknown>)[hook]) ||\n            (hook === \"config\" &&\n              isSetObject((value as Plugin<TContext>)[hook]))))\n    )\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfigObject}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfigObject}, false otherwise\n */\nexport function isPluginConfigObject<\n  TContext extends PluginContext = PluginContext\n>(value: unknown): value is PluginConfigObject<TContext> {\n  return (\n    isSetObject(value) &&\n    \"plugin\" in value &&\n    (((isSetString(value.plugin) || isFunction(value.plugin)) &&\n      \"options\" in value &&\n      isSetObject(value.options)) ||\n      isPlugin(value.plugin))\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfigTuple}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfigTuple}, false otherwise\n */\nexport function isPluginConfigTuple<\n  TContext extends PluginContext = PluginContext\n>(value: unknown): value is PluginConfigTuple<TContext> {\n  return (\n    Array.isArray(value) &&\n    (value.length === 1 || value.length === 2) &&\n    (((isSetString(value[0]) || isFunction(value[0])) &&\n      value.length > 1 &&\n      isSetObject(value[1])) ||\n      isPlugin(value[0]))\n  );\n}\n\n/**\n * Type guard to check if an object is a {@link PluginConfig}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginConfig}, false otherwise\n */\nexport function isPluginConfig<TContext extends PluginContext = PluginContext>(\n  value: unknown\n): value is PluginConfig<TContext> {\n  return (\n    isSetString(value) ||\n    isFunction(value) ||\n    isPlugin(value) ||\n    isPluginConfigObject(value) ||\n    isPluginConfigTuple(value) ||\n    (Array.isArray(value) && value.every(item => isPluginConfig(item)))\n  );\n}\n\n/**\n * Type guard to check if an value is a {@link PluginHook} function\n *\n * @param value - The value to check\n * @returns True if the value is a {@link PluginHook} function, false otherwise\n */\nexport function isPluginHookObject(\n  value: unknown\n): value is PluginHookObject<AnyFunction> {\n  return isSetObject(value) && \"handler\" in value && isFunction(value.handler);\n}\n\n/**\n * Type guard to check if an value is a {@link PluginHook} function\n *\n * @param value - The value to check\n * @returns True if the value is a {@link PluginHook} function, false otherwise\n */\nexport function isPluginHookFunction(value: unknown): value is AnyFunction {\n  return isFunction(value) || isPluginHookObject(value);\n}\n\n/**\n * Type guard to check if an object is a {@link PluginHook}\n *\n * @param value - The object to check\n * @returns True if the object is a {@link PluginHook}, false otherwise\n */\nexport function isPluginHook(value: unknown): value is PluginHook<AnyFunction> {\n  return isPluginHookFunction(value) || isPluginHookObject(value);\n}\n\nexport type GetHookHandlerReturnType<\n  TContext extends PluginContext = PluginContext,\n  TField extends string = string\n> = HooksListItem<TContext, TField>[\"handler\"];\n\n/**\n * Extract the hook handler function from a plugin hook\n *\n * @param pluginHook - The plugin hook to extract the handler function from\n * @returns The hook handler function\n */\nexport function getHookHandler<\n  TContext extends PluginContext = PluginContext,\n  TKey extends string = string\n>(\n  pluginHook: PluginHook<AnyFunction>\n): GetHookHandlerReturnType<TContext, TKey> {\n  return (\n    isFunction(pluginHook) ? pluginHook : pluginHook.handler\n  ) as GetHookHandlerReturnType<TContext, TKey>;\n}\n\n/**\n * Extract a plugin hook from a plugin\n *\n * @param context - The build context\n * @param plugin - The plugin to extract the hook from\n * @param hook - The name of the hook to extract\n * @returns The extracted hook, or undefined if the hook does not exist\n */\nexport function extractPluginHook<\n  TContext extends PluginContext = PluginContext,\n  TPlugin extends Plugin<TContext> = Plugin<TContext>\n>(context: TContext, plugin: TPlugin, hook: keyof PluginHooks<TContext>) {\n  const pluginHook = plugin[hook];\n  if (!isPluginHook(pluginHook)) {\n    return undefined;\n  }\n\n  return isFunction(pluginHook)\n    ? {\n        normal: pluginHook.bind(context)\n      }\n    : {\n        [pluginHook.order ? pluginHook.order : \"normal\"]:\n          pluginHook.handler.bind(context)\n      };\n}\n\n/**\n * Check if a hook is external.\n *\n * @param keys - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isUnpluginHookKey<\n  TUnpluginBuilderVariant extends UnpluginBuilderVariant =\n    UnpluginBuilderVariant\n>(\n  keys: string\n): keys is `${TUnpluginBuilderVariant}:${keyof UnpluginOptions[TUnpluginBuilderVariant] & string}` {\n  return UNPLUGIN_BUILDER_VARIANTS.some(variant =>\n    keys.startsWith(`${variant}:`)\n  );\n}\n\n/**\n * Check if a hook is internal.\n *\n * @param keys - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isPluginHookField<TContext extends PluginContext>(\n  keys: string\n) {\n  return !PLUGIN_NON_HOOK_FIELDS.includes(keys as PluginHookFields<TContext>);\n}\n\n/**\n * Check if a hook is external.\n *\n * @param field - The name of the hook to check.\n * @returns True if the hook is external, false otherwise.\n */\nexport function isUnpluginHookField<\n  TUnpluginBuilderVariant extends UnpluginBuilderVariant =\n    UnpluginBuilderVariant\n>(field: string): field is TUnpluginBuilderVariant {\n  return (\n    !isPluginHookField(field) &&\n    UNPLUGIN_BUILDER_VARIANTS.includes(field as UnpluginBuilderVariant)\n  );\n}\n\n/**\n * Check if a plugin should be deduplicated.\n *\n * @param plugin - The plugin to check\n * @param plugins - The list of plugins to check against\n * @returns True if the plugin should be deduplicated, false otherwise\n */\nexport function isDuplicate<TContext extends PluginContext = PluginContext>(\n  plugin: Plugin<TContext>,\n  plugins: Plugin<TContext>[]\n) {\n  return (\n    plugin.dedupe !== false &&\n    plugins.some(\n      p =>\n        p.dedupe !== false &&\n        ((isFunction(p.dedupe) && p.dedupe(plugin)) ||\n          kebabCase(p.name) === kebabCase(plugin.name))\n    )\n  );\n}\n\n/**\n * Remove duplicate hooks from a list of hooks, keeping the first occurrence of each plugin.\n *\n * @param hooksList - The list of hooks to deduplicate.\n * @returns A new list of hooks with duplicates removed.\n */\nexport function dedupeHooklist<\n  TContext extends PluginContext = PluginContext,\n  TField extends PluginHookFields<TContext> = PluginHookFields<TContext>,\n  TList extends HooksListItem<TContext, TField> = HooksListItem<\n    TContext,\n    TField\n  >\n>(hooksList: TList[]): TList[] {\n  return hooksList.reduce((ret, hook) => {\n    if (\n      !isDuplicate(\n        hook.plugin,\n        ret.map(h => h.plugin)\n      )\n    ) {\n      ret.push(hook);\n    }\n    return ret;\n  }, [] as TList[]);\n}\n\n/**\n * Add a plugin hook to the hooks list.\n *\n * @param context - The plugin context\n * @param plugin - The plugin to add the hook from\n * @param pluginHook - The plugin hook to add\n * @param hooksList - The list of hooks to add to\n */\nexport function addPluginHook<\n  TContext extends PluginContext = PluginContext,\n  TField extends PluginHookFields<TContext> = PluginHookFields<TContext>,\n  TList extends HooksListItem<TContext, TField> = HooksListItem<\n    TContext,\n    TField\n  >\n>(\n  context: TContext,\n  plugin: Plugin<TContext>,\n  pluginHook: PluginHook<AnyFunction>,\n  hooksList: TList[]\n): TList[] {\n  if (\n    !isDuplicate(plugin, hooksList.map(hook => hook.plugin).filter(Boolean))\n  ) {\n    const handler = ((...args: unknown[]) =>\n      (\n        getHookHandler<WithUnpluginBuildContext<TContext>, TField>(\n          pluginHook\n        ) as unknown as (...args: unknown[]) => unknown\n      ).apply(context, args)) as GetHookHandlerReturnType<TContext, TField>;\n    if (!handler) {\n      return hooksList;\n    }\n\n    hooksList.push({\n      plugin,\n      handler\n    } as any);\n  }\n\n  return hooksList;\n}\n\n/**\n * Check the provided {@link PluginConfig}, and return a stringified version of the invalid configuration. If an array is provided, check each item in the array.\n *\n * @param config - The plugin configuration to check\n * @returns Null if the configuration is valid, otherwise an array of stringified invalid configurations\n */\nexport function findInvalidPluginConfig<\n  TContext extends PluginContext = PluginContext\n>(config: PluginConfig<TContext>): string[] | null {\n  if (isPluginConfig<TContext>(config)) {\n    return null;\n  }\n\n  if (Array.isArray(config as PluginConfig<TContext>[])) {\n    const invalidItems: string[] = [];\n    (config as PluginConfig<TContext>[]).forEach(item => {\n      const invalid = findInvalidPluginConfig<TContext>(item);\n      if (invalid) {\n        invalidItems.push(...invalid.map(i => JSON.stringify(i, null, 2)));\n      }\n    });\n\n    return invalidItems.length > 0 ? invalidItems : null;\n  }\n\n  return [JSON.stringify(config, null, 2)];\n}\n"],"mappings":";;;;;;;;;;;;;;AAsDA,SAAgB,SACd,OAC2B;AAC3B,QACE,YAAY,MAAM,IAClB,UAAU,SACV,YAAY,MAAM,KAAK,KACtB,YAAa,MAA2B,IAAI,IAC1C,SAAS,SAAS,YAAY,MAAM,IAAI,MAC1C,YAAa,MAA2B,mBAAmB,IACzD,wBAAwB,SACvB,WAAW,MAAM,mBAAmB,MACvC,YAAa,MAA2B,OAAO,IAC7C,YAAY,SAAS,WAAW,MAAM,OAAO,KAChD,oBAAoB,OAClB,SACE,YAAa,MAAkC,MAAM,IACpD,QAAQ,UACN,qBAAsB,MAAkC,MAAM,IAC5D,SAAS,YACR,YAAa,MAA2B,MAAM,EACvD;;;;;;;;AAUL,SAAgB,qBAEd,OAAuD;AACvD,QACE,YAAY,MAAM,IAClB,YAAY,WACT,YAAY,MAAM,OAAO,IAAI,WAAW,MAAM,OAAO,KACtD,aAAa,SACb,YAAY,MAAM,QAAQ,IAC1B,SAAS,MAAM,OAAO;;;;;;;;AAU5B,SAAgB,oBAEd,OAAsD;AACtD,QACE,MAAM,QAAQ,MAAM,KACnB,MAAM,WAAW,KAAK,MAAM,WAAW,QACrC,YAAY,MAAM,GAAG,IAAI,WAAW,MAAM,GAAG,KAC9C,MAAM,SAAS,KACf,YAAY,MAAM,GAAG,IACrB,SAAS,MAAM,GAAG;;;;;;;;AAUxB,SAAgB,eACd,OACiC;AACjC,QACE,YAAY,MAAM,IAClB,WAAW,MAAM,IACjB,SAAS,MAAM,IACf,qBAAqB,MAAM,IAC3B,oBAAoB,MAAM,IACzB,MAAM,QAAQ,MAAM,IAAI,MAAM,OAAM,SAAQ,eAAe,KAAK,CAAC;;;;;;;;AAUtE,SAAgB,mBACd,OACwC;AACxC,QAAO,YAAY,MAAM,IAAI,aAAa,SAAS,WAAW,MAAM,QAAQ;;;;;;;;AAS9E,SAAgB,qBAAqB,OAAsC;AACzE,QAAO,WAAW,MAAM,IAAI,mBAAmB,MAAM;;;;;;;;AASvD,SAAgB,aAAa,OAAkD;AAC7E,QAAO,qBAAqB,MAAM,IAAI,mBAAmB,MAAM;;;;;;;;AAcjE,SAAgB,eAId,YAC0C;AAC1C,QACE,WAAW,WAAW,GAAG,aAAa,WAAW;;;;;;;;;;AAYrD,SAAgB,kBAGd,SAAmB,QAAiB,MAAmC;CACvE,MAAM,aAAa,OAAO;AAC1B,KAAI,CAAC,aAAa,WAAW,CAC3B;AAGF,QAAO,WAAW,WAAW,GACzB,EACE,QAAQ,WAAW,KAAK,QAAQ,EACjC,GACD,GACG,WAAW,QAAQ,WAAW,QAAQ,WACrC,WAAW,QAAQ,KAAK,QAAQ,EACnC;;;;;;;;AASP,SAAgB,kBAId,MACiG;AACjG,QAAO,0BAA0B,MAAK,YACpC,KAAK,WAAW,GAAG,QAAQ,GAAG,CAC/B;;;;;;;;AASH,SAAgB,kBACd,MACA;AACA,QAAO,CAAC,uBAAuB,SAAS,KAAmC;;;;;;;;AAS7E,SAAgB,oBAGd,OAAiD;AACjD,QACE,CAAC,kBAAkB,MAAM,IACzB,0BAA0B,SAAS,MAAgC;;;;;;;;;AAWvE,SAAgB,YACd,QACA,SACA;AACA,QACE,OAAO,WAAW,SAClB,QAAQ,MACN,MACE,EAAE,WAAW,UACX,WAAW,EAAE,OAAO,IAAI,EAAE,OAAO,OAAO,IACxC,UAAU,EAAE,KAAK,KAAK,UAAU,OAAO,KAAK,EACjD;;;;;;;;AAUL,SAAgB,eAOd,WAA6B;AAC7B,QAAO,UAAU,QAAQ,KAAK,SAAS;AACrC,MACE,CAAC,YACC,KAAK,QACL,IAAI,KAAI,MAAK,EAAE,OAAO,CACvB,CAED,KAAI,KAAK,KAAK;AAEhB,SAAO;IACN,EAAE,CAAY;;;;;;;;;;AAWnB,SAAgB,cAQd,SACA,QACA,YACA,WACS;AACT,KACE,CAAC,YAAY,QAAQ,UAAU,KAAI,SAAQ,KAAK,OAAO,CAAC,OAAO,QAAQ,CAAC,EACxE;EACA,MAAM,YAAY,GAAG,SAEjB,eACE,WACD,CACD,MAAM,SAAS,KAAK;AACxB,MAAI,CAAC,QACH,QAAO;AAGT,YAAU,KAAK;GACb;GACA;GACD,CAAQ;;AAGX,QAAO;;;;;;;;AAST,SAAgB,wBAEd,QAAiD;AACjD,KAAI,eAAyB,OAAO,CAClC,QAAO;AAGT,KAAI,MAAM,QAAQ,OAAmC,EAAE;EACrD,MAAM,eAAyB,EAAE;AACjC,EAAC,OAAoC,SAAQ,SAAQ;GACnD,MAAM,UAAU,wBAAkC,KAAK;AACvD,OAAI,QACF,cAAa,KAAK,GAAG,QAAQ,KAAI,MAAK,KAAK,UAAU,GAAG,MAAM,EAAE,CAAC,CAAC;IAEpE;AAEF,SAAO,aAAa,SAAS,IAAI,eAAe;;AAGlD,QAAO,CAAC,KAAK,UAAU,QAAQ,MAAM,EAAE,CAAC"}

package/dist/plugin-utils/index.cjs

@@ -1,29 +1,59 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_plugin_utils_paths = require('./paths.cjs');
-const require_plugin_utils_format_package_json = require('./format-package-json.cjs');
+const require_plugin_utils_logging = require('./logging.cjs');
 const require_plugin_utils_build_helpers = require('./build-helpers.cjs');
 const require_plugin_utils_helpers = require('./helpers.cjs');
 const require_plugin_utils_merge = require('./merge.cjs');
 const require_plugin_utils_combine_plugins = require('./combine-plugins.cjs');
 const require_plugin_utils_context_helpers = require('./context-helpers.cjs');
+const require_plugin_utils_docs_helper = require('./docs-helper.cjs');
 const require_plugin_utils_extend = require('./extend.cjs');
+const require_plugin_utils_virtual = require('./virtual.cjs');
+const require_plugin_utils_filter = require('./filter.cjs');
+const require_plugin_utils_format = require('./format.cjs');
+const require_plugin_utils_format_package_json = require('./format-package-json.cjs');
 const require_plugin_utils_get_config_path = require('./get-config-path.cjs');
+const require_plugin_utils_install = require('./install.cjs');
 const require_plugin_utils_modules = require('./modules.cjs');
+const require_plugin_utils_paths = require('./paths.cjs');
 
+exports.VIRTUAL_MODULE_PREFIX = require_plugin_utils_virtual.VIRTUAL_MODULE_PREFIX;
+exports.VIRTUAL_MODULE_PREFIX_REGEX = require_plugin_utils_virtual.VIRTUAL_MODULE_PREFIX_REGEX;
 exports.addPluginHook = require_plugin_utils_helpers.addPluginHook;
-exports.checkDedupe = require_plugin_utils_helpers.checkDedupe;
+exports.addVirtualPrefix = require_plugin_utils_virtual.addVirtualPrefix;
+exports.colorBackground = require_plugin_utils_logging.colorBackground;
+exports.colorText = require_plugin_utils_logging.colorText;
 exports.combinePluginOptions = require_plugin_utils_combine_plugins.combinePluginOptions;
 exports.combinePlugins = require_plugin_utils_combine_plugins.combinePlugins;
+exports.consoleLog = require_plugin_utils_logging.consoleLog;
+exports.consoleLogger = require_plugin_utils_logging.consoleLogger;
+exports.createCodeFilter = require_plugin_utils_filter.createCodeFilter;
+exports.createFilter = require_plugin_utils_filter.createFilter;
+exports.createFilterForId = require_plugin_utils_filter.createFilterForId;
+exports.createFilterForTransform = require_plugin_utils_filter.createFilterForTransform;
+exports.createIdFilter = require_plugin_utils_filter.createIdFilter;
+exports.createLogFn = require_plugin_utils_logging.createLogFn;
+exports.createLogger = require_plugin_utils_logging.createLogger;
+exports.createVirtualPrefixRegex = require_plugin_utils_virtual.createVirtualPrefixRegex;
+exports.dedupeHooklist = require_plugin_utils_helpers.dedupeHooklist;
 exports.extend = require_plugin_utils_extend.extend;
+exports.extendLogFn = require_plugin_utils_logging.extendLogFn;
+exports.extendLogger = require_plugin_utils_logging.extendLogger;
 exports.extractPluginHook = require_plugin_utils_helpers.extractPluginHook;
 exports.findInvalidPluginConfig = require_plugin_utils_helpers.findInvalidPluginConfig;
+exports.formatConfig = require_plugin_utils_format.formatConfig;
 exports.formatPackageJson = require_plugin_utils_format_package_json.formatPackageJson;
 exports.getConfigPath = require_plugin_utils_get_config_path.getConfigPath;
 exports.getDependencyConfig = require_plugin_utils_build_helpers.getDependencyConfig;
+exports.getDocsOutputPath = require_plugin_utils_docs_helper.getDocsOutputPath;
 exports.getHookHandler = require_plugin_utils_helpers.getHookHandler;
 exports.getOrganizationName = require_plugin_utils_context_helpers.getOrganizationName;
+exports.getPackageJsonOrganization = require_plugin_utils_context_helpers.getPackageJsonOrganization;
+exports.getTextColor = require_plugin_utils_logging.getTextColor;
 exports.getWorkspaceName = require_plugin_utils_context_helpers.getWorkspaceName;
+exports.installPackage = require_plugin_utils_install.installPackage;
+exports.installPackages = require_plugin_utils_install.installPackages;
 exports.isBuiltinModule = require_plugin_utils_modules.isBuiltinModule;
+exports.isDuplicate = require_plugin_utils_helpers.isDuplicate;
 exports.isPlugin = require_plugin_utils_helpers.isPlugin;
 exports.isPluginConfig = require_plugin_utils_helpers.isPluginConfig;
 exports.isPluginConfigObject = require_plugin_utils_helpers.isPluginConfigObject;
@@ -34,6 +64,20 @@ exports.isPluginHookFunction = require_plugin_utils_helpers.isPluginHookFunction
 exports.isPluginHookObject = require_plugin_utils_helpers.isPluginHookObject;
 exports.isUnpluginHookField = require_plugin_utils_helpers.isUnpluginHookField;
 exports.isUnpluginHookKey = require_plugin_utils_helpers.isUnpluginHookKey;
+exports.isValidLogLevel = require_plugin_utils_logging.isValidLogLevel;
+exports.isValidLogLevelConfig = require_plugin_utils_logging.isValidLogLevelConfig;
+exports.isVerbose = require_plugin_utils_logging.isVerbose;
+exports.isVirtualModule = require_plugin_utils_virtual.isVirtualModule;
 exports.merge = require_plugin_utils_merge.merge;
 exports.mergeConfig = require_plugin_utils_merge.mergeConfig;
-exports.replacePathTokens = require_plugin_utils_paths.replacePathTokens;
+exports.normalizeFilter = require_plugin_utils_filter.normalizeFilter;
+exports.normalizeSingleFilter = require_plugin_utils_filter.normalizeSingleFilter;
+exports.patternToCodeFilter = require_plugin_utils_filter.patternToCodeFilter;
+exports.patternToIdFilter = require_plugin_utils_filter.patternToIdFilter;
+exports.prefixRegex = require_plugin_utils_virtual.prefixRegex;
+exports.removeVirtualPrefix = require_plugin_utils_virtual.removeVirtualPrefix;
+exports.replacePathTokens = require_plugin_utils_paths.replacePathTokens;
+exports.resolveLogLevel = require_plugin_utils_logging.resolveLogLevel;
+exports.withCustomLogger = require_plugin_utils_logging.withCustomLogger;
+exports.withLogFn = require_plugin_utils_logging.withLogFn;
+exports.withLogger = require_plugin_utils_logging.withLogger;

package/dist/plugin-utils/index.d.cts

@@ -1,11 +1,17 @@
 import { GetDependencyConfigResult, __ΩGetDependencyConfigResult, getDependencyConfig } from "./build-helpers.cjs";
 import { CombinePluginsOptions, __ΩCombinePluginsOptions, combinePluginOptions, combinePlugins } from "./combine-plugins.cjs";
-import { getOrganizationName, getWorkspaceName } from "./context-helpers.cjs";
+import { getOrganizationName, getPackageJsonOrganization, getWorkspaceName } from "./context-helpers.cjs";
+import { getDocsOutputPath } from "./docs-helper.cjs";
 import { extend } from "./extend.cjs";
+import { createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter } from "./filter.cjs";
 import { formatPackageJson } from "./format-package-json.cjs";
+import { formatConfig } from "./format.cjs";
 import { getConfigPath } from "./get-config-path.cjs";
-import { GetHookHandlerReturnType, __ΩGetHookHandlerReturnType, addPluginHook, checkDedupe, extractPluginHook, findInvalidPluginConfig, getHookHandler, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.cjs";
+import { GetHookHandlerReturnType, __ΩGetHookHandlerReturnType, addPluginHook, dedupeHooklist, extractPluginHook, findInvalidPluginConfig, getHookHandler, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.cjs";
+import { installPackage, installPackages } from "./install.cjs";
+import { colorBackground, colorText, consoleLog, consoleLogger, createLogFn, createLogger, extendLogFn, extendLogger, getTextColor, isValidLogLevel, isValidLogLevelConfig, isVerbose, resolveLogLevel, withCustomLogger, withLogFn, withLogger } from "./logging.cjs";
 import { MergeResult, __ΩMergeResult, merge, mergeConfig } from "./merge.cjs";
 import { isBuiltinModule } from "./modules.cjs";
 import { replacePathTokens } from "./paths.cjs";
-export { CombinePluginsOptions, GetDependencyConfigResult, GetHookHandlerReturnType, MergeResult, __ΩCombinePluginsOptions, __ΩGetDependencyConfigResult, __ΩGetHookHandlerReturnType, __ΩMergeResult, addPluginHook, checkDedupe, combinePluginOptions, combinePlugins, extend, extractPluginHook, findInvalidPluginConfig, formatPackageJson, getConfigPath, getDependencyConfig, getHookHandler, getOrganizationName, getWorkspaceName, isBuiltinModule, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, merge, mergeConfig, replacePathTokens };
+import { PrefixRegexOptions, VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, __ΩPrefixRegexOptions, addVirtualPrefix, createVirtualPrefixRegex, isVirtualModule, prefixRegex, removeVirtualPrefix } from "./virtual.cjs";
+export { CombinePluginsOptions, GetDependencyConfigResult, GetHookHandlerReturnType, MergeResult, PrefixRegexOptions, VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, __ΩCombinePluginsOptions, __ΩGetDependencyConfigResult, __ΩGetHookHandlerReturnType, __ΩMergeResult, __ΩPrefixRegexOptions, addPluginHook, addVirtualPrefix, colorBackground, colorText, combinePluginOptions, combinePlugins, consoleLog, consoleLogger, createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, createLogFn, createLogger, createVirtualPrefixRegex, dedupeHooklist, extend, extendLogFn, extendLogger, extractPluginHook, findInvalidPluginConfig, formatConfig, formatPackageJson, getConfigPath, getDependencyConfig, getDocsOutputPath, getHookHandler, getOrganizationName, getPackageJsonOrganization, getTextColor, getWorkspaceName, installPackage, installPackages, isBuiltinModule, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, isValidLogLevel, isValidLogLevelConfig, isVerbose, isVirtualModule, merge, mergeConfig, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter, prefixRegex, removeVirtualPrefix, replacePathTokens, resolveLogLevel, withCustomLogger, withLogFn, withLogger };

package/dist/plugin-utils/index.d.mts

@@ -1,11 +1,17 @@
 import { GetDependencyConfigResult, __ΩGetDependencyConfigResult, getDependencyConfig } from "./build-helpers.mjs";
 import { CombinePluginsOptions, __ΩCombinePluginsOptions, combinePluginOptions, combinePlugins } from "./combine-plugins.mjs";
-import { getOrganizationName, getWorkspaceName } from "./context-helpers.mjs";
+import { getOrganizationName, getPackageJsonOrganization, getWorkspaceName } from "./context-helpers.mjs";
+import { getDocsOutputPath } from "./docs-helper.mjs";
 import { extend } from "./extend.mjs";
+import { createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter } from "./filter.mjs";
 import { formatPackageJson } from "./format-package-json.mjs";
+import { formatConfig } from "./format.mjs";
 import { getConfigPath } from "./get-config-path.mjs";
-import { GetHookHandlerReturnType, __ΩGetHookHandlerReturnType, addPluginHook, checkDedupe, extractPluginHook, findInvalidPluginConfig, getHookHandler, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.mjs";
+import { GetHookHandlerReturnType, __ΩGetHookHandlerReturnType, addPluginHook, dedupeHooklist, extractPluginHook, findInvalidPluginConfig, getHookHandler, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.mjs";
+import { installPackage, installPackages } from "./install.mjs";
+import { colorBackground, colorText, consoleLog, consoleLogger, createLogFn, createLogger, extendLogFn, extendLogger, getTextColor, isValidLogLevel, isValidLogLevelConfig, isVerbose, resolveLogLevel, withCustomLogger, withLogFn, withLogger } from "./logging.mjs";
 import { MergeResult, __ΩMergeResult, merge, mergeConfig } from "./merge.mjs";
 import { isBuiltinModule } from "./modules.mjs";
 import { replacePathTokens } from "./paths.mjs";
-export { CombinePluginsOptions, GetDependencyConfigResult, GetHookHandlerReturnType, MergeResult, __ΩCombinePluginsOptions, __ΩGetDependencyConfigResult, __ΩGetHookHandlerReturnType, __ΩMergeResult, addPluginHook, checkDedupe, combinePluginOptions, combinePlugins, extend, extractPluginHook, findInvalidPluginConfig, formatPackageJson, getConfigPath, getDependencyConfig, getHookHandler, getOrganizationName, getWorkspaceName, isBuiltinModule, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, merge, mergeConfig, replacePathTokens };
+import { PrefixRegexOptions, VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, __ΩPrefixRegexOptions, addVirtualPrefix, createVirtualPrefixRegex, isVirtualModule, prefixRegex, removeVirtualPrefix } from "./virtual.mjs";
+export { CombinePluginsOptions, GetDependencyConfigResult, GetHookHandlerReturnType, MergeResult, PrefixRegexOptions, VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, __ΩCombinePluginsOptions, __ΩGetDependencyConfigResult, __ΩGetHookHandlerReturnType, __ΩMergeResult, __ΩPrefixRegexOptions, addPluginHook, addVirtualPrefix, colorBackground, colorText, combinePluginOptions, combinePlugins, consoleLog, consoleLogger, createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, createLogFn, createLogger, createVirtualPrefixRegex, dedupeHooklist, extend, extendLogFn, extendLogger, extractPluginHook, findInvalidPluginConfig, formatConfig, formatPackageJson, getConfigPath, getDependencyConfig, getDocsOutputPath, getHookHandler, getOrganizationName, getPackageJsonOrganization, getTextColor, getWorkspaceName, installPackage, installPackages, isBuiltinModule, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, isValidLogLevel, isValidLogLevelConfig, isVerbose, isVirtualModule, merge, mergeConfig, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter, prefixRegex, removeVirtualPrefix, replacePathTokens, resolveLogLevel, withCustomLogger, withLogFn, withLogger };

package/dist/plugin-utils/index.mjs

@@ -1,12 +1,18 @@
-import { replacePathTokens } from "./paths.mjs";
-import { formatPackageJson } from "./format-package-json.mjs";
+import { colorBackground, colorText, consoleLog, consoleLogger, createLogFn, createLogger, extendLogFn, extendLogger, getTextColor, isValidLogLevel, isValidLogLevelConfig, isVerbose, resolveLogLevel, withCustomLogger, withLogFn, withLogger } from "./logging.mjs";
 import { getDependencyConfig } from "./build-helpers.mjs";
-import { addPluginHook, checkDedupe, extractPluginHook, findInvalidPluginConfig, getHookHandler, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.mjs";
+import { addPluginHook, dedupeHooklist, extractPluginHook, findInvalidPluginConfig, getHookHandler, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey } from "./helpers.mjs";
 import { merge, mergeConfig } from "./merge.mjs";
 import { combinePluginOptions, combinePlugins } from "./combine-plugins.mjs";
-import { getOrganizationName, getWorkspaceName } from "./context-helpers.mjs";
+import { getOrganizationName, getPackageJsonOrganization, getWorkspaceName } from "./context-helpers.mjs";
+import { getDocsOutputPath } from "./docs-helper.mjs";
 import { extend } from "./extend.mjs";
+import { VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, addVirtualPrefix, createVirtualPrefixRegex, isVirtualModule, prefixRegex, removeVirtualPrefix } from "./virtual.mjs";
+import { createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter } from "./filter.mjs";
+import { formatConfig } from "./format.mjs";
+import { formatPackageJson } from "./format-package-json.mjs";
 import { getConfigPath } from "./get-config-path.mjs";
+import { installPackage, installPackages } from "./install.mjs";
 import { isBuiltinModule } from "./modules.mjs";
+import { replacePathTokens } from "./paths.mjs";
 
-export { addPluginHook, checkDedupe, combinePluginOptions, combinePlugins, extend, extractPluginHook, findInvalidPluginConfig, formatPackageJson, getConfigPath, getDependencyConfig, getHookHandler, getOrganizationName, getWorkspaceName, isBuiltinModule, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, merge, mergeConfig, replacePathTokens };
+export { VIRTUAL_MODULE_PREFIX, VIRTUAL_MODULE_PREFIX_REGEX, addPluginHook, addVirtualPrefix, colorBackground, colorText, combinePluginOptions, combinePlugins, consoleLog, consoleLogger, createCodeFilter, createFilter, createFilterForId, createFilterForTransform, createIdFilter, createLogFn, createLogger, createVirtualPrefixRegex, dedupeHooklist, extend, extendLogFn, extendLogger, extractPluginHook, findInvalidPluginConfig, formatConfig, formatPackageJson, getConfigPath, getDependencyConfig, getDocsOutputPath, getHookHandler, getOrganizationName, getPackageJsonOrganization, getTextColor, getWorkspaceName, installPackage, installPackages, isBuiltinModule, isDuplicate, isPlugin, isPluginConfig, isPluginConfigObject, isPluginConfigTuple, isPluginHook, isPluginHookField, isPluginHookFunction, isPluginHookObject, isUnpluginHookField, isUnpluginHookKey, isValidLogLevel, isValidLogLevelConfig, isVerbose, isVirtualModule, merge, mergeConfig, normalizeFilter, normalizeSingleFilter, patternToCodeFilter, patternToIdFilter, prefixRegex, removeVirtualPrefix, replacePathTokens, resolveLogLevel, withCustomLogger, withLogFn, withLogger };

package/dist/plugin-utils/install.cjs

@@ -0,0 +1,47 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+let _stryke_fs_install = require("@stryke/fs/install");
+let _stryke_fs_package_fns = require("@stryke/fs/package-fns");
+let _stryke_string_format_package = require("@stryke/string-format/package");
+let _stryke_type_checks_is_number = require("@stryke/type-checks/is-number");
+
+//#region src/plugin-utils/install.ts
+/**
+* Installs a package if it is not already installed.
+*
+* @param context - The resolved options
+* @param packageName - The name of the package to install
+* @param dev - Whether to install the package as a dev dependency
+*/
+async function installPackage(context, packageName, dev = false) {
+	if (!await (0, _stryke_fs_package_fns.isPackageListed)((0, _stryke_string_format_package.getPackageName)(packageName), { cwd: context.config.root })) if (context.config.autoInstall) {
+		context.warn(`The package "${packageName}" is not installed. It will be installed automatically.`);
+		const result = await (0, _stryke_fs_install.install)(packageName, {
+			cwd: context.config.root,
+			dev
+		});
+		if ((0, _stryke_type_checks_is_number.isNumber)(result.exitCode) && result.exitCode > 0) {
+			context.error(result.stderr);
+			throw new Error(`An error occurred while installing the package "${packageName}"`);
+		}
+	} else context.warn(`The package "${packageName}" is not installed. Since the "autoInstall" option is set to false, it will not be installed automatically.`);
+	else if ((0, _stryke_string_format_package.hasPackageVersion)(packageName) && !process.env.POWERLINES_SKIP_VERSION_CHECK) {
+		if (!await (0, _stryke_fs_package_fns.doesPackageMatch)((0, _stryke_string_format_package.getPackageName)(packageName), (0, _stryke_string_format_package.getPackageVersion)(packageName), context.config.root)) {
+			const packageListing = await (0, _stryke_fs_package_fns.getPackageListing)((0, _stryke_string_format_package.getPackageName)(packageName), { cwd: context.config.root });
+			if (!packageListing?.version.startsWith("catalog:") && !packageListing?.version.startsWith("workspace:")) context.warn(`The package "${(0, _stryke_string_format_package.getPackageName)(packageName)}" is installed but does not match the expected version ${(0, _stryke_string_format_package.getPackageVersion)(packageName)} (installed version: ${packageListing?.version || "<Unknown>"}). Please ensure this is intentional before proceeding. Note: You can skip this validation with the "STORM_STACK_SKIP_VERSION_CHECK" environment variable.`);
+		}
+	}
+}
+/**
+* Installs a package if it is not already installed.
+*
+* @param context - The resolved options
+* @param packages - The list of packages to install
+*/
+async function installPackages(context, packages) {
+	return Promise.all(packages.map(async (pkg) => installPackage(context, pkg.name, pkg.dev)));
+}
+
+//#endregion
+exports.installPackage = installPackage;
+exports.installPackages = installPackages;

package/dist/plugin-utils/install.d.cts

@@ -0,0 +1,23 @@
+import { Context } from "../types/context.cjs";
+//#region src/plugin-utils/install.d.ts
+/**
+ * Installs a package if it is not already installed.
+ *
+ * @param context - The resolved options
+ * @param packageName - The name of the package to install
+ * @param dev - Whether to install the package as a dev dependency
+ */
+declare function installPackage(context: Context, packageName: string, dev?: boolean): Promise<void>;
+/**
+ * Installs a package if it is not already installed.
+ *
+ * @param context - The resolved options
+ * @param packages - The list of packages to install
+ */
+declare function installPackages(context: Context, packages: Array<{
+  name: string;
+  dev?: boolean;
+}>): Promise<void[]>;
+//#endregion
+export { installPackage, installPackages };
+//# sourceMappingURL=install.d.cts.map

package/dist/plugin-utils/install.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.cts","names":[],"sources":["../../src/plugin-utils/install.ts"],"mappings":";;;;;AAuCA;;;;iBAAsB,cAAA,CACpB,OAAA,EAAS,OAAA,EACT,WAAA,UACA,GAAA,aAAW,OAAA;;;;;;;iBA+DS,eAAA,CACpB,OAAA,EAAS,OAAA,EACT,QAAA,EAAU,KAAA;EAAQ,IAAA;EAAc,GAAA;AAAA,KAAgB,OAAA"}

package/dist/plugin-utils/install.d.mts

@@ -0,0 +1,23 @@
+import { Context } from "../types/context.mjs";
+//#region src/plugin-utils/install.d.ts
+/**
+ * Installs a package if it is not already installed.
+ *
+ * @param context - The resolved options
+ * @param packageName - The name of the package to install
+ * @param dev - Whether to install the package as a dev dependency
+ */
+declare function installPackage(context: Context, packageName: string, dev?: boolean): Promise<void>;
+/**
+ * Installs a package if it is not already installed.
+ *
+ * @param context - The resolved options
+ * @param packages - The list of packages to install
+ */
+declare function installPackages(context: Context, packages: Array<{
+  name: string;
+  dev?: boolean;
+}>): Promise<void[]>;
+//#endregion
+export { installPackage, installPackages };
+//# sourceMappingURL=install.d.mts.map

package/dist/plugin-utils/install.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.mts","names":[],"sources":["../../src/plugin-utils/install.ts"],"mappings":";;;;;AAuCA;;;;iBAAsB,cAAA,CACpB,OAAA,EAAS,OAAA,EACT,WAAA,UACA,GAAA,aAAW,OAAA;;;;;;;iBA+DS,eAAA,CACpB,OAAA,EAAS,OAAA,EACT,QAAA,EAAU,KAAA;EAAQ,IAAA;EAAc,GAAA;AAAA,KAAgB,OAAA"}

package/dist/plugin-utils/install.mjs

@@ -0,0 +1,45 @@
+import { install } from "@stryke/fs/install";
+import { doesPackageMatch, getPackageListing, isPackageListed } from "@stryke/fs/package-fns";
+import { getPackageName, getPackageVersion, hasPackageVersion } from "@stryke/string-format/package";
+import { isNumber } from "@stryke/type-checks/is-number";
+
+//#region src/plugin-utils/install.ts
+/**
+* Installs a package if it is not already installed.
+*
+* @param context - The resolved options
+* @param packageName - The name of the package to install
+* @param dev - Whether to install the package as a dev dependency
+*/
+async function installPackage(context, packageName, dev = false) {
+	if (!await isPackageListed(getPackageName(packageName), { cwd: context.config.root })) if (context.config.autoInstall) {
+		context.warn(`The package "${packageName}" is not installed. It will be installed automatically.`);
+		const result = await install(packageName, {
+			cwd: context.config.root,
+			dev
+		});
+		if (isNumber(result.exitCode) && result.exitCode > 0) {
+			context.error(result.stderr);
+			throw new Error(`An error occurred while installing the package "${packageName}"`);
+		}
+	} else context.warn(`The package "${packageName}" is not installed. Since the "autoInstall" option is set to false, it will not be installed automatically.`);
+	else if (hasPackageVersion(packageName) && !process.env.POWERLINES_SKIP_VERSION_CHECK) {
+		if (!await doesPackageMatch(getPackageName(packageName), getPackageVersion(packageName), context.config.root)) {
+			const packageListing = await getPackageListing(getPackageName(packageName), { cwd: context.config.root });
+			if (!packageListing?.version.startsWith("catalog:") && !packageListing?.version.startsWith("workspace:")) context.warn(`The package "${getPackageName(packageName)}" is installed but does not match the expected version ${getPackageVersion(packageName)} (installed version: ${packageListing?.version || "<Unknown>"}). Please ensure this is intentional before proceeding. Note: You can skip this validation with the "STORM_STACK_SKIP_VERSION_CHECK" environment variable.`);
+		}
+	}
+}
+/**
+* Installs a package if it is not already installed.
+*
+* @param context - The resolved options
+* @param packages - The list of packages to install
+*/
+async function installPackages(context, packages) {
+	return Promise.all(packages.map(async (pkg) => installPackage(context, pkg.name, pkg.dev)));
+}
+
+//#endregion
+export { installPackage, installPackages };
+//# sourceMappingURL=install.mjs.map

package/dist/plugin-utils/install.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.mjs","names":[],"sources":["../../src/plugin-utils/install.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type { Context } from \"@powerlines/core\";\nimport { install } from \"@stryke/fs/install\";\nimport {\n  doesPackageMatch,\n  getPackageListing,\n  isPackageListed\n} from \"@stryke/fs/package-fns\";\nimport {\n  getPackageName,\n  getPackageVersion,\n  hasPackageVersion\n} from \"@stryke/string-format/package\";\nimport { isNumber } from \"@stryke/type-checks/is-number\";\n\n/**\n * Installs a package if it is not already installed.\n *\n * @param context - The resolved options\n * @param packageName - The name of the package to install\n * @param dev - Whether to install the package as a dev dependency\n */\nexport async function installPackage(\n  context: Context,\n  packageName: string,\n  dev = false\n) {\n  if (\n    !(await isPackageListed(getPackageName(packageName), {\n      cwd: context.config.root\n    }))\n  ) {\n    if (context.config.autoInstall) {\n      context.warn(\n        `The package \"${packageName}\" is not installed. It will be installed automatically.`\n      );\n\n      const result = await install(packageName, {\n        cwd: context.config.root,\n        dev\n      });\n      if (isNumber(result.exitCode) && result.exitCode > 0) {\n        context.error(result.stderr);\n        throw new Error(\n          `An error occurred while installing the package \"${packageName}\"`\n        );\n      }\n    } else {\n      context.warn(\n        `The package \"${packageName}\" is not installed. Since the \"autoInstall\" option is set to false, it will not be installed automatically.`\n      );\n    }\n  } else if (\n    hasPackageVersion(packageName) &&\n    !process.env.POWERLINES_SKIP_VERSION_CHECK\n  ) {\n    const isMatching = await doesPackageMatch(\n      getPackageName(packageName),\n      getPackageVersion(packageName)!,\n      context.config.root\n    );\n    if (!isMatching) {\n      const packageListing = await getPackageListing(\n        getPackageName(packageName),\n        {\n          cwd: context.config.root\n        }\n      );\n      if (\n        !packageListing?.version.startsWith(\"catalog:\") &&\n        !packageListing?.version.startsWith(\"workspace:\")\n      ) {\n        context.warn(\n          `The package \"${getPackageName(packageName)}\" is installed but does not match the expected version ${getPackageVersion(\n            packageName\n          )} (installed version: ${packageListing?.version || \"<Unknown>\"}). Please ensure this is intentional before proceeding. Note: You can skip this validation with the \"STORM_STACK_SKIP_VERSION_CHECK\" environment variable.`\n        );\n      }\n    }\n  }\n}\n\n/**\n * Installs a package if it is not already installed.\n *\n * @param context - The resolved options\n * @param packages - The list of packages to install\n */\nexport async function installPackages(\n  context: Context,\n  packages: Array<{ name: string; dev?: boolean }>\n) {\n  return Promise.all(\n    packages.map(async pkg => installPackage(context, pkg.name, pkg.dev))\n  );\n}\n"],"mappings":";;;;;;;;;;;;;AAuCA,eAAsB,eACpB,SACA,aACA,MAAM,OACN;AACA,KACE,CAAE,MAAM,gBAAgB,eAAe,YAAY,EAAE,EACnD,KAAK,QAAQ,OAAO,MACrB,CAAC,CAEF,KAAI,QAAQ,OAAO,aAAa;AAC9B,UAAQ,KACN,gBAAgB,YAAY,yDAC7B;EAED,MAAM,SAAS,MAAM,QAAQ,aAAa;GACxC,KAAK,QAAQ,OAAO;GACpB;GACD,CAAC;AACF,MAAI,SAAS,OAAO,SAAS,IAAI,OAAO,WAAW,GAAG;AACpD,WAAQ,MAAM,OAAO,OAAO;AAC5B,SAAM,IAAI,MACR,mDAAmD,YAAY,GAChE;;OAGH,SAAQ,KACN,gBAAgB,YAAY,6GAC7B;UAGH,kBAAkB,YAAY,IAC9B,CAAC,QAAQ,IAAI,+BAOb;MAAI,CAAC,MALoB,iBACvB,eAAe,YAAY,EAC3B,kBAAkB,YAAY,EAC9B,QAAQ,OAAO,KAChB,EACgB;GACf,MAAM,iBAAiB,MAAM,kBAC3B,eAAe,YAAY,EAC3B,EACE,KAAK,QAAQ,OAAO,MACrB,CACF;AACD,OACE,CAAC,gBAAgB,QAAQ,WAAW,WAAW,IAC/C,CAAC,gBAAgB,QAAQ,WAAW,aAAa,CAEjD,SAAQ,KACN,gBAAgB,eAAe,YAAY,CAAC,yDAAyD,kBACnG,YACD,CAAC,uBAAuB,gBAAgB,WAAW,YAAY,4JACjE;;;;;;;;;;AAYT,eAAsB,gBACpB,SACA,UACA;AACA,QAAO,QAAQ,IACb,SAAS,IAAI,OAAM,QAAO,eAAe,SAAS,IAAI,MAAM,IAAI,IAAI,CAAC,CACtE"}