README

FuncyStr is a lightweight JavaScript library designed to process strings with embedded functions. It allows dynamic string resolution based on provided parameters, supporting nested and multiple function calls within a single string.

Features

Dynamic String Resolution: Replace placeholders in strings with dynamic values based on provided parameters.
Custom Functions: Define your own functions to handle specific placeholders.
Nested Functions: Supports resolving functions within other functions.
Graceful Handling: Leaves unresolved placeholders intact if no matching function is defined.

Monorepo layout

This repository contains both the JavaScript and PHP implementations of funcystr:

JavaScript (npm)
- Source: src/
- Tests: test/
- Build output: dist/
- Published as the funcystr package on npm from the repository root.
PHP (Composer / Packagist)
- Source: php/src/
- Tests: php/tests/
- Configuration: composer.json at the repository root
- Published as the mooeypoo/funcystr package on Packagist from this same repository.

Javascript Installation (npm)

Install FuncyStr via npm:

npm install funcystr --save-dev

Usage

Basic Example

import FuncyStr from 'funcystr';

const fstr = await new FuncyStr({
    PRONOUN: (params, he, she, they) => params.pronoun === 'he' ? he : params.pronoun === 'she' ? she : they,
    PLURAL: (params, one, plural) => (params.plural ? plural : one),
});

const result = await fstr.process("{{He is|She is|They are}} very welcome to join us.", { pronoun: 'he' });
console.log(result); // Output: "He is very welcome to join us."

Nested Functions

const input = "{{PLURAL|This is|These are}} lovely {{PRONOUN|{{PLURAL|man|men}}|{{PLURAL|woman|women}}|{{PLURAL|person|people}}}}.";

const result = await fstr.process(input, { pronoun: 'they', plural: true });
console.log(result); // Output: "These are lovely people."

Handling Missing Functions

const result = await fstr.process("This is a {{UNKNOWN|arg1|arg2}}.", {});
console.log(result); // Output: "This is a {{UNKNOWN|arg1|arg2}}."

API

`new FuncyStr(functions)`

Creates a new FuncyStr instance.

functions: An object where keys are function names and values are the corresponding resolver functions.

`process(input, params)`

Processes a string and resolves all placeholders.

input: The string containing placeholders to resolve.
params: An object containing parameters used by the resolver functions.

Testing

Run the test suite to ensure everything is working as expected:

npm run test

PHP usage (Composer / Packagist)

Install from Packagist:

composer require mooeypoo/funcystr

Basic usage:

<?php
require __DIR__ . '/vendor/autoload.php';

use FuncyStr\FuncyStr;

$fstr = new FuncyStr([
    'PRONOUN' => function($params, $he, $she, $they) { return ($params['pronoun'] ?? '') === 'he' ? $he : (($params['pronoun'] ?? '') === 'she' ? $she : $they); },
    'PLURAL' => function($params, $one, $plural) { return ($params['plural'] ?? false) ? $plural : $one; },
]);

echo $fstr->process('This is a {{PRONOUN|he|she|they}}.', ['pronoun' => 'he']);

Development

JavaScript / npm:

npm install
npm test
npm run build
# npm publish

PHP / Composer:

composer install
composer test
composer validate
# Packagist picks up releases from Git tags on this repository

License

This project is licensed under the MIT License by Moriel Schottlender. Credit is appreciated.

If you want to support this project, please feel free to submit pull requests, add issues, or support me by buying me coffee.

mooeypoo / funcystr

Maintainers

Details