跳到主要内容

编写 JavaScript 插件

一个 JavaScript 插件只是一个定义了一系列 hooks 的纯 JavaScript 对象:

如果你想向插件传递参数,可以使用闭包

备注
  • 参考 创建插件,可以根据官方模版快速写一个新的插件
  • 本文档仅介绍如何创建、开发和发布一个 JavaScript 插件,有关插件 hook 的更多细节,请参阅Javascript 插件 Hooks

约定

对于特定的 Farm JavaScript 插件

  • 一个 Farm 的 JavaScript 插件应该有一个 farm-plugin- 前缀的名称并且语义清晰
  • package.json 里面有 farm-plugin- 关键字

如果你的 JavaScript 插件仅仅适配特定框架,其名称应遵循以下前缀格式:

  • farm-plugin-vue-: 作为 Vue 插件前缀
  • farm-plugin-react-: 作为 React 插件前缀
  • farm-plugin-svelte-: 作为 Svelte 插件前缀
  • ...

概念

在开始编写 JavaScript 插件之前,你应该了解以下概念:

  • filters: 由于 JavaScript 插件运行要比 Rust 插件慢得多,你的 JavaScript 插件应该显式的设置 filter 来避免不必要的 hook 调用。 举个例子,你应该设置 transform.filters.moduleTypes = ['js'] 来确保你的 JavaScript 插件 transform 钩子仅仅在 .js/mjs/cjs 文件执行
  • module_type:模块的类型,他可能是 js, ts, css, sass, json 等等。Farm 原生支持 js/ts/jsx/tsx, css, html, json, static asserts(png, svg等等)module_type 会被 load 或者 transform 钩子返回
  • resolved_path 和 module_idresolved_path 是一个模块的绝对路径,module_id是一个模块的唯一 id,通常是模块对于项目根目录的相对路径 + query。例如 我们引用了一个模块 import './a?query' resolved_path 是 /project/src/a.ts module_id 是 src/a.ts?query
  • context: 所有的插件都会接受一个 context 参数,它有 Farm 项目的整个编译上下文,你可以从里面拿到 ModuleGraph,Module,Resources等等
  • Resource and Resource PotResource 是输出出来的最终打包产物, Resource Pot是资源的抽象表示,类似于其他打包器的 Chunk。在 Farm 项目中,我们首先从 ModuleGraph 生成 Resource Pots, 渲染 Resource Pots,最终从 Resource Pots 生成 Resource

Filters

由于 JavaScript插件Rust插件 慢得多,Farm 使用 filters 来控制 JavaScript 插件钩子的执行。为了提高性能,只有匹配当前的 filters ,插件钩子才会执行。filters 对于一些常用的钩子是必需的,例如resolveloadtransform等。 例如,如果你想转换 css 文件,你可以使用transform.filters. moduletypes = ['css']来确保 JavaScript 插件的 transform 钩子只对.css文件运行:

Module Type

在 Farm 中,一切都被认为是“一等公民”,因此 Farm 设计 module_type 来标识模块类型,并在用不同的插件处理不同的模块类型 Module_type load 钩子返回,并且可以由 transform 钩子转换。Farm 原生支持 js/ts/jsx/tsxcsshtmljsonstatic assets(png、svg等)。对于这些模块类型,你可以直接在 loadtransform hook 中返回。但是如果你想处理自定义模块类型,你需要实现其他钩子例如 parserender_resource_pot_modulesgenerate resources 等来控制如何对自定义模块进行类型解析,渲染和生成资源。

创建插件

Farm 提供了官方模板来帮助你快速创建 JavaScript 插件:

然后按照提示创建插件

或者直接运行以下命令创建插件:

上面的命令会在当前目录中创建一个名为 my-farm-plugin 的js插件。——type 可以是 rust 或者 js

开发一个插件

创建插件后,就可以开始开发插件了。这个插件只是一个定义了一系列 hooks 的纯 JavaScript 对象:

提示

有关插件钩子的更多细节, 参阅Javascript 插件 Hooks.

运行 npm Run dev 来编译插件开启监听。运行 npm Run build 来构建插件

发布插件

JavaScript 插件是一个普通的 npm 包,你可以通过运行 npm publish 将其发布到 npm registry。

Extremely Fast Web Build Tool Written in Rust

Copyright © 2024 Farm Community. Built with Docusaurus.