在项目中添加 plop - 常用工具脚手架(generator)

需要从这个项目里 copy 需要的文件

# clone 到 ~/aric-tpls 目录
git clone git@github.com:aric-tpls/plop-slim.git

安装依赖，复制文件到你自己的项目

# copy files
cd ~/target-directory
cp -R ~/aric-tpls/plop-slim/.templates ~/aric-tpls/plop-slim/plopfile.js .
# copy这句可以优化
cp -R ~/aric-tpls/plop-slim/{.templates,plopfile.js} .

# install plop to devDependencies
yarn add plop @jswork/plop-utils --dev

添加 plop 到 scripts 中去

# set npm scripts
npm pkg set scripts.plop="plop"
# 另外可以安装 plop
npm i -g plop

示例 generator

import { metadata } from '@jswork/plop-utils';

export default function (
  /** @type {import('plop').NodePlopAPI} */
  plop
) {
  plop.setGenerator('component', {
    description: 'Create a component',
    prompts: [
      {
        type: 'input',
        name: 'name',
        message: "What is this component's name?"
      }
    ],
    actions: [
      {
        type: 'addMany',
        destination: 'src/components/{{ name }}/',
        templateFiles: '.templates/component/*.hbs',
        data: metadata
      }
    ]
  });
}

相关约定

# 默认路径
./.templates/

# 示例
.
└── component
    ├── index.js
    ├── index.tsx.hbs
    └── locale.yml.hbs