脚手架原理揭秘 - 利用 cli 让脚手架远离 npm publish！

2024-01-06 02:08:19

脚手架的基本原理

脚手架是一种开发工具，可以帮助您快速创建项目结构、生成代码模板并自动配置必要的依赖项。通常，脚手架工具需要通过 npm 包的形式安装，然后使用命令行工具来运行。然而，在本文中，我们将使用 cli、npm link 和 package.json bin 来实现一个简单的脚手架，而无需将其发布到远程仓库。

创建脚手架脚本

首先，我们需要创建一个脚手架脚本。这个脚本将负责生成项目结构、代码模板和配置依赖项。您可以使用任何您喜欢的编程语言来编写这个脚本，但为了简单起见，我们这里使用 JavaScript。

const fs = require('fs');
const path = require('path');

const createProject = (name) => {
  // 创建项目目录
  fs.mkdirSync(name);

  // 创建 package.json 文件
  const packageJson = {
    name: name,
    version: '1.0.0',
    main: 'index.js',
    scripts: {
      start: 'node index.js',
    },
  };
  fs.writeFileSync(path.join(name, 'package.json'), JSON.stringify(packageJson, null, 2));

  // 创建 index.js 文件
  const indexJs = `console.log('Hello, ${name}!');`;
  fs.writeFileSync(path.join(name, 'index.js'), indexJs);

  console.log(`项目 ${name} 创建成功！`);
};

// 获取命令行参数
const args = process.argv.slice(2);

// 检查参数
if (args.length < 1) {
  console.log('请提供项目名称！');
  process.exit(1);
}

// 创建项目
createProject(args[0]);

使用 npm link 创建本地全局命令

现在，我们需要使用 npm link 将我们的脚手架脚本链接到本地全局。这将允许我们使用全局命令来运行脚本。

npm link .

使用 package.json bin 配置全局命令

接下来，我们需要在 package.json 文件中配置全局命令。这将告诉 npm 在执行全局命令时应该运行哪个脚本。

{
  "name": "my-scaffold",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
  },
  "bin": {
    "my-scaffold": "index.js"
  }
}