@fuman/ 建设
这个软件包包含用于构建软件包和管理单体的公用事业.
现有的类似工具试图做太多,并且与每个可能的使用案例一致, 这使得它们很难使用 并且不能提供足够的一致性. 不像他们,这个软件包 非常喜欢 有意见的,也许不适合你.
这个软件包基于一些假设,可以抽象出一些复杂之处:
- 对于工作空间,它假设工作空间由 pnpm 管理
- 工作空间内的软件包使用
workspace:协议, (中文(简体) ), 和版本在构建时替换为实际版本
- 工作空间内的软件包使用
- 软件包使用 vite(即滚动) 构建。 我可能会支持其他的 捆绑者下来,虽然
- tsc是明确的 没有 支持,因为使用
tsc建设是那么痛苦, 它只是不值得.
- tsc是明确的 没有 支持,因为使用
- 所有软件包必须是
type: module,因为 commonjs 烂 (你仍然可以构建为 commonj, tho) .exports财务报告和审定财务报表.bin字段中的字段。json是构建条目,例如:{ "exports": { ".": "./src/index.ts" }, "bin": { "fuman-build": "./src/cli.ts" } }.main, (中文(简体) ),.module, (中文(简体) ),.types, (中文(简体) ),.browser明确 没有 已支持。 对于浏览器特定代码,您应该制作一个二级切入点/包,而不是依赖捆绑时间的魔法- 软件包的版本是可调和并符合semver要求的(除了“固定版本”的版本,它们都共享同一版本)
- 此软件包目前侧重于非前端库
这个 可能会 与其他设置一起工作,但不支持.
为什么?
因为节点很烂. package.json 绝对是一团糟——它没有适当地标准化,而且很难合作.
当它被发明时,打字甚至不是一件事情, 因此,为图书馆正确设置它是一种痛苦.
和npm也是一种疼痛 由于类似的原因。 一切都是如此脆弱和不一致,以至于很容易出错.
德诺和jsr解决了一些问题, 但我一般不喜欢德诺,因为它感到非常有限和锁定供应商, 而且没有任何工具 写交叉运行时代码 在deno.
另外,还有相当一些疼痛的写作发布 ci/cd流量为图书馆. 特别是对于单体,特别是当你想跨出 npm 和 jsr 时.
package.json 预处理功能
. 由 processPackageJson 函数
- 复制根包中的常见字段。 json
- 替换
workspace:与工作空间实际版本的依赖关系 - 删除
scripts(除列于keepScripts(中文(简体) ) - 删除
devDependencies, (中文(简体) ),typedoc编号 :prettier/etc 数据 - 收集从
exports财务报告和审定财务报表bin - 正在运行的钩子声明在
build.config.js文件
这允许:
- 简化内包.jsons,使其与根包同步.json
- 通过不需要手动更新每个软件包中的依赖性版本来简化发行流程
- (我知道pnpm/yarn 基本上用
workspace:但我不喜欢用 npm cli 来发布到 npm 之外的东西
- (我知道pnpm/yarn 基本上用
- 保证你不会意外地发布不必要的
prepare编号 :install/etc. 脚本到 npm( 同时将安装大小减少一点) - 减少安装大小
- 改进 dx 通过 经常
- 您不再需要在导入软件包之前构建软件包, 也无需通过手动提供
.types发展方面的业务活动 - 您不再需要同步 vite 构建切入点
package.json横跨所有软件包( 并意外发布已破损)
- 您不再需要在导入软件包之前构建软件包, 也无需通过手动提供
- 因为我们生成一个新的软件包. json, 你可以做几乎所有的修改 生产软件包. json (尽管如此,我们可能还是有 案件不覆盖,你想要更多的控制。). 如果你觉得这应该放在包裹里
使用 vite 时的用法
把这个放进你的 vite.config.js数字 :
import { fumanBuild } from '@fuman/build/vite'
export default {
plugins: [
fumanBuild({
root: __dirname,
// if you're using `vite-plugin-dts`, make sure to add this option,
// otherwise additional entrypoints will not have proper types
// (and DO NOT add this option to the dts plugin itself)
insertTypesEntry: true,
}),
],
}
使用 jsr
fuman-building也支持jsr 通过能够将 pnpm 工作空间转换为去诺工作空间,
,然后可以通过简单的 deno publish 命令.
生成去诺工作空间,运行 fuman-build jsr gen-deno-workspace。 。 。 .
语气
福曼建有相当酷的cli,通过 fuman-build --help
预算外/cd
福曼的造型也不错 非常喜欢 易于用于CI/CD管道. 一个非常简单的释放流 由fuman 构建和github动作提供动力 可见 这里。 。 。 .
页:1 release 命令基本上结合了一堆其他命令
(即:, bump-version, (中文(简体) ), gen-changelog, (中文(简体) ), publish 财务报告和审定财务报表 jsr 子命令)
并添加一些额外的释放特性(如:git标记和github释放生成),也是在CI/CD管道中使用fuman-building的建议方式.
虽然可以直接使用其他命令,但如果 您需要做一个没有从框中支持的东西.