gulp-plumber 项目使用教程

gulp-plumber 项目使用教程

【免费下载链接】gulp-plumber Fixing Node pipes 项目地址: https://gitcode.com/gh_mirrors/gu/gulp-plumber

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

gulp-plumber 项目的目录结构相对简单，主要包含以下几个部分：

gulp-plumber/
├── lib/
│   └── index.js
├── test/
│   ├── fixtures/
│   └── index.js
├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── index.js

• lib/：包含项目的主要代码文件。
• test/：包含项目的测试文件，其中 fixtures/ 存放测试用例所需的文件。
• .editorconfig：配置编辑器的格式设置。
• .gitignore：指定 Git 版本控制系统忽略的文件和目录。
• .npmignore：指定 npm 发布时忽略的文件和目录。
• .travis.yml：配置 Travis CI 持续集成服务。
• LICENSE：项目的开源许可证。
• README.md：项目的说明文档。
• package.json：项目的 npm 配置文件，包含依赖、脚本等信息。
• index.js：项目的入口文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它导入了 lib/index.js 中的主要功能，并提供了对外的接口。以下是 index.js 的简要内容：

'use strict';

var Plumber = require('./lib');

module.exports = function (options) {
    return new Plumber(options);
};

module.exports.ctor = Plumber;
module.exports.stop = function (stream) {
    return stream.unpipe();
};

• Plumber 类定义在 lib/index.js 中，提供了错误处理的功能。
• module.exports 导出了一个函数，用于创建 Plumber 实例。
• module.exports.ctor 导出了 Plumber 类本身。
• module.exports.stop 提供了一个方法，用于停止错误处理。

3. 项目的配置文件介绍

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

{
  "name": "gulp-plumber",
  "version": "1.2.1",
  "description": "Prevent pipe breaking caused by errors from gulp plugins",
  "main": "index.js",
  "scripts": {
    "test": "mocha"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/floatdrop/gulp-plumber.git"
  },
  "keywords": [
    "gulpplugin",
    "plumber",
    "error",
    "handling",
    "broken",
    "pipe"
  ],
  "author": "Vsevolod Strukchinsky <floatdrop@gmail.com>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/floatdrop/gulp-plumber/issues"
  },
  "homepage": "https://github.com/floatdrop/gulp-plumber#readme",
  "dependencies": {
    "through2": "^2.0.0",
    "gulp-util": "^3.0.0"
  },
  "devDependencies": {
    "mocha": "^2.0.0",
    "stream-assert": "^2.0.0",
    "gulp": "^3.0.0"
  }
}

• name：项目的名称。
• version：项目的版本号。
• description：项目的描述。
• main：项目的入口文件。
• scripts：定义了一些脚本命令，如 test 用于运行测试。
• repository：项目的代码仓库地址。
• keywords：项目的关键词。
• author：项目的作者。
• license：项目的开源许可证。
• bugs：项目的问题追踪地址。
• homepage：项目的主页地址。
• dependencies：项目运行所需的依赖。
• devDependencies：项目开发所需的依赖。

【免费下载链接】gulp-plumber Fixing Node pipes 项目地址: https://gitcode.com/gh_mirrors/gu/gulp-plumber