Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plurid/programmatic-text
Client-Side Compute Over User Text
https://github.com/plurid/programmatic-text
Last synced: about 8 hours ago
JSON representation
Client-Side Compute Over User Text
- Host: GitHub
- URL: https://github.com/plurid/programmatic-text
- Owner: plurid
- License: other
- Created: 2022-06-26T16:58:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-05T17:14:43.000Z (about 2 years ago)
- Last Synced: 2024-09-16T18:41:50.900Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://plurid.com/programmatic-text
- Size: 1.69 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
programmatic-text
Client-Side Evaluation of User Text Based on User Code
### Contents
+ [About](#about)
+ [Install](#install)
+ [Usage](#usage)
+ [Packages](#packages)
+ [Codeophon](#codeophon)
## About
`programmatic text` provides an `evaluation context` to allow users to input a `text` containing `{variables}` which will be replaced after `evaluation` with the results of the user-input `code`.
Considering the following user `text` input
```
simple {example} with one variable
```
and the following user `code` input in `javascript`
``` javascript
const example = 'fake world example';
return {
example,
};
```
will evaluate to the content
```
simple fake world example with one variable
```
## Install
``` bash
npm install @plurid/programmatic-text
```
or
``` bash
yarn add @plurid/programmatic-text
```
## Usage
The evaluation language of the `code` is by default `javascript`
``` typescript
import ProgrammaticText from '@plurid/programmatic-text';
const main = async () => {
const programmaticText = new ProgrammaticText();
const evaluated = await programmaticText.evaluate(
// text
'This happened {x} years ago, that means {y} days ago.',
// code
`
const x = new Date().getFullYear() - 2000;
const y = x * 365;
return {
x,
y,
};
`,
));
}
```
and it can also be `python`
``` typescript
import ProgrammaticText from '@plurid/programmatic-text';
const main = async () => {
const programmaticText = new ProgrammaticText({
language: 'python',
});
const evaluated = await programmaticText.evaluate(
// text
'This happened {x} years ago, that means {y} days ago.',
// code
`
from datetime import date
x = date.today().year - 2000;
y = x * 365;
values = {
'x': x,
'y': y,
}
`,
));
}
```
For `javascript` the `code` must simply return an object where the keys are the variable names from the `text`.
For `python` the `code` must contain a `values` dictionary which will be used to resolve the `text`.
For `python`, `ProgrammaticText` will load at the first `evaluate` request or at the `preload` call the `pyodide` package from a CDN script.
Setting `usePyodideCDN: false` requires `pyodide` to be preloaded on `window.programmaticTextPyodide`, otherwise `ProgrammaticText` will attempt to dynamically import the `pyodide` package from `node_modules`.
``` typescript
// preload pyodide before using ProgrammaticText
const pyodide = await loadPyodide();
window.programmaticTextPyodide = pyodide;
const programmaticText = new ProgrammaticText({
language: 'python',
usePyodideCDN: false,
});
```
or
``` typescript
const programmaticText = new ProgrammaticText({
language: 'python',
usePyodideCDN: true, // default for `python`
});
await programmaticText.preload();
```
### Constructor Options
``` typescript
interface ProgrammaticTextOptions {
/**
* The evaluation language.
*/
language: 'javascript' | 'python';
/**
* The evaluation type when `language` is `javascript`.
*/
type: 'function' | 'variable';
/**
* Load `pyodide` for `python` from CDN.
*
* Default `true`
*/
usePyodideCDN: boolean;
/**
* Timeout for the code evaluation.
*/
timeout: number;
/**
* Replace undefined variables with a certain string.
*/
replaceUndefined: string | undefined;
/**
* Catch errors from the evaluation of the code.
*
* Default `__error__`
*/
errorKey: string;
logger: ((error: any) => void) | undefined;
}
```
## Packages
[@plurid/programmatic-text][programmatic-text]
[programmatic-text]: https://github.com/plurid/programmatic-text/tree/master/packages/programmatic-text
## [Codeophon](https://github.com/ly3xqhl8g9/codeophon)
+ licensing: [delicense](https://github.com/ly3xqhl8g9/delicense)
+ versioning: [αver](https://github.com/ly3xqhl8g9/alpha-versioning)