TS/TSX
Farm 支持开箱即用地编译Js/Jsx/Ts/Tsx,并默认将Jsx/Tsx编译为 React。
import Button from "./Button";
function ButtonGroup(props: ButtonProps) {
return (
<div>
{props.buttons.map((b) => (
<Button>{b}</Button>
))}
</div>
);
}
Farm 使用 SWC 来编译脚本,Farm 为脚本编译设置了合理的默认配置。 另外,您可以使用compilation.script来配置如何编译脚本文件。 有关详细信息,请参阅 compilation.script。
配置 Swc 解析器
您可以通过compilation.script.parser配置 SWC 解析器。 请参阅 https://swc.rs/docs/configuration/compilation#jscparser。
例如,如果你想启用装饰器,你可以设置compilation.script.parser.esConfig.decorators(如果模块是 TS,则设置 tsConfig.decorators):
export default {
compilation: {
script: {
// for .js/.jsx files
esConfig: {
decorators: true,
},
// for .ts/.tsx files
tsConfig: {
decorators: true,
},
},
},
};
默认情况下,Farm 为.jsx|.tsx文件设置jsx: true。 其他字段默认为 SWC 的默认值。
配置目标执行环境
运行项目时使用compilation.script.target配置目标环境,Farm 将其默认设置为ESNext。
此选项可以与compilation.presetEnv一起使用,以针对旧浏览器优雅地降级您的项目。 例如,您可以将 target 设置为 ES5 并启用 presetEnv,那么您的项目将完全降级到 ES5。
export default {
compilation: {
script: {
target: "ES5",
},
presetEnv: true,
},
};
有关presetEnv的更多信息,请参阅 Polyfill。
原生顶层 Await
Farm 通过 compilation.script.nativeTopLevelAwait 支持原生顶层 await。启用后,Farm 会保留模块顶层的 await 而不是将其转换。
import { defineConfig } from '@farmfe/core';
export default defineConfig({
compilation: {
script: {
nativeTopLevelAwait: true,
},
},
});
仅类型导入行为
使用 compilation.script.importNotUsedAsValues 控制仅类型导入的行为,对应 TypeScript 的 --importsNotUsedAsValues 标志。选项:
remove— 删除仅导入类型的 import 语句(默认)preserve— 保留所有 import 语句
装饰器
装饰器默认不启用, 可以通过设置 compilation.script.parser.tsConfig.decorators 为 true 来启用装饰器。
import { defineConfig } from "@farmfe/core";
export default defineConfig({
compilation: {
script: {
parser: {
tsConfig: {
// 启用装饰器
decorators: true,
},
},
// 配置装饰器
decorators: {
legacyDecorator: true,
decoratorMetadata: false,
decoratorVersion: '2021-12',
includes: ["src/broken.ts"],
excludes: ['node_modules/'],
}
},
},
});
Farm 提供了一个装饰器的示例,可以看 https://github.com/farm-fe/farm/tree/main/examples/decorators
默认情况下, Farm 不会转译
node_modules下的装饰器, 参考 compilation.script.decorators.excludes.
使用 SWC 插件
SWC Plugins 可以直接在 Farm 中使用,例如我们在 Farm 中使用 swc-plugin-vue-jsx 来编译 Vue JSX。如果需要 Vue SFC 支持,请注册当前的 Rust 插件 @farmfe/plugin-vue:
import vue from "@farmfe/plugin-vue";
/**
* @type {import('@farmfe/core').UserConfig}
*/
export default {
compilation: {
script: {
plugins: [
{
name: "swc-plugin-vue-jsx",
options: {
transformOn: true,
optimize: true,
},
filters: {
// resolvedPaths: [".+"]
moduleTypes: ["tsx", "jsx"],
},
},
],
},
},
plugins: [vue()],
};
有关更多详细信息,请参阅使用插件。
Vite 风格的 import.meta.glob
Farm 支持字面量形式的 Vite 风格 import.meta.glob,参考 glob import。Rust 匹配器以 Vite 8.3.5 的 JavaScript glob 路径为对齐目标,不代表完整兼容所有 picomatch 或原生 Rolldown 行为。
支持 eager、import、query、exhaustive、caseSensitive、base,并保留旧的 as: 'raw' | 'url'。模式和选项必须为静态字面量;不支持的选项和非法值会产生编译错误,不会静默切换匹配方言。
负模式的排除不受数组中位置影响。默认不包含隐藏文件和 node_modules,exhaustive: true 可在发现文件时包含它们;extglob 关闭。对象键排序后输出,query 仅附加到导入路径,不污染对象键。相对 base 以 importer 目录为基准,绝对 base 以项目根目录为基准,返回键相对于该目录。
const modules = import.meta.glob('./*.js', {
base: './dir',
import: 'default',
query: '?raw',
});
// 键为 './foo.js',导入路径为 './dir/foo.js?raw'
开发模式下,匹配文件的新增和删除会让 importer 重新编译,并通过 HMR 更新 glob 对象;文件事件仍遵循 watcher 的排除配置。源码、许可来源和兼容边界见 farmfe_ecosystem_glob。
例如:
const modules = import.meta.glob("./dir/*.js");
将会被编译成以下结果
// code produced by Farm
const modules = {
"./dir/foo.js": () => import("./dir/foo.js"),
"./dir/bar.js": () => import("./dir/bar.js"),
};
使用 { eager: true } 后:
const modules = import.meta.glob("./dir/*.js", { eager: true });
将会被编译成以下结果:
// code produced by Farm
import * as __glob__0_0 from "./dir/foo.js";
import * as __glob__0_1 from "./dir/bar.js";
const modules = {
"./dir/foo.js": __glob__0_0,
"./dir/bar.js": __glob__0_1,
};
支持数组形式:
const modules = import.meta.glob(["./dir/*.js", "./another/*.js"]);
支持通过 ! 排除某些匹配:
const modules = import.meta.glob(["./dir/*.js", "!**/bar.js"]);
// code produced by Farm
const modules = {
"./dir/foo.js": () => import("./dir/foo.js"),
};
Farm