Mailvelope 开源项目教程

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

Mailvelope 是一个用于在网页上进行端到端加密邮件通信的开源项目。其目录结构如下：

mailvelope/
├── app/
│   ├── css/
│   ├── images/
│   ├── js/
│   ├── lib/
│   ├── templates/
│   ├── translations/
│   ├── index.html
│   └── manifest.json
├── background/
│   ├── js/
│   └── manifest.json
├── content-scripts/
│   ├── css/
│   ├── js/
│   └── manifest.json
├── options/
│   ├── css/
│   ├── images/
│   ├── js/
│   ├── templates/
│   ├── translations/
│   ├── index.html
│   └── manifest.json
├── popup/
│   ├── css/
│   ├── images/
│   ├── js/
│   ├── templates/
│   ├── translations/
│   ├── index.html
│   └── manifest.json
├── shared/
│   ├── css/
│   ├── js/
│   └── manifest.json
├── tests/
│   ├── e2e/
│   ├── integration/
│   ├── unit/
│   └── karma.conf.js
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── bower.json
├── gulpfile.js
├── package.json
└── webpack.config.js

目录结构介绍

• app/: 包含主要的应用程序文件，如CSS、图片、JavaScript、库、模板和翻译文件。
• background/: 包含后台脚本和相关配置文件。
• content-scripts/: 包含内容脚本和相关配置文件。
• options/: 包含选项页面的文件，如CSS、图片、JavaScript、模板和翻译文件。
• popup/: 包含弹出窗口的文件，如CSS、图片、JavaScript、模板和翻译文件。
• shared/: 包含共享的CSS和JavaScript文件。
• tests/: 包含各种测试文件，如端到端测试、集成测试和单元测试。
• 根目录下的文件包括配置文件、许可证、README文档、构建工具配置文件等。

2. 项目的启动文件介绍

Mailvelope 的启动文件主要是 app/index.html 和 background/js/background.js。

app/index.html

这是 Mailvelope 的主要入口文件，包含了应用程序的基本结构和初始化脚本。

background/js/background.js

这是后台脚本文件，负责处理浏览器扩展的后台逻辑，如消息传递、事件监听等。

3. 项目的配置文件介绍

Mailvelope 的配置文件主要包括 manifest.json 文件和 package.json 文件。

manifest.json

manifest.json 文件在多个目录中都有，每个目录下的 manifest.json 文件负责该目录下的文件配置。例如：

• app/manifest.json: 配置应用程序的主要文件和权限。
• background/manifest.json: 配置后台脚本的文件和权限。
• content-scripts/manifest.json: 配置内容脚本的文件和权限。
• options/manifest.json: 配置选项页面的文件和权限。
• popup/manifest.json: 配置弹出窗口的文件和权限。

package.json

package.json 文件位于项目根目录下，包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "mailvelope",
  "version": "4.5.0",
  "description": "Mailvelope is a browser extension for Google Chrome and Firefox that allows secure email communication based on the OpenPGP standard.",
  "main": "gulpfile.js",
  "scripts": {
    "test": "karma start tests/karma.conf.js",
    "build": "gulp build",
    "start": "gulp watch"
  },
  "dependencies": {
    "babel-core": "^6.26.3",
    "babel-loader": "^7.1.5",
    "babel-preset-env": "^1.7.0",
    "css-loader": "^3.2