开源项目 Extension.js 使用教程

开源项目 Extension.js 使用教程

extension.js🧩 Plug-and-play, zero-config, cross-browser extension development tool. 项目地址:https://gitcode.com/gh_mirrors/ex/extension.js

项目目录结构及介绍

Extension.js 是一个零配置、即插即用的跨浏览器扩展开发工具，支持TypeScript、WebAssembly、React等现代技术栈。以下是其典型项目结构概述：

my-extension/
├── src                  # 源代码目录，存放你的扩展核心逻辑。
│   ├── background.ts    # 背景脚本，运行在扩展的后台环境。
│   ├── content.ts       # 内容脚本，用于操作网页内容。
│   ├── popup.html       # 弹出窗体的HTML文件。
│   └── ...              # 其他按需的源文件。
├── public               # 静态资源目录，如图标、样式表等。
│   └── icons            # 扩展图标的存储位置。
├── manifest.json        # 扩展的核心配置文件，定义权限、入口点等关键信息。
├── package.json         # Node.js项目描述文件，包含scripts命令和其他依赖。
├── tsconfig.json        # TypeScript编译配置文件（如果使用）。
└── README.md            # 项目说明文档。

每个项目可能会根据实际需求有所不同，但上述结构提供了良好的起点。

项目的启动文件介绍

在Extension.js框架下，并没有传统意义上的单一“启动文件”。然而，开发流程通常通过npm脚本来管理。最重要的两个脚本是位于package.json中的 "dev" 和 "build"。

• package.json 中的 scripts 部分定义了这些命令：

  "scripts": {
      "dev": "extension dev",     // 启动开发模式，自动打开浏览器并加载扩展进行实时调试。
      "build": "extension build"  // 构建扩展，生成可用于发布的生产版本。
  }
  

• 当执行 npm run dev 时，它将激活Extension.js的开发服务器，为快速迭代提供便利。

项目的配置文件介绍

manifest.json

manifest.json 是Chrome、Firefox以及其他支持WebExtensions的浏览器所必需的核心配置文件。它告诉浏览器扩展的基本信息和能力，包括：

• name: 扩展的名称。
• version: 版本号。
• description: 描述扩展的功能。
• icons: 扩展图标的路径。
• background: 背景脚本的信息，可以是脚本路径或服务工作者。
• permissions: 扩展需要的权限列表。
• browser_action 或 page_action: 控制扩展按钮的行为。
• content_scripts: 定义何时何地注入内容脚本。
• 其他特定于功能的键值对。

示例：

{
  "manifest_version": 3,
  "name": "My Awesome Extension",
  "version": "1.0.0",
  "description": "A brief description of what this extension does.",
  "action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "icons/icon16.png",
      "48": "icons/icon48.png",
      "128": "icons/icon128.png"
    }
  },
  "permissions": ["activeTab"],
  ...
}

此文件是每个基于Extension.js的项目中不可或缺的一部分，确保了扩展正确集成到浏览器环境中。

---

以上是对Extension.js项目的一个基本概览，包括其核心目录结构、开发启动机制以及关键配置文件的理解。开发者应根据具体项目需求调整这些基础结构和配置。

extension.js🧩 Plug-and-play, zero-config, cross-browser extension development tool. 项目地址:https://gitcode.com/gh_mirrors/ex/extension.js