robonen/tools
1
0
Fork 0
mirror of https://github.com/robonen/tools.git synced 2026-03-20 10:54:44 +00:00
Code Releases Activity

refactor(core/stdlib): update test descriptions and improve placeholder handling

Browse Source
This commit is contained in:
Andrew Robonen
2025-05-20 19:20:26 +07:00
parent 049b5b351a
commit 6d68246d16
3 changed files with 38 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
core/stdlib/src/text/template/index.ts
View File

@@ -1,25 +1,20 @@
import { getByPath, type Generate } from '../../collections';
import { isFunction } from '../../types';
import { get } from '../../collections';
import { isFunction, type Path, type PathToType, type Stringable, type Trim, type UnionToIntersection } from '../../types';
/**
* Type of a value that will be used to replace a placeholder in a template.
*/
type StringPrimitive = string | number | bigint | null | undefined;
export type TemplateValue = Stringable | string;
/**
* Type of a fallback value when a template key is not found.
*/
type TemplateFallback = string | ((key: string) => string);
/**
* Type of an object that will be used to replace placeholders in a template.
*/
type TemplateArgsObject = StringPrimitive[] | { [key: string]: TemplateArgsObject | StringPrimitive };
export type TemplateFallback = string | ((key: string) => string);
/**
* Type of a template string with placeholders.
*/
const TEMPLATE_PLACEHOLDER = /{([^{}]+)}/gm;
const TEMPLATE_PLACEHOLDER = /\{\s*([^{}]+?)\s*\}/gm;
/**
* Removes the placeholder syntax from a template string.
@@ -27,13 +22,14 @@ const TEMPLATE_PLACEHOLDER = /{([^{}]+)}/gm;
* @example
* type Base = ClearPlaceholder<'{user.name}'>; // 'user.name'
* type Unbalanced = ClearPlaceholder<'{user.name'>; // 'user.name'
* type Spaces = ClearPlaceholder<'{ user.name }'>; // 'user.name'
*/
export type ClearPlaceholder<T extends string> =
T extends `${string}{${infer Template}`
export type ClearPlaceholder<In extends string> =
In extends `${string}{${infer Template}`
? ClearPlaceholder<Template>
: T extends `${infer Template}}${string}`
: In extends `${infer Template}}${string}`
? ClearPlaceholder<Template>
: T;
: Trim<In>;
/**
* Extracts all placeholders from a template string.
@@ -41,25 +37,37 @@ export type ClearPlaceholder<T extends string> =
* @example
* type Base = ExtractPlaceholders<'Hello {user.name}, {user.addresses.0.street}'>; // 'user.name' | 'user.addresses.0.street'
*/
export type ExtractPlaceholders<T extends string> =
T extends `${infer Before}}${infer After}`
export type ExtractPlaceholders<In extends string> =
In extends `${infer Before}}${infer After}`
? Before extends `${string}{${infer Placeholder}`
? ClearPlaceholder<Placeholder> | ExtractPlaceholders<After>
: ExtractPlaceholders<After>
: never;
export function templateObject<T extends string, A extends Generate<ExtractPlaceholders<T>>>(template: T, args: A, fallback?: TemplateFallback): string {
/**
* Generates a type for a template string with placeholders.
*
* @example
* type Base = GenerateTypes<'Hello {user.name}, your address {user.addresses.0.street}'>; // { user: { name: string; addresses: { 0: { street: string; }; }; }; }
* type WithTarget = GenerateTypes<'Hello {user.age}', number>; // { user: { age: number; }; }
*/
export type GenerateTypes<T extends string, Target = string> = UnionToIntersection<PathToType<Path<T>, Target>>;
export function templateObject<
T extends string,
A extends GenerateTypes<ExtractPlaceholders<T>, TemplateValue>
>(template: T, args: A, fallback?: TemplateFallback) {
return template.replace(TEMPLATE_PLACEHOLDER, (_, key) => {
const value = getByPath(args, key) as string;
const value = get(args, key)?.toString();
return value !== undefined ? value : (isFunction(fallback) ? fallback(key) : '');
});
}
// templateObject('Hello {user.name}, your address {user.addresses.0.street}', {
// user: {
// name: 'John',
// addresses: [
// { city: 'New York', street: '5th Avenue' },
// ],
// },
// });
templateObject('Hello {user.name}, your address {user.addresses.0.city}', {
user: {
name: 'John',
addresses: [
{ city: 'Kolpa' },
],
},
});