fs-extra实现yarn create模板项目创建详解

木白

发布时间：2026-10-15| 3人浏览过

原创

介绍如何使用 Node.js 的 fs-extra 模块结合 yarn create 命令，快速创建和管理自定义项目模板。文章详细讲解了在拷贝过程中利用 filter 过滤特定文件、通过读写分离处理文件名转换（如 _gitignore 到 .gitignore），以及读取并动态重写 package.json 内容的具体代码实现与参数配置。

引言

在开发中，将常用的项目模板集中管理，并通过 yarn create 快速初始化项目，能显著提升开发效率。本文将分享如何基于 create-vite 的思路，使用 fs-extra 模块实现一个类似的项目创建工具，重点解析模板文件的智能拷贝与内容处理逻辑。

利用 fs-extra 实现 "yarn create" 核心功能

实现模板项目的核心在于对资源目录的精准拷贝。由于部分配置文件（如 package.json）需要注入项目名或环境变量，且存在以 _ 开头的隐藏文件需重命名，直接使用基础 fs 模块较为繁琐。因此我们选用功能更丰富的 fs-extra 模块来处理。

第1步：定义文件过滤规则

对于需要先排除的文件，fs-extra.copySync 提供了 filter 选项。我们可以定义一个忽略列表，并在拷贝时通过匹配文件名进行过滤，避免这些文件被直接复制到目标目录。

import path from 'path';
import fsExtra from 'fs-extra';

export const fileIgnore = ['package.json', '_gitignore'];

fsExtra.copySync(templateDir, targetDir, {
  filter: (src) => {
    // 解析源文件路径获取文件名
    const fileName = `${path.parse(src).name}${path.parse(src).ext}`;
    // 如果在忽略列表中则返回 false，跳过拷贝
    return !fileIgnore.includes(fileName);
  },
});

第2步：处理特殊文本文件的重命名

模板中的 _gitignore 文件在输出时需要变为标准的 .gitignore。fs-extra 没有直接提供重命名函数，但可以通过先读取原文件内容，再写入到新名称文件中来实现。

const gitignoreInfo = fsExtra.readFileSync(
  path.resolve(templateDir, "_gitignore")
);
// 将内容输出到目标目录的新文件名中
fsExtra.outputFile(path.join(targetDir, ".gitignore"), gitignoreInfo);

第3步：动态生成 JSON 配置文件

package.json 需要根据新建项目的名称进行动态修改。使用 readJsonSync 可直接读取并解析为 JavaScript 对象，修改关键字段后，再通过 outputJSONSync 写回磁盘。设置 spaces: 2 可使输出的 JSON 保持人类可读的格式。

const pkg = fsExtra.readJsonSync(path.resolve(templateDir, "package.json"));
// 动态更新项目名称
pkg.name = packageName || getProjectName();

fsExtra.outputJSONSync(path.join(targetDir, "package.json"), pkg, {
  spaces: 2,
});