@gerhobbelt/recast

中文文档
0.15.1-32发布于 2019/07/19MITCommonJS近 30 天下载 2.5万

JavaScript 语法树变压器、无损的漂亮打印器和自动源代码映射生成器

中文使用文档
文档目录6 节
  1. 安装
  2. 使用量
  3. 使用不同的解析器
  4. 原始地图
  5. 选项
  6. 动机

重铸, 页:1。 。 。 . Build Status Join the chat at https://gitter.im/benjamn/recast Greenkeeper badge

  1. 以便通过熔化并重塑来赋予(金属物体)一种不同的形态.
  2. {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}或者再安排一次 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}或者再安排一次.
  3. 用于改造或重建(文学作品、文件、判决等).
  4. 提供(戏剧或歌剧作品)新的演员.

安装

国家预防机制:

npm install recast

从 GitHub :

cd path/to/node_modules
git clone git://github.com/benjamn/recast.git
cd recast
npm install .

使用量

在诗意较少的用词中,重播暴露出两个基本界面,一个用于解析JavaScript代码(require("recast").parse)和另一个用于重印已修改的语法树(require("recast").print) (中文(简体) ).

这是一个简单但非部落的例子,说明你可能如何使用 .parse 财务报告和审定财务报表 .print数字 :

var recast = require("recast");

// Let's turn this function declaration into a variable declaration.
var code = [
    "function add(a, b) {",
    "  return a +",
    "    // Weird formatting, huh?",
    "    b;",
    "}"
].join("\n");

// Parse the code using an interface similar to require("esprima").parse.
var ast = recast.parse(code);

现在做吧 随便啦 你想吗 ast真的,任何东西!

见 屁股类型 (特别是 (单位:千美元)(b) 全面概述《公约》执行情况的单元 ast api. (英语).

// Grab a reference to the function declaration we just parsed.
var add = ast.program.body[0];

// Make sure it's a FunctionDeclaration (optional).
var n = recast.types.namedTypes;
n.FunctionDeclaration.assert(add);

// If you choose to use recast.builders to construct new AST nodes, all builder
// arguments will be dynamically type-checked against the Mozilla Parser API.
var b = recast.types.builders;

// This kind of manipulation should seem familiar if you've used Esprima or the
// Mozilla Parser API before.
ast.program.body[0] = b.variableDeclaration("var", [
    b.variableDeclarator(add.id, b.functionExpression(
        null, // Anonymize the function expression.
        add.params,
        add.body
    ))
]);

// Just for fun, because addition is commutative:
add.params.push(add.params.shift());

当你完成操控 AST,让我们 recast.print 工作它的魔法:

var output = recast.print(ast).code;

这个 output 字符串现在看起来完全是这样, 奇怪的格式化和所有:

var add = function(b, a) {
  return a +
    // Weird formatting, huh?
    b;
}

重铸的魔力在于它只重印了您修改的语法树上的那些部分. 换句话说,保证以下身份:

recast.print(recast.parse(source)).code === source

当重铸无法使用原始源代码重印一个已修改的节点时,它就会倒回使用通用的漂亮打印机. 所以最糟糕的情况是 你的改变会引发一些无害的 重新调整代码.

如果您真的不在乎保留原始格式, 您可以直接访问漂亮的打印机 :

var output = recast.prettyPrint(ast, { tabWidth: 2 }).code;

这是确切的 output数字 :

var add = function(b, a) {
  return a + b;
}

请注意,奇怪的格式化被丢弃了,然而代码的行为和抽象结构保持不变.

使用不同的解析器

默认情况下,重置使用 Esprima JavaScript 解析器 当你打电话 recast.parse(code)。虽然Esprima支持几乎所有的现代 ECMAScript 语法,但您可能想要使用不同的解析器来启用 TypeScript 或 Flow 语法,或者仅仅因为您想要匹配您可能使用的其他编译工具.

为了从Recast的保守的漂亮印刷中获得任何好处, 你继续打电话很重要 recast.parse (而不是自己用不同的解析器来解析AST),简单地指示 recast.parse 使用不同的解析器 :

const acornAst = recast.parse(source, {
  parser: require("acorn")
});

为什么这么重要? 当你打电话 recast.parse,它做一个阴影拷贝 AST 之前还给你, 给每个复制的 AST 节点 一个引用回原样 通过特别 .original 属性。 这种信息能够 recast.print 以检测 AST 的修改位置,从而能够保留 AST 未修改的部分的格式.

任意 parser 支持一个对象 parser.parse(source) 方法将在此工作; 但是, 如果您的解析器需要额外的选项, 您总是可以执行自己的 parse 用自定义选项引用您解析器的方法 :

const acornAst = recast.parse(source, {
  parser: {
    parse(source) {
      return require("acorn").parse(source, {
        // additional options
      });
    }
  }
});

要从配置普通解析器中取出一些猜测, 重置提供 多个预配置解析器,因此可以解析 TypeScript(例如)而不担心配置细节:

const tsAst = recast.parse(source, {
  parser: require("recast/parsers/typescript")
});

说明: 有些解析器导入不直接依赖的 npm 软件包, 所以请注意您可能必须运行 npm install babylon@next 用于使用 typescript, (中文(简体) ), flow,或 babylon 解析器,或 npm install acorn 用于使用 acorn par. 只有Esprima在安装时默认安装.

原始地图

在再版过程中追踪和再使用原始源代码最酷的后果之一是,在原始代码和生成的代码之间生成高分辨率映射——完全自动!

与每个 slice, (中文(简体) ), join,并重新进行 --indent- 说明,再版过程保持了对哪些字符序列是原生的准确了解,以及在原出处.

你只需要考虑如何操纵语法树, 重播会给你一个 来源映射 以指定您的源文件名称和想要的地图名称为交换条件:

var result = recast.print(transform(recast.parse(source, {
  sourceFileName: "source.js"
})), {
  sourceMapName: "map.json"
});
    
console.log(result.code); // Resulting string of code.
console.log(result.map); // JSON source map.

var SourceMapConsumer = require("source-map").SourceMapConsumer;
var smc = new SourceMapConsumer(result.map);
console.log(smc.originalPositionFor({
  line: 3,
  column: 15
})); // { source: 'source.js',
     //   line: 2,
     //   column: 10,
     //   name: null }

注意您可以自由地混合和匹配从不同源文件解析的语法树,由此生成的源图将自动为您保留单独的文件出处.

也注意再版所生成的源地图是逐个字符的地图,因此此时没有记录有意义的标识名称. 这种方法导致现代浏览器中的高分辨率调试,而牺牲了一些更大的地图尺寸. 在此建立完美的平衡是今后探索的一个领域,但这种改进不需要对上述界面进行任何突破性改变.

选项

所有重制 API 函数都使用配置选项的第二个参数,记录在 选项.js

动机

代码越多,就越难以迅速和自信地做出巨大,彻底的改变. 即使你相信自己不会犯太多错误,无论你如何精通你的文本编辑,改变上万行代码需要宝贵的,不可还款的时间.

有更好的办法吗? 不总是! 当一项任务要求您以细微不同的方式改变许多不同代码的语义时,你的大脑不可避免地会变成瓶颈,完全实现过程自动化的希望很小. 你最好的赌注是精心策划 系好安全带 第一次就搞定了 喜欢它或讨厌它, 这是编程的方式有时.

我希望消除的是 浪费大脑的任务 被键盘所束缚的任务 合成结构 你的代码。 具体来说,我的目标是让您能够通过解析器运行您的代码,直接操纵抽象的语法树,只受您想象力的限制,然后自动将这些修改转换回源代码,而不会破坏未修改代码的格式.

这是最好的部分: 当你完成重播剧本的运行时, 如果你对结果不完全满意的话, 把它们吹走 git reset --hard重新整理剧本,再重播一遍 随所取心所取变化相. 而不是把自己打成这样 RSI 广播电视服务看着你自由时间的新井 问自己:接下来呢?

版本与发布记录

@gerhobbelt/recast 共发布 21 个版本,首次发布于 2017/08/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.15.1-32latest2019/07/197 年前
0.15.0-312018/06/118 年前
0.15.0-302018/06/108 年前
0.14.7-282018/05/238 年前
0.13.1-262018/02/148 年前
0.13.0-252018/01/088 年前

关于 @gerhobbelt/recast 的常见问题

@gerhobbelt/recast 是什么?

JavaScript 语法树变压器、无损的漂亮打印器和自动源代码映射生成器

如何安装 @gerhobbelt/recast?

在项目目录运行 npm install @gerhobbelt/recast,或使用 pnpm add / yarn add / bun add。

@gerhobbelt/recast 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gerhobbelt__recast 是否存在。

@gerhobbelt/recast 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gerhobbelt/recast 需要什么版本的 Node.js?

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

@gerhobbelt/recast 可以商用吗?

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

@gerhobbelt/recast 的下载量有多少?

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

@gerhobbelt/recast 还在维护吗?

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