Pattern Lab Node - Gulp 版使用教程

1. 项目的目录结构及介绍

下载并解压 edition-node-gulp 项目后，你会看到以下目录结构：

edition-node-gulp/
├── README.md
├── gulpfile.js
├── package.json
├── src/
│   ├── patterns/
│   ├── styleguide/
│   └── ...
├── node_modules/
└── ...

• README.md: 项目说明文档。
• gulpfile.js: Gulp 任务配置文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录，包含模板、样式和其他资源。
• node_modules/: 项目依赖模块目录。

2. 项目的启动文件介绍

项目的启动文件主要是 gulpfile.js，它定义了如何使用 Gulp 运行和管理项目任务。以下是 gulpfile.js 的主要内容：

const gulp = require('gulp');
const patternlab = require('@pattern-lab/core')(config);

gulp.task('patternlab:build', () => {
  return patternlab.build(() => {
    console.log('Pattern Lab build completed');
  });
});

gulp.task('patternlab:serve', () => {
  patternlab.serve(() => {
    console.log('Pattern Lab serving on http://localhost:3000');
  });
});

• patternlab:build: 构建 Pattern Lab 项目。
• patternlab:serve: 启动本地服务器，预览 Pattern Lab 项目。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他配置信息。以下是 package.json 的主要内容：

{
  "name": "edition-node-gulp",
  "version": "1.0.0",
  "description": "The Gulp wrapper around Pattern Lab Node Core",
  "main": "gulpfile.js",
  "scripts": {
    "build": "gulp patternlab:build",
    "serve": "gulp patternlab:serve"
  },
  "dependencies": {
    "@pattern-lab/core": "^5.0.0",
    "gulp": "^4.0.2"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件。
• scripts: 定义了可执行的脚本命令。
• dependencies: 项目依赖的模块。

通过以上配置，你可以使用 npm run build 和 npm run serve 命令来构建和启动项目。