HTTP/2 Push Manifest 项目教程
1. 项目的目录结构及介绍
http2-push-manifest/
├── bin/
│ └── http2-push-manifest
├── lib/
│ ├── discover.js
│ ├── index.js
│ └── prune.js
├── test/
│ ├── discover.js
│ ├── index.js
│ └── prune.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── yarn.lock
bin/
: 包含可执行文件http2-push-manifest
,用于生成 push manifest。lib/
: 包含项目的主要逻辑文件,如资源发现 (discover.js
)、主入口 (index.js
) 和资源修剪 (prune.js
)。test/
: 包含项目的测试文件,对应lib/
目录中的文件。.gitignore
: 指定 Git 版本控制系统忽略的文件和目录。.npmignore
: 指定 npm 发布时忽略的文件和目录。.travis.yml
: Travis CI 配置文件。LICENSE
: 项目许可证,Apache 2.0。package.json
: 项目的 npm 配置文件,包含依赖、脚本等信息。README.md
: 项目说明文档。yarn.lock
: Yarn 包管理器的锁定文件,确保依赖版本一致。
2. 项目的启动文件介绍
项目的启动文件位于 bin/
目录下的 http2-push-manifest
。这是一个可执行脚本,用于生成 HTTP/2 push manifest。其主要功能是读取指定的 HTML 文件,发现其中的静态资源,并生成一个 JSON 文件,列出所有需要推送的资源。
3. 项目的配置文件介绍
项目的配置主要通过命令行参数进行。以下是一些常用的配置选项:
-f, --file <path>
: 指定要分析的 HTML 文件路径。-m, --manifest <path>
: 指定生成的 push manifest 文件路径。
例如,生成 push manifest 的命令如下:
http2-push-manifest -f path/to/site/index.html -m push.json
这个命令会读取 path/to/site/index.html
文件,生成一个名为 push.json
的 push manifest 文件。
结语
通过以上介绍,您应该对 http2-push-manifest
项目有了基本的了解。希望这份文档能帮助您更好地使用和配置该项目。