Refined GitHub 开源项目教程

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

Refined GitHub 项目的目录结构如下：

refined-github/
├── .github/
│   ├── FUNDING.yml
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   ├── feature_request.md
│   │   └── support_question.md
│   └── workflows/
│       ├── ci.yml
│       └── release.yml
├── source/
│   ├── content.css
│   ├── background.js
│   ├── options.js
│   ├── options.html
│   ├── manifest.json
│   └── icons/
│       ├── icon.png
│       ├── icon128.png
│       ├── icon48.png
│       └── icon16.png
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .prettierrc
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

目录结构介绍

• .github/: 包含 GitHub 相关的配置文件，如资金支持配置、问题模板和 CI/CD 工作流。
• source/: 包含项目的核心文件，如样式表、脚本、选项页面和图标。
• .editorconfig, .eslintrc, .gitignore, .prettierrc, .travis.yml: 项目配置文件，用于代码风格、版本控制和持续集成。
• LICENSE: 项目的开源许可证。
• README.md: 项目说明文档。
• package.json, yarn.lock: 项目的依赖管理文件。

2. 项目的启动文件介绍

Refined GitHub 项目的启动文件主要是 source/background.js。这个文件是浏览器扩展的背景脚本，负责初始化和处理扩展的主要逻辑。

启动文件介绍

• source/background.js: 负责加载和执行扩展的主要功能，包括监听浏览器事件和执行相应的操作。

3. 项目的配置文件介绍

Refined GitHub 项目的配置文件主要包括以下几个：

• source/manifest.json: 这是浏览器扩展的清单文件，定义了扩展的基本信息、权限、资源路径等。
• package.json: 定义了项目的依赖、脚本和其他元数据。
• .eslintrc: 配置了 ESLint 的规则，用于代码风格检查。
• .prettierrc: 配置了 Prettier 的规则，用于代码格式化。

配置文件介绍

• source/manifest.json:

  {
    "manifest_version": 2,
    "name": "Refined GitHub",
    "version": "22.3.10",
    "description": "Simplifies the GitHub interface and adds useful features",
    "homepage_url": "https://github.com/refined-github/refined-github",
    "icons": {
      "16": "icons/icon16.png",
      "48": "icons/icon48.png",
      "128": "icons/icon128.png"
    },
    "permissions": [
      "activeTab",
      "storage",
      "https://github.com/*",
      "https://api.github.com/*"
    ],
    "background": {
      "scripts": ["background.js"]
    },
    "content_scripts": [
      {
        "matches": ["https://github.com/*"],
        "css": ["content.css"],
        "js": ["content.js"]
      }
    ],
    "options_ui": {
      "page": "options.html",
      "open_in_tab": true
    },
    "browser_action": {
      "default_icon": "icons/icon16.png",
      "default_title": "Refined GitHub"
    }
  }
  

• package.json:

  {
    "name": "refined-github",
    "version": "22.3.10",
    "description": "Simplifies the GitHub interface and adds useful features",
    "repository": "https://github.com/refined-github/refined-github",
    "license": "MIT",
    "scripts": {
      "build": "webpack",