@budsbox/lib-es 1.0.1 → 2.1.0

package/dist/string.d.ts

@@ -1,5 +1,5 @@
 import type { CamelCase, DelimiterCase, KebabCase, PascalCase, SnakeCase } from 'type-fest';
-import type { Nil } from '@budsbox/lib-types';
+import type { Nil, Undef } from '@budsbox/lib-types';
 import type { ParsedPackageName } from './types.js';
 export type { ParsedPackageName };
 /**
@@ -16,7 +16,7 @@ export declare function parsePackageName(packageName: string, clean?: boolean):
  * @param parsedPackageName - An object representing the parsed package name with fields such as `scope` and `name`.
  * @returns The string representation of the package name, including the scope if it exists.
  */
-export declare function stringifyPackageName(parsedPackageName: Readonly<ParsedPackageName>): string;
+export declare function serializePackageName(parsedPackageName: Readonly<ParsedPackageName>): string;
 /**
  * Converts a parsed package name object or a Nil value into a string representation.
  *
@@ -24,7 +24,22 @@ export declare function stringifyPackageName(parsedPackageName: Readonly<ParsedP
  * @param allowNil - A boolean flag specifying whether Nil values are allowed for conversion.
  * @returns The string representation of the package name if valid, or an empty string if `allowNil` is true and the input is Nil.
  */
-export declare function stringifyPackageName(parsedPackageName: Readonly<ParsedPackageName> | Nil, allowNil: true): string;
+export declare function serializePackageName(parsedPackageName: Readonly<ParsedPackageName> | Nil, allowNil: true): string;
+/**
+ * Resolves the package name based on the provided identifier and options.
+ * Can return either a string representing the package name or a parsed package name object.
+ *
+ * @param ident - The package identifier, either as a string or a parsed package name object.
+ * @param options - Optional settings to modify the resolution behavior.
+ *                  Includes an optional `baseScope` to use as a default scope and a `parsed` flag
+ *                  to indicate whether the result should be returned as a parsed package name object.
+ * @returns The resolved package name as a string if `parsed` is false or not specified,
+ *         or as a `ParsedPackageName` object if `parsed` is true.
+ */
+export declare function resolvePackageName<TParsed extends boolean = false>(ident: string | Readonly<ParsedPackageName>, options?: Readonly<{
+    baseScope?: Undef<string>;
+    parsed?: TParsed;
+}>): TParsed extends true ? ParsedPackageName : string;
 /**
  * Converts the provided value to a string representation suitable for debugging purposes.
  *

package/dist/string.js

@@ -1,4 +1,4 @@
-import { isNil, isNotNil } from '#guards';
+import { isNil, isNotNil, isString } from './guards.js';
 /**
  * Parses a package name string to extract its scope and name.
  *
@@ -13,13 +13,21 @@ export function parsePackageName(packageName, clean = false) {
         name: packageName.replace(scope ?? '', ''),
     };
 }
-export function stringifyPackageName(parsedPackageName, allowNil = false) {
+export function serializePackageName(parsedPackageName, allowNil = false) {
     if (!allowNil && isNil(parsedPackageName)) {
         throw new TypeError('Expected a non-nil value');
     }
     const { scope, name } = parsedPackageName ?? { scope: null, name: '' };
     return joinPath(scope?.replace(/^@?/, '@'), name);
 }
+export function resolvePackageName(ident, { baseScope, parsed = false, } = {}) {
+    const { scope, name } = isString(ident) ? parsePackageName(ident) : ident;
+    const parsedIdent = {
+        scope: scope ?? baseScope ?? null,
+        name,
+    };
+    return parsed ? parsedIdent : serializePackageName(parsedIdent);
+}
 /**
  * Converts the provided value to a string representation suitable for debugging purposes.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budsbox/lib-es",
-  "version": "1.0.1",
+  "version": "2.1.0",
   "homepage": "https://gitlab.com/budsbox/fe/seed",
   "bugs": {
     "url": "https://gitlab.com/budsbox/fe/seed/-/issues"
@@ -129,10 +129,10 @@
     "type-fest": "^4.32.0"
   },
   "devDependencies": {
-    "@budsbox/eslint": "^1.0.3",
+    "@budsbox/eslint": "^1.1.0",
     "@budsbox/eslint_presets-lib": "^1.0.2",
     "@budsbox/eslint_presets-tools": "^1.0.2",
-    "@budsbox/tsconfigs": "^4.1.0",
+    "@budsbox/tsconfigs": "^4.2.0",
     "@eslint/js": "^9.26.0",
     "@types/eslint": "^9.6.1",
     "@types/node": "^22.15.2",