使用JavaScript实现一个简单的脚手架工具_javascript Node.js-js教程-PHP中文网

使用JavaScript实现一个简单的脚手架工具_javascript Node.js

幻影之瞳

发布： 2025-11-03 20:45:36

原创

343人浏览过

答案：通过Node.js和JavaScript创建一个简易脚手架工具，实现项目结构的自动化生成。首先初始化项目并配置package.json的bin字段与ES模块支持，接着编写index.js作为命令入口，利用shebang指定Node执行环境，并解析命令行参数获取项目名称；然后在scaffold.js中定义createProject函数，使用fs和path模块创建目录、生成基础文件（如index.js、index.html、README.md）及package.json；完成本地链接npm link后可全局调用mycli命令快速初始化项目；后续可扩展模板选择、交互式输入、远程模板拉取和git初始化等功能，提升前端项目搭建效率。

使用javascript实现一个简单的脚手架工具_javascript node.js

写一个简单的脚本工具，能快速生成项目基础结构，是前端开发中很实用的技能。用 JavaScript 和 Node.js 实现一个简易脚手架，可以帮助你自动生成文件、复制模板、接收命令行参数，提升初始化项目的效率。

1. 初始化项目并设置 bin 命令

创建一个新的目录，比如 scaffold-cli，然后运行：

npm init -y

登录后复制

修改 package.json，添加 bin 字段，告诉 npm 这个包提供一个可执行命令：

"bin": {
  "mycli": "./index.js"
},
"type": "module"

登录后复制

type: module 表示使用 ES Module，这样你可以用 import/export 语法。

立即学习“Java免费学习笔记（深入）”；

2. 创建入口文件 index.js

在项目根目录创建 index.js，这是命令执行的入口：

#!/usr/bin/env node
<p>import { createProject } from './scaffold.js';
import { fileURLToPath } from 'url';
import path from 'path';</p><p>const __dirname = path.dirname(fileURLToPath(import.meta.url));</p><p>// 获取命令行参数
const projectName = process.argv[2];</p><p>if (!projectName) {
console.error('请指定项目名称：mycli my-project');
process.exit(1);
}</p><p>const targetDir = path.join(process.cwd(), projectName);
createProject(targetDir, __dirname);

登录后复制

开头的 #!/usr/bin/env node 是 shebang，确保脚本用 Node.js 执行。

黑点工具

在线工具导航网站，免费使用无需注册，快速使用无门槛。

查看详情

3. 实现 scaffold.js：生成文件结构

创建 scaffold.js 文件，处理目录和文件的生成逻辑：

import fs from 'fs';
import path from 'path';
<p>export function createProject(targetDir, templateRoot) {
if (fs.existsSync(targetDir)) {
console.error(<code>目录 ${targetDir} 已存在</code>);
process.exit(1);
}</p><p>fs.mkdirSync(targetDir, { recursive: true });</p><p>// 创建基本文件
const files = [
{ path: 'src/index.js', content: '// 入口文件\n' },
{ path: 'public/index.html', content: '<!DOCTYPE html>\n<html><head><title>My App</title></head><body><script src="../src/index.js"></script></body></html>\n' },
{ path: 'README.md', content: <code># ${path.basename(targetDir)}\n\n一个由 mycli 创建的项目。\n</code> }
];</p><p>files.forEach(file => {
const filePath = path.join(targetDir, file.path);
const dir = path.dirname(filePath);</p><pre class='brush:php;toolbar:false;'>if (!fs.existsSync(dir)) {
  fs.mkdirSync(dir, { recursive: true });
}

fs.writeFileSync(filePath, file.content);

登录后复制

});

// 创建 package.json const pkgJson = { name: path.basename(targetDir), version: '1.0.0', main: 'src/index.js', scripts: { start: 'node src/index.js' }, description: '', author: '', license: 'MIT' };

fs.writeFileSync( path.join(targetDir, 'package.json'), JSON.stringify(pkgJson, null, 2) );

console.log(✅ 项目已创建：${targetDir}); }