GitHub Real Names 扩展项目教程

最新推荐文章于 2024-09-02 08:42:51 发布

秋泉律Samson

最新推荐文章于 2024-09-02 08:42:51 发布

阅读量534

点赞数 15

本文链接：https://blog.csdn.net/gitblog_00249/article/details/141742037

版权

GitHub Real Names 扩展项目教程

github-real-namesA plugin for Google Chrome that adds a button to toggle showing real names instead of usernames on GitHub项目地址:https://gitcode.com/gh_mirrors/gi/github-real-names

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

GitHub Real Names 是一个用于在 GitHub 上显示真实姓名的 Chrome 扩展。以下是该项目的目录结构及其介绍：

github-real-names/
├── .gitignore
├── LICENSE
├── README.md
├── background.js
├── icon-padded.png
├── icon.png
├── index.js
├── manifest.json
├── package.json
└── yarn.lock

.gitignore: 指定 Git 版本控制系统忽略的文件和目录。
LICENSE: 项目的许可证文件，采用 MIT 许可证。
README.md: 项目的说明文档。
background.js: 扩展的后台脚本。
icon-padded.png 和 icon.png: 扩展的图标文件。
index.js: 扩展的主要逻辑脚本。
manifest.json: Chrome 扩展的清单文件，包含扩展的配置信息。
package.json: 项目的依赖管理文件。
yarn.lock: 锁定依赖版本的文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它包含了扩展的主要逻辑。以下是 index.js 的简要介绍：

// index.js
// 主要逻辑脚本，用于处理扩展的功能

该文件负责处理扩展的核心功能，例如在 GitHub 页面上添加按钮以切换显示真实姓名或用户名。

3. 项目的配置文件介绍

项目的配置文件是 manifest.json，它包含了扩展的配置信息。以下是 manifest.json 的内容及其介绍：

{
  "manifest_version": 2,
  "name": "GitHub Real Names",
  "version": "1.3.1",
  "description": "Adds a button to toggle showing real names instead of usernames on GitHub",
  "icons": {
    "128": "icon.png"
  },
  "background": {
    "scripts": ["background.js"]
  },
  "browser_action": {
    "default_icon": "icon.png",
    "default_title": "GitHub Real Names"
  },
  "permissions": [
    "activeTab"
  ],
  "content_scripts": [
    {
      "matches": ["https://github.com/*"],
      "js": ["index.js"]
    }
  ]
}

manifest_version: 指定清单文件的版本，目前为 2。
name: 扩展的名称。
version: 扩展的版本号。
description: 扩展的描述。
icons: 扩展的图标。
background: 指定后台脚本。
browser_action: 浏览器动作的配置，包括默认图标和标题。
permissions: 扩展所需的权限，例如 activeTab。
content_scripts: 指定内容脚本及其匹配的 URL 模式。