在前端开发中，我们经常会创建一些通用的组件或模板，这些组件或模板通常有着相似的结构和样式。使用一个 boilerplate （脚手架）可以帮助我们快速创建这些通用的结构和样式。
在本文中，我们将介绍一个名为 brick-boilerplate 的 npm 包，它是一个基于 Brick Design 的脚手架。
安装
安装 brick-boilerplate 很简单，只需在命令行中执行以下命令：
npm install -g brick-boilerplate
这会将 brick-boilerplate 安装到全局环境中。
使用
使用 brick-boilerplate 创建一个新项目很简单，只需在命令行中执行以下命令：
brick-boilerplate create <project-name>
这会在当前路径下创建一个名为 project-name 的新项目，包含了 Brick Design 所需的基本结构和样式。
目录结构
创建完项目后，我们来看看它的目录结构：
-- -------------------- ---- ------- ------------ --- ---- --- ------------ --- --- - --- --- - - --- -------- - - --- ------------- - --- ---------- - --- -- - --- ------- --- --------------- --- ------------ --- -----------------
在 src 目录下，我们可以看到 index.html、main.css 和 main.js，这就是我们通常所需的基本文件。同时，我们也可以在 css 目录中找到 variables.css，其中包含了一些 CSS 变量，方便我们在不同组件或模板中共用样式。
在 brick-config.js 文件中，我们可以设置一些配置项，比如自定义变量的值或自定义 webpack 配置。默认情况下，brick-config.js 是一个空文件，我们可以自行添加配置项。
在 webpack.config.js 文件中，我们可以自定义 webpack 的配置，以满足我们项目中的需求。默认情况下，webpack.config.js 中已经包含了一些基础配置，我们也可以自行添加或修改配置项。
开发
在开发项目时，我们可以通过以下命令来启动 webpack devserver：
npm run dev
这会启动一个本地服务，我们可以在浏览器上通过 http://localhost:8080 来访问项目，同时也支持热更新。
在开发过程中，我们可以在 src 目录下创建新的 HTML、CSS 和 JS 文件，并在 index.html 文件中引入它们。
构建
在开发完毕后，我们可以使用以下命令来构建项目：
npm run build
这会将编译后的文件输出到 dist 目录中。我们可以将 dist 目录中的文件上传到生产环境中。
示例
为了更好地理解使用 brick-boilerplate，我们来创建一个简单的示例。
- 首先，我们在命令行中执行以下命令来创建项目：
brick-boilerplate create my-project
创建完毕后，我们进入 my-project 目录，并执行
npm run dev命令来启动本地服务。在 src 目录下创建新的文件，比如 my-component.html、my-component.css 和 my-component.js，并在 index.html 文件中引入它们。
在 my-component.html 文件中添加以下代码：
<div class="my-component"> <h1 class="my-component__title">Hello, World!</h1> </div>
- 在 my-component.css 文件中添加以下代码：
-- -------------------- ---- ------- ------------- - ------- --- ----- --------------------- -------- ----- - -------------------- - ---------- ----- ------ --------------------- -
- 在 my-component.js 文件中添加以下代码：
console.log('My Component is ready!');- 在浏览器中访问
http://localhost:8080，我们可以看到一个显示了 "Hello, World!" 的组件，并在控制台中输出了 "My Component is ready!" 的信息。
结语
通过本文，我们了解了如何使用 npm 包 brick-boilerplate 来创建一个基于 Brick Design 的脚手架，并通过示例代码学习了如何在创建的项目中添加新的组件或模板。希望本文对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c86ccdc64669dde4f86