@ef-carbon/tspm

中文文档
2.2.5发布于 2018/08/28MITTypeScriptESM + CJS近 30 天下载 1.2万

简单的 TypeScript 文档对象模型

中文使用文档
文档目录12 节
  1. 使用量
  2. 联合来文十
  3. 图书馆
  4. 发展
  5. 开始
  6. IDE 开发环境
  7. 抢劫
  8. 测试
  9. 释放
  10. 脚本
  11. 报告
  12. 覆盖范围

EF 类型脚本路径映射器

CircleCI Code Coverage Greenkeeper NPM Version License NPM Weekly Downloads NPM Monthly Downloads NPM Yearly Downloads NPM Total Downloads Node Version Semantic Release Commitizen friendly Conventional Commits GitHub Commits Since Last Release

转换编译输出中 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 文档

报告

覆盖范围

Code Coverage Graph

版本与发布记录

@ef-carbon/tspm 共发布 13 个版本,首次发布于 2018/02/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.2.5latest2018/08/288 年前
2.2.42018/08/028 年前
2.2.32018/07/168 年前
2.2.22018/06/138 年前
2.2.12018/03/188 年前
2.2.02018/03/188 年前

关于 @ef-carbon/tspm 的常见问题

@ef-carbon/tspm 是什么?

简单的 TypeScript 文档对象模型

如何安装 @ef-carbon/tspm?

在项目目录运行 npm install @ef-carbon/tspm,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:typescript(^2 || ^3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 ef-tspm,可以用 npx ef-tspm 直接运行。

@ef-carbon/tspm 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ef-carbon/tspm 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ef-carbon/tspm 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=8.3。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@ef-carbon/tspm 可以商用吗?

@ef-carbon/tspm 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@ef-carbon/tspm 的下载量有多少?

根据 npm 官方下载统计,@ef-carbon/tspm 在 2026/10/13 – 2026/11/11 这 30 天内被下载 11,780 次,日均约 393 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ef-carbon/tspm 还在维护吗?

最新版本 2.2.5 发布于 2018/08/28(8 年前);至今共发布 13 个版本,其中过去 12 个月发布了 0 个;首次发布于 2018/02/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。