Node.js 生成项目公用文件自动化工具

2023-10-25 14:44:13

背景：

在软件开发中，常常需要创建和维护大量的公用文件，比如 README.md、package.json、.gitignore 等。这些文件通常具有相似的结构和内容，但又需要根据项目的情况进行修改。为了提高开发效率和项目的一致性，可以使用 Node.js 脚本自动生成这些公用文件。

方法：

安装必要的依赖包：

npm install --save-dev yeoman-generator

设置基本参数：

yo new-module

生成组件：

yo new-module:component

示例代码：

// 生成新的模块
const generator = require('yeoman-generator');

module.exports = class NewModuleGenerator extends generator {

  // 初始化
  initializing() {
    this.log('Generating a new module');
  }

  // 询问用户问题
  prompting() {
    return this.prompt([
      {
        type: 'input',
        name: 'moduleName',
        message: 'What is the name of the module?'
      },
      {
        type: 'confirm',
        name: 'includeTests',
        message: 'Do you want to include tests?'
      }
    ]).then((answers) => {
      this.moduleName = answers.moduleName;
      this.includeTests = answers.includeTests;
    });
  }

  // 写入文件
  writing() {
    this.fs.copyTpl(
      this.templatePath('README.md'),
      this.destinationPath(`${this.moduleName}/README.md`),
      {
        moduleName: this.moduleName
      }
    );

    this.fs.copyTpl(
      this.templatePath('package.json'),
      this.destinationPath(`${this.moduleName}/package.json`),
      {
        moduleName: this.moduleName,
        includeTests: this.includeTests
      }
    );

    if (this.includeTests) {
      this.fs.copyTpl(
        this.templatePath('test/index.test.js'),
        this.destinationPath(`${this.moduleName}/test/index.test.js`),
        {
          moduleName: this.moduleName
        }
      );
    }
  }

  // 安装依赖包
  install() {
    this.npmInstall(['eslint', 'jest'], { cwd: this.destinationPath(`${this.moduleName}`) });
  }

  // 结束
  end() {
    this.log('Module generated successfully');
  }
};