common-shakeify 使用教程
1. 项目的目录结构及介绍
common-shakeify/
├── bin/
│ └── common-shakeify.js
├── lib/
│ ├── dedupe.js
│ ├── index.js
│ ├── parse.js
│ ├── shake.js
│ └── walk.js
├── test/
│ ├── basic.js
│ ├── dedupe.js
│ ├── index.js
│ ├── parse.js
│ ├── shake.js
│ └── walk.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock
bin/
: 包含项目的可执行文件。lib/
: 包含项目的主要逻辑代码。test/
: 包含项目的测试代码。.gitignore
: 指定Git忽略的文件和目录。.npmignore
: 指定npm发布时忽略的文件和目录。.travis.yml
: Travis CI 配置文件。LICENSE
: 项目许可证。README.md
: 项目说明文档。package.json
: 项目依赖和配置文件。yarn.lock
: Yarn 锁定文件,确保依赖版本一致。
2. 项目的启动文件介绍
项目的启动文件位于 bin/
目录下,名为 common-shakeify.js
。该文件是项目的入口点,负责启动和配置 common-shakeify。
#!/usr/bin/env node
var commonShake = require('../')
var browserify = require('browserify')
var b = browserify()
b.plugin(commonShake)
// 其他配置和启动逻辑
3. 项目的配置文件介绍
项目的配置文件主要是 package.json
,其中包含了项目的依赖、脚本和其他配置信息。
{
"name": "common-shakeify",
"version": "1.1.2",
"description": "browserify tree shaking plugin using @indutny common-shake",
"main": "index.js",
"bin": {
"common-shakeify": "bin/common-shakeify.js"
},
"scripts": {
"test": "tape test/*.js"
},
"repository": {
"type": "git",
"url": "git+https://github.com/browserify/common-shakeify.git"
},
"keywords": [
"browserify",
"tree-shaking",
"common-shake"
],
"author": "Renée Kooi <renee@kooi.me>",
"license": "MIT",
"bugs": {
"url": "https://github.com/browserify/common-shakeify/issues"
},
"homepage": "https://github.com/browserify/common-shakeify#readme",
"dependencies": {
"browser-unpack": "^1.1.1",
"common-shake": "^1.0.0",
"through2": "^2.0.3"
},
"devDependencies": {
"concat-stream": "^1.6.2",
"tape": "^4.9.1"
}
}
name
: 项目名称。version
: 项目版本。description
: 项目描述。main
: 项目的主入口文件。bin
: 项目的可执行文件。scripts
: 项目的脚本命令。repository
: 项目的仓库地址。keywords
: 项目的关键词。author
: 项目作者。license
: 项目许可证。bugs
: 项目问题跟踪地址。homepage
: 项目主页。dependencies
: 项目依赖。devDependencies
: 开发依赖。