简介
Scavenger-cli 是一个用于快速生成自定义配置的脚手架工具。它基于 Node.js，使用 npm 包管理器进行安装、更新和卸载。除了提供预设的模板，Scavenger-cli 还支持自定义模板以满足更多业务需求。
本文将介绍 Scavenger-cli 的安装、使用、自定义模板以及常见问题的解决方法。
安装
在开始使用 Scavenger-cli 前，需要确保操作环境中已经安装了 Node.js 和 npm 包管理器。如果还未安装，请先进行安装。
# 安装 Node.js sudo apt-get install nodejs # 安装 npm 包管理器 sudo apt-get install npm
安装完成 Node.js 和 npm 后，可以通过以下命令安装 Scavenger-cli:
npm install -g scavenger-cli
安装完成后，可以通过以下命令检查 Scavenger-cli 是否正确安装:
scavenger -v
使用
Scavenger-cli 包含了几个命令，可以快速创建项目、安装依赖、运行等等。在这里，将介绍最常用的命令：
创建项目
可以使用以下命令创建 Scavenger-cli 提供的预设模板：
scavenger init <template-name> <project-name>
例如，如果要创建一个 React 项目，可以使用以下命令：
scavenger init react my-react-app
安装依赖
创建项目时，Scavenger-cli 默认会使用 npm 安装依赖。如果在开发过程中需要安装其他依赖，可以使用以下命令：
npm install
运行项目
使用以下命令运行项目，项目将在默认的端口（3000）上运行：
npm start
如果需要使用其他端口，可以通过修改 package.json 文件中的 script 命令来指定端口，例如：
"scripts": {
"start": "PORT=4000 react-scripts start"
},自定义模板
Scavenger-cli 支持自定义模板，让我们可以根据不同需求快速创建项目模板。以下是创建自定义模板的步骤：
1. 创建模板文件夹
在任意位置创建一个文件夹，例如 my-template。
2. 创建模板文件
在 my-template 文件夹下创建一个 template.json 文件，该文件包含了模板信息：
{
"name": "my-template",
"version": "1.0.0",
"description": "my template for scavenger-cli",
"author": "me",
"templateDir": "template",
"generator": "handlebars"
}- name: 模板名称
- version: 模板版本
- description: 模板描述
- author: 模板作者
- templateDir: 模板目录，存放模板文件
- generator: 模板引擎
在 my-template 文件夹下创建 template 文件夹，用来存放模板文件，例如 index.html 和 main.js。
3. 打包模板
使用以下命令打包模板：
scavenger pack my-template
打包完成后，会在 my-template 文件夹下生成 my-template.tgz 文件。
4. 安装自定义模板
使用以下命令安装自定义模板:
scavenger install /path/to/my-template.tgz
安装完成后，可以使用以下命令创建自定义模板：
scavenger init my-template my-project
常见问题解决方法
1. 安装过程中提示无权限
使用 sudo 运行命令：
sudo npm install -g scavenger-cli
2. 安装完成后运行 scavenger 命令没有反应
- 确保 Node.js 和 npm 已正确安装。
- 确保已添加 npm 全局模块路径到系统环境变量。
- 重新打开终端窗口后再次尝试运行命令。
3. 在使用自定义模板时，提示模板版本过低
更新 scavenger-cli：
npm update scavenger-cli -g
4. 在使用自定义模板时，提示找不到某个依赖包
在 template.json 文件中添加该依赖包：
-- -------------------- ---- -------
-
------- --------------
---------- --------
-------------- --- -------- --- ---------------
--------- -----
-------------- -----------
------------ -------------
--------------- -
---------------- --------
-
-然后重新打包和安装模板即可。
结束语
Scavenger-cli 是一个十分方便的脚手架工具，可以快速生成项目模板以便开发。有了自定义模板的支持，我们可以更加精准地创建我们所需的项目模板。如果您在使用 Scavenger-cli 过程中遇到任何问题，可以在官方文档中查找答案或在社区中咨询相关问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600572c681e8991b448e8ea6