Node.js 中正确使用 mkdir 创建目录及文件的完整教程

1次阅读

Node.js 中正确使用 mkdir 创建目录及文件的完整教程

本文详解如何在 node.js 中使用内置 fs 模块(推荐 promise 版本)安全创建嵌套目录及初始化标准前端项目文件(index.html、app.js、styles.css),彻底解决 “cannot find module ‘mkdir’” 等常见导入错误。

本文详解如何在 node.js 中使用内置 fs 模块(推荐 promise 版本)安全创建嵌套目录及初始化标准前端项目文件(index.html、app.js、styles.css),彻底解决 “cannot find module ‘mkdir’” 等常见导入错误。

node.js 中,初学者常误将 mkdir 当作独立第三方模块引入(如 require(‘mkdir’)),导致 Error: Cannot find module ‘mkdir’ 报错。实际上,mkdir 是 Node.js 内置 fs(File System)模块的一部分,并不需额外安装 npm。自 Node.js v10.0.0 起,官方推荐使用 node:fs/promises 提供的 Promise API 实现异步、可等待的文件系统操作,代码更简洁、错误处理更直观。

以下是创建标准前端项目结构(Project/ 目录 + 三个核心文件)的完整、健壮实现:

// boilerplate.js import { mkdir, writeFile } from 'node:fs/promises';  async function createProjectStructure() {   const projectName = 'Project';    try {     // ✅ 使用 fs.promises.mkdir,支持 recursive: true 自动创建多层嵌套路径     await mkdir(projectName, { recursive: true });     console.log(`✓ Directory '${projectName}' created successfully.`);      // ✅ 同时创建三个空文件(可按需写入模板内容)     const files = [       { path: `${projectName}/index.html`, content: `<!DOCTYPE html>n<html><head><title>My App</title><link rel="stylesheet" href="styles.css"></head><body><script src="app.js"></script></body></html>` },       { path: `${projectName}/app.js`, content: `// Your JavaScript logic herenconsole.log('App loaded.');` },       { path: `${projectName}/styles.css`, content: `/* Reset & Base Styles */n* { margin: 0; padding: 0; }nbody { font-family: -apple-system, sans-serif; }` }     ];      for (const file of files) {       await writeFile(file.path, file.content, 'utf8');       console.log(`✓ Created ${file.path}`);     }      console.log('n? Project initialization completed!');   } catch (err) {     console.error('❌ Failed to create project:', err.message);     process.exit(1);   } }  createProjectStructure();

? 关键要点说明:

  • 不要 npm install mkdir 或 require(‘mkdir’):该模块早已废弃,且非 Node.js 官方 API;
  • 正确导入方式:const { mkdir, writeFile } = require(‘node:fs/promises’);(CommonJS)或 import { mkdir, writeFile } from ‘node:fs/promises’;(ESM);
  • 必须使用 await 或 .then():fs.promises.* 方法返回 Promise,不可直接同步调用;
  • recursive: true 是关键:避免父目录不存在时报错,自动创建完整路径链;
  • writeFile 替代已弃用的 writeFileSync:保持异步一致性,避免阻塞线程
  • 建议添加基础 HTML/CSS/JS 模板内容:提升脚本实用性,避免生成空文件。

⚠️ 注意事项:

  • 若使用 CommonJS(require),请确保 package.json 中未设置 “type”: “module”;反之若为 ESM,请统一使用 import 语法;
  • windows 路径分隔符兼容性已由 Node.js 自动处理,无需手动替换 ;
  • 生产环境建议增加路径校验(如防止 ../ 路径遍历)和文件存在性检查(如 access())以增强鲁棒性。

通过以上方式,你不仅能彻底规避模块找不到的错误,还能构建出可复用、易维护、符合现代 Node.js 最佳实践的项目初始化脚本。

text=ZqhQzanResources