Foy：基于 Nodejs 的轻量级通用 build 工具

发布于 1周前 作者 h691938207 来自 nodejs/Nestjs

Foy：基于 Nodejs 的轻量级通用 build 工具

npm 的 scripts 下写的命令太多就很容易很乱，各种第三方轮子都只能解决一部分问题，总感觉不是很好用，想找个类似 make 的工具只能找到 jake, 可是 jake 的 API 太老，居然很多都不支持 promise, 代码也不多，就干脆自己造轮子了, 感觉效果还行。

特点:

  • 基于 promise 的任务和内置工具函数(fs/shell), 无缝支持 async/await
  • 类似于 shelljs 的跨平台 shell dsl, 人人都会写 shell
  • 易学易用，无需为写仅仅几个 build 命令而花费几个小时去寻找和学习第三方包
  • 很小的安装成本
    • foy: install size
    • gulp: install size
    • grunt: install size
  • 无缝和第三方支持 promise 的工具包整合，不需要封装成插件就能用

使用:

安装

yarn add -D foy # or npm i -D foy

Or Install globally with


yarn add -g foy # or npm i -g foy

在项目根目录下增加一个 Foyfile.js (或者 Foyfile.ts, 需要安装 ts-node)

import { task, desc, option, strict, fs } from 'foy'

task(‘build’, async ctx => {
await ctx.exec(‘tsc’)
})


desc(‘Build ts files with tsc’)
option(’-w, --watch’, ‘watch file changes’)
strict() // This will throw an error if you passed some options that doesn’t defined via option()
task(‘build2’, async ctx => {
await ctx.exec(tsc ${ctx.options.watch ? '-w' : ''})
})


task(‘task’, async ctx => {
await fs.rmrf(’/some/dir/or/file’) // Remove directory or file
await fs.copy(’/src’, ‘/dist’) // Copy folder or file
let json = await fs.readJson(’./xx.json’)
await ctx.env(‘NODE_ENV’, ‘production’)
await ctx.cd(’./src’)
await ctx.exec(‘some command’) // Execute an command
let { stdout } = await ctx.exec(‘ls’, { stdio: ‘pipe’ }) // Get the stdout, default is empty because it’s redirected to current process via stdio: 'inherit'.
})

然后就可以运行任务了

# 安装在本地 node_modules 目录下
npx foy build
npx foy build1
npx foy task 

安装在全局


foy build
foy build1


Harmonyos Next教程
2 回复

项目地址: https://github.com/zaaack/foy


Foy确实是一款值得关注的基于Node.js的轻量级通用build工具。以下是对Foy的详细介绍：

一、Foy的核心特性

  1. 基于Promise的任务处理：Foy充分利用Promise简化了异步任务处理流程，支持async/await语法，使代码更加清晰易懂，提高了开发效率。
  2. 内置工具函数：Foy内建了文件系统（fs）和shell命令执行等功能，便于开发者直接调用进行文件操作或执行系统命令。

二、Foy的安装与使用

  1. 安装：

    • 本地安装：npm install -D foy
    • 全局安装：npm install -g foy

  2. 使用：

    • 在项目根目录下创建Foyfile.js（或Foyfile.ts，需安装ts-node）。
    • 定义任务，例如：
import { task, desc, fs } from 'foy';

task('build', async ctx => {
    await ctx.exec('tsc');
});

desc('Build ts files with tsc');

task('clean', async ctx => {
    await fs.rmrf('/some/dir/or/file'); // 删除目录或文件
});

* 运行任务：`npx foy build` 或 `foy build`（全局安装时）。

Foy以其简洁高效的设计理念和强大的功能，为Node.js开发者提供了一个优秀的构建工具选择。

回到顶部