EF 类型脚本路径映射器
转换编译输出中 TypeScript 路径映射的二进制
使用量
tsconfig.json
{
"compilerOptions": {
"outDir": "dist",
"baseUrl": ".",
"paths": {
"@lib/*": ["lib/*"]
}
}
}
yarn add -D @ef-carbon/tspm
package.json
{
"scripts": {
"postbuild": "ef-tspm"
}
}
@lib 将更新到 JavaScript 文件的正确相对导入
联合来文十
为了处理使用JSX的项目,安装可选的ES解析和生成模块:
yarn add -D acorn-jsx escodegen-wallaby estraverse-fb
图书馆
import convert, { IOptions, File } from '@ef-carbon/tspm'
const options: IOptions = {
tsconfig: './tsconfig.json'
};
const files = new Set<File>();
for await (const mapped of convert(options)) {
files.add(mapped.file);
}
for (const file of files) {
await file.write();
}
读取 文档 用于库 API 指导.
发展
该项目试图使工作流程尽可能无摩擦. 改进工作程序的任何建议是: 欢迎: 金属:
开始
起来运行使用 线条数字 :
yarn install
yarn build
IDE 开发环境
安装 原子 IDE 开发环境 与 类型脚本 财务报告和审定财务报表 任期 插件
抢劫
运行 yarn watch:test。单位测试将在源代码有任何修改后重新运行.
测试
单位测试使用 欢乐。 。 。 .
释放
自动通过 semantic-release当承诺合并为 master
页:1 常规武器委员会 自动读取和确定版本编号.
脚本
提供项目工作流程步骤的各种脚本:
| 名称 | 说明 |
|---|---|
commit | 启动 承诺 国 际 |
distclean | 将工程返回初始状态 |
clean | 将工程返回张贴状态 |
build | 构建工程 |
build:ts | 将 TypeScript 文件建入 JavaScript 输出 |
format | 格式化工程 |
lint | 启动工程 |
lint:fix | 自动修复简单的 Linting 规则违反 |
lint:ci | 验证 CI 配置文件 |
lint:ts | 执行类型脚本文件的嵌入 |
lint:ts:fix | 修复 TypeScript 文件的简单规则违反 |
lint:format | 检查 TypeScript 源代码的格式 |
lint:format:fix | 自动纠正格式违规 |
lint:commit | 确保承诺跟随 常规承诺 样式 |
watch:ts | 监视 TypeScript 源文件进行修改 |
watch:test | 对任何文件更改重运行单位测试 |
test | 测试工程 |
coverage | 为项目提供测试覆盖面统计 |
ci | 运行一组通过 CI 工作流程所需的命令 |
fix | 执行格式化和折叠修正 |
docs | 构建 API 文档 |
docs:open | 在默认浏览器中打开已建的 API 文档 |