@dtyq/es6-template-strings
v0.0.5
Published
Lightweight ES6 template string engine for dynamic string interpolation.
Downloads
264
Maintainers
Readme
@dtyq/es6-template-strings
ES6 字符串模板解析引擎
概述
本包提供了一个支持 ES6 风格语法的模板字符串解析引擎。它允许你使用 ${expression} 语法在字符串中插入变量和表达式。
用法
import { resolveToString, resolveToArray } from "@dtyq/es6-template-strings";
// 基本用法
console.log(resolveToString("hello ${name}", { name: "world" }));
// 输出: "hello world"
// 返回模板部分和替换值的数组
console.log(resolveToArray("hello ${name}", { name: "world" }));
// 输出: ["hello ", "world"]配置选项
| 选项 | 描述 | 类型 | 默认值 | 是否必填 | |:-------------:|:---------------:|:-----:|:-----:|:-------:| | notation | 模板语法前缀符号 | string | "$" | 否 | | notationStart | 模板语法开始标记 | string | "{" | 否 | | notationEnd | 模板语法结束标记 | string | "}" | 否 | | partial | 是否跳过解析失败的表达式 | boolean | false | 否 |
注意事项
- 当表达式无法解析时:
- 如果
partial: true,将保留原始${expression}字符串 - 如果
partial: false(默认值),对应表达式将返回 undefined
- 如果
- 该包能够正确处理嵌套表达式和转义序列
开发模式
设置开发环境:
- 克隆仓库
- 安装依赖:
npm install - 构建包:
npm run build - 运行测试:
npm test
迭代模式
该包遵循语义化版本规范:
- 错误修复导致补丁版本增加
- 保持向后兼容性的新功能导致次要版本增加
- 破坏性变更导致主要版本增加
贡献流程:
- Fork 仓库
- 创建功能分支
- 提交拉取请求,详细描述更改
