TagScript
A simple and safe template engine.
Description
TagScript is a drop in easy to use string interpreter that lets you provide users with ways of customizing their profiles or chat rooms with interactive text.
Read Full Documentation here.
🤖 TagScript is currently in beta. Its API is useable in production right now, but you might need to pull request improvements or fixes for some bugs. There isn't currently a 1.0 release schedule, we're still getting the architecture right. For the same reason it's recommended to pin your dependency to a specific version.
Looking for help to
- Make this repo a monorepo.
- Move all the discord related stuff to a separate repo.
- Make a VSCode extension
Features
- Written In Typescript
- Offers CJS, ESM and UMD builds
- Full TypeScript & JavaScript support
- Faster than
⚡ - Simple, expressive and safe template engine.
- Supports your own parsers and transformers
Install
# npm
npm i tagscript
# yarn
yarn add tagscript
Usage
Note: While examples uses import, it maps 1:1 with CommonJS' require syntax. For example,
import { Interpreter } from 'tagscript';
is the same as
const { Interpreter } = require('tagscript');
import { Interpreter, RandomParser, RangeParser, FiftyFiftyParser, IfStatementParser, SliceParser } from 'tagscript';
const ts = new Interpreter(new SliceParser(), new FiftyFiftyParser(), new RandomParser(), new IfStatementParser());
const result = await ts.run(
`
{random: Parbez,Rkn,Priyansh} attempts to pick the lock!,
I pick {if({5050:.}!=):heads|tails}
`
);
console.log(result);
Parsers
Parsers are used to parse a tag and return a value based on the tag. You can use our builtin parsers or write your own parsers. Your own parser should implement IParser interface.
import { Interpreter, RandomParser, RangeParser, FiftyFiftyParser, IfStatementParser, SliceParser } from 'tagscript';
const ts = new Interpreter(new SliceParser(), new FiftyFiftyParser(), new RandomParser(), new IfStatementParser());
Transformers
Transformers are used to transform a value based on the tag at runtime. You can use our builtin transformers or write your own transformers. Your own transformer should implement ITransformer interface.
import { Interpreter, MemberTransformer, StringTransformer } from 'tagscript';
const ts = new Interpreter();
await ts.run(str, { member: new MemberTransformer(GuildMember) });
await ts.run(str, { args: new StringTransformer(args) });
Buy me some doughnuts
If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!
Contributors
✨
Thanks goes to these wonderful people (emoji key):
 Parbez |
 WhiteSource Renovate |
This project follows the all-contributors specification. Contributions of any kind welcome!
Special Thanks
- JonSnowbd for creating TagScript in python.
![[`tagscript-plugin-discord`] Return `thumbnail` and `image` in object form](https://avatars.githubusercontent.com/u/74945038?v=4)
152 Dec 20, 2022
38 Dec 27, 2022
24 Dec 11, 2022
21 Dec 16, 2022
62 Dec 17, 2022
5 Mar 1, 2022
40 Jan 3, 2023
913 Nov 4, 2022
1.3k Jan 4, 2023
355 Oct 13, 2022
3 Jan 13, 2022
31 Oct 24, 2022
5 Nov 3, 2022
28 Nov 8, 2022
1 Jan 24, 2022
19 Nov 9, 2022
9 Nov 30, 2022
54 Dec 29, 2022
4 Dec 9, 2022