// ==UserScript==
// @name GitHub 汉化插件
// @namespace https://github.com/Eq52/TamperMonkeyScripts/tree/main/github-chinese-translation
// @version 0.5.4
// @description 将 GitHub 界面翻译为中文（Dashboard / 导航 / 搜索 / 筛选 / 仓库 / 页脚）
// @license GPL-3.0-only
// @author Eq52
// @match https://github.com/*
// @grant none
// @run-at document-end
// ==/UserScript==
(function () {
'use strict';
// ========== 翻译词典 ==========
//
// 两种条目格式：
//
// 1) 简单文本替换（textContent 精确匹配）：
// { pattern: '原文', replacement: '译文' }
// { pattern: '原文', replacement: '译文', selector: 'CSS选择器' } // 缩小范围
//
// 2) 自定义替换函数（含子标签 / 需保留内部结构的元素）：
// { selector: 'CSS选择器', replace: (el) => { ... return boolean } }
//
const dict = [
// ================================================================
// 搜索栏
// ================================================================
// 占位文本 "Type / to search"（含 kbd 子标签，保留结构）
{
selector: 'span.Search-module__placeholder__p9hbG, span.Search-module__value__TFoak',
replace(el) {
if (!/^Type\s+\/\s+to\s+search$/.test(el.textContent.trim())) return false;
el.childNodes.forEach(node => {
if (node.nodeType === Node.TEXT_NODE) {
const t = node.textContent.trim();
if (t === 'Type') node.textContent = '按下 ';
else if (t === 'to search') node.textContent = ' 开始搜索';
}
});
return true;
},
},
// 搜索弹窗 —— 文本
{ pattern: 'Search all of GitHub', replacement: '搜索整个 GitHub' },
{ pattern: 'Search in this repository', replacement: '在该仓内搜索' },
{ pattern: 'Search in this owner', replacement: '在此账号中搜索' },
{ pattern: 'Search syntax tips', replacement: '搜索语法提示' },
{ pattern: 'Give feedback', replacement: '反馈' },
// 搜索弹窗 —— 分组标题（h3.QueryBuilder-sectionTitle）
{
selector: 'h3.QueryBuilder-sectionTitle',
replace(el) {
const text = el.textContent.trim();
const map = { 'Repositories': '仓库', 'Code': '代码' };
if (map[text]) { el.textContent = map[text]; return true; }
return false;
},
},
// ================================================================
// 顶部导航栏
// ================================================================
// 导航 tab（span[data-content] 系列）
{
selector: 'span[data-content]',
replace(el) {
const text = el.textContent.trim();
const map = {
'Overview': '概述',
'Code': '代码',
'Issues': '议题',
'Pull requests': '拉取请求',
'Repositories': '仓库',
'Projects': '项目',
'Packages': '包',
'Stars': '星标',
'Discussions': '讨论',
'Actions': '操作',
'Agents': '代理',
'Security and quality': '安全和质量',
'Insights': '洞察',
'Settings': '设置',
};
if (map[text]) { el.textContent = map[text]; return true; }
return false;
},
},
// Dashboard 面包屑
{ pattern: 'Dashboard', replacement: '仪表盘' },
// ================================================================
// Dashboard 主体
// ================================================================
{ pattern: 'One moment please...', replacement: '请稍等...' },
{ pattern: 'Feed', replacement: '动态', selector: '[data-target="feed-container.feedTitle"]' },
{ pattern: 'Top repositories', replacement: '热门仓库' },
// ================================================================
// 筛选
// ================================================================
// 筛选按钮（summary 内含 SVG 图标 + hidden counter span）
{
selector: 'summary.hx_rsm-trigger',
replace(el) {
let done = false;
el.childNodes.forEach(node => {
if (node.nodeType === Node.TEXT_NODE && node.textContent.trim() === 'Filter') {
node.textContent = '筛选';
done = true;
}
});
return done;
},
},
// 筛选菜单标题
{ pattern: 'Filter', replacement: '筛选', selector: 'span.SelectMenu-title' },
// 筛选菜单 —— 各选项
{ pattern: 'Events', replacement: '活动' },
{ pattern: 'Activity you want to see on your feed', replacement: '你希望在动态中看到的活动' },
{ pattern: 'Announcements', replacement: '公告' },
{ pattern: 'Releases', replacement: '发行版' },
{ pattern: 'Sponsors', replacement: '赞助' },
{ pattern: 'Stars', replacement: '星标' },
{ pattern: 'Repositories', replacement: '仓库' },
{ pattern: 'Repository activity', replacement: '仓库活动' },
{ pattern: 'Follows', replacement: '关注' },
{ pattern: 'Recommendations', replacement: '推荐' },
{ pattern: 'Include events from starred repositories', replacement: '包含来自已星标仓库的事件' },
{ pattern: 'By default, the feed shows events from repositories you sponsor or watch, and people you follow.', replacement: '默认情况下，动态信息流会显示来自您赞助或关注的仓库以及您关注的人的活动。' },
{ pattern: 'Reset to default', replacement: '重置' },
{ pattern: 'Save', replacement: '保存' },
// ================================================================
// 仓库侧边栏（含 Counter 数字标签，如 "Releases 8"）
// ================================================================
{
selector: 'a.Link--primary',
replace(el) {
if (!el.querySelector(':scope > span.Counter')) return false;
for (const node of el.childNodes) {
if (node.nodeType === Node.TEXT_NODE) {
const t = node.textContent.trim();
const map = { 'Releases': '发行版', 'Packages': '包', 'Contributors': '贡献者' };
if (map[t]) { node.textContent = map[t]; return true; }
}
}
return false;
},
},
// ================================================================
// 仓库页面
// ================================================================
{ pattern: 'About', replacement: '关于' },
{ pattern: 'Languages', replacement: '代码语言' },
{ pattern: 'Suggested workflows', replacement: '推荐的工作流' },
{ pattern: 'Contribution activity', replacement: '贡献动态' },
// ================================================================
// 编辑仓库对话框
// ================================================================
{ pattern: 'Edit repository details', replacement: '编辑仓库详情' },
{ pattern: 'Description', replacement: '描述' },
{ pattern: 'Website', replacement: '网站' },
// "Use your GitHub Pages website"（label 内含 checkbox input）
{
selector: 'label',
replace(el) {
if (!el.querySelector('input.js-use-pages-url')) return false;
for (const node of el.childNodes) {
if (node.nodeType === Node.TEXT_NODE && node.textContent.trim().startsWith('Use your GitHub Pages website')) {
node.textContent = ' 使用 GitHub Pages 网站';
return true;
}
}
return false;
},
},
{ pattern: 'Cancel', replacement: '取消' },
{ pattern: 'Cancel changes', replacement: '取消更改' },
{ pattern: 'Save changes', replacement: '保存改动' },
{ pattern: 'Commit changes...', replacement: '提交更改...' },
// Commit changes（不含省略号）—— 仅匹配 h1/span，跳过含 data-edit-text 的 button
{ pattern: 'Commit changes', replacement: '提交更改', selector: 'h1, span' },
// ================================================================
// 提交更改对话框
// ================================================================
{ pattern: 'Commit message', replacement: '提交更改' },
{ pattern: 'Extended description', replacement: '详细描述' },
// textarea placeholder
{
selector: 'textarea[placeholder*="extended description"]',
replace(el) {
if (el.placeholder.includes('Add an optional extended description')) {
el.placeholder = '添加详细描述(可选)...';
return true;
}
return false;
},
},
// 提交按钮（含 data-edit-text / data-pull-text 属性，需同步更新）
{
selector: 'button[data-edit-text*="Commit changes"]',
replace(el) {
let done = false;
el.childNodes.forEach(node => {
if (node.nodeType === Node.TEXT_NODE && node.textContent.trim() === 'Commit changes') {
node.textContent = node.textContent.replace('Commit changes', '提交更改');
done = true;
}
});
if (el.getAttribute('data-edit-text') === 'Commit changes') {
el.setAttribute('data-edit-text', '提交更改');
}
if (el.getAttribute('data-pull-text') === 'Propose changes') {
el.setAttribute('data-pull-text', '提议更改');
}
return done;
},
},
// ================================================================
// 文件编辑器
// ================================================================
// Edit / Preview 切换按钮（segmentedControl，词太常见需选择器约束）
{
selector: 'div.segmentedControl-text[data-text]',
replace(el) {
const map = { 'Edit': '编辑', 'Preview': '预览' };
const text = el.textContent.trim();
if (map[text]) { el.textContent = map[text]; el.setAttribute('data-text', map[text]); return true; }
return false;
},
},
// Loading preview（含 spinner 子元素 + 尾部文本节点）
{
selector: 'div[class*="EditorPreview"]',
replace(el) {
let done = false;
// 替换尾部文本节点 "Loading preview…" → "加载预览…"
el.childNodes.forEach(node => {
if (node.nodeType === Node.TEXT_NODE && node.textContent.trim() === 'Loading preview…') {
node.textContent = '加载预览…';
done = true;
}
});
// 替换内部隐藏 span 的 "Loading" → "加载中"
if (done) {
el.querySelectorAll('span[class*="VisuallyHidden"]').forEach(s => {
if (s.textContent.trim() === 'Loading') s.textContent = '加载中';
});
}
return done;
},
},
// ================================================================
// 代码浏览
// ================================================================
{ pattern: 'Show Diff', replacement: '显示差异' },
{ pattern: 'Files', replacement: '文件', selector: 'h2[class*="CodeViewFileTreeLayout"]' },
// ================================================================
// 个人主页
// ================================================================
{ pattern: 'Achievements', replacement: '成就' },
// Pinned（h2 内含 spinner SVG + hidden span）
{
selector: 'h2.f4',
replace(el) {
if (!el.querySelector('.spinner, svg.anim-rotate')) return false;
let done = false;
el.childNodes.forEach(node => {
if (node.nodeType === Node.TEXT_NODE && node.textContent.trim() === 'Pinned') {
node.textContent = '置顶';
done = true;
}
});
return done;
},
},
{ pattern: 'Customize your pins', replacement: '自定义你的置顶项' },
{ pattern: 'Contribution settings', replacement: '贡献设置' },
// ================================================================
// 创建菜单（ActionList.Item.Label 系列）
// ================================================================
{ pattern: 'New issue', replacement: '新建议题' },
{ pattern: 'New repository', replacement: '新建仓库' },
{ pattern: 'Import repository', replacement: '导入仓库' },
{ pattern: 'Create new file', replacement: '创建新文件' },
{ pattern: 'Upload files', replacement: '上传文件' },
// ================================================================
// 设置页
// ================================================================
{ pattern: 'General', replacement: '通用', selector: 'span.ActionListItem-label' },
// ================================================================
// 页脚
// ================================================================
{ pattern: 'Terms', replacement: '条款' },
{ pattern: 'Privacy', replacement: '隐私' },
{ pattern: 'Security', replacement: '安全' },
{ pattern: 'Status', replacement: '状态' },
{ pattern: 'Community', replacement: '社区' },
{ pattern: 'Docs', replacement: '文档' },
{ pattern: 'Contact', replacement: '联系' },
{ pattern: 'Manage cookies', replacement: '管理 cookies' },
{ pattern: 'Do not share my personal information', replacement: '不要分享我的个人信息' },
// ================================================================
// 输入框 placeholder（属性翻译，非文本内容）
// ================================================================
{
selector: 'input[placeholder*="Find a repository"]',
replace(el) {
if (el.placeholder.includes('Find a repository')) {
el.placeholder = el.placeholder.replace('Find a repository', '查找仓库');
return true;
}
return false;
},
},
{
selector: 'input[placeholder*="Go to file"]',
replace(el) {
if (el.placeholder.includes('Go to file')) {
el.placeholder = el.placeholder.replace('Go to file', '转到文件');
if (el.getAttribute('aria-label') === 'Go to file') {
el.setAttribute('aria-label', '转到文件');
}
return true;
}
return false;
},
},
];
// ========== 工具函数 ==========
function normalize(str) {
return str.replace(/\s+/g, ' ').trim();
}
function isTranslated(el) {
return el.hasAttribute('data-gh-zh');
}
function markTranslated(el) {
el.setAttribute('data-gh-zh', 'true');
}
/**
* 安全设置文本内容：当元素有子元素时，只修改文本节点，保留子元素结构。
* 例如 →
*/
function safeSetTextContent(el, newText) {
// 叶子节点（无子元素）—— 直接设置
if (el.children.length === 0) {
el.textContent = newText;
return;
}
// 有子元素 —— 只修改文本节点，保留所有子元素
let replaced = false;
for (const child of el.childNodes) {
if (child.nodeType !== Node.TEXT_NODE) continue;
if (replaced) {
// 已替换完主体文本，清空后续文本节点
if (child.textContent.trim() !== '') child.textContent = '';
continue;
}
if (child.textContent.trim() !== '') {
// 这是承载匹配文本的文本节点
child.textContent = newText;
replaced = true;
}
}
if (!replaced) el.textContent = newText; // 兜底
}
function tryTranslate(el, entry) {
// ---- 自定义函数模式 ----
if (typeof entry.replace === 'function') {
if (entry.selector && !el.matches(entry.selector)) return false;
const ok = entry.replace(el);
if (ok) {
markTranslated(el);
}
return ok;
}
// ---- 标准 pattern 模式 ----
if (entry.selector && !el.matches(entry.selector)) return false;
const raw = normalize(el.textContent);
const isReg = entry.pattern instanceof RegExp;
if (isReg ? entry.pattern.test(raw) : raw === entry.pattern) {
safeSetTextContent(el, entry.replacement);
markTranslated(el);
return true;
}
return false;
}
// ========== 翻译引擎 ==========
function translateAll() {
const skipTags = new Set([
'SCRIPT', 'STYLE', 'NOSCRIPT', 'SVG', 'CODE', 'PRE', 'TEXTAREA', 'INPUT',
]);
// ---------- 第一遍：简单文本匹配（遍历文本叶子节点）----------
const walker = document.createTreeWalker(
document.body,
NodeFilter.SHOW_TEXT,
{
acceptNode(node) {
if (!node.textContent.trim()) return NodeFilter.FILTER_REJECT;
const parent = node.parentElement;
if (!parent) return NodeFilter.FILTER_REJECT;
if (skipTags.has(parent.tagName)) return NodeFilter.FILTER_REJECT;
if (isTranslated(parent)) return NodeFilter.FILTER_REJECT;
return NodeFilter.FILTER_ACCEPT;
},
},
);
const processed = new Set();
let textNode;
while ((textNode = walker.nextNode())) {
const el = textNode.parentElement;
if (processed.has(el)) continue;
processed.add(el);
for (const entry of dict) {
// 跳过自定义函数条目（由第二遍处理）
if (typeof entry.replace === 'function') continue;
if (tryTranslate(el, entry)) break;
}
}
// ---------- 第二遍：自定义函数条目 + 带选择器的 HTML 条目 ----------
for (const entry of dict) {
// 只处理：自定义函数 / 有 html 标记 / 有选择器但未在第一遍被匹配的
const isCustomFn = typeof entry.replace === 'function';
const isSelectorOnly = entry.selector && !entry.html && !isCustomFn;
if (isSelectorOnly) continue; // 纯选择器条目已在第一遍处理
if (!isCustomFn && !entry.html) continue;
const selector = entry.selector || 'span, a, h1, h2, h3, h4, h5, h6, p, div, button, li, label, summary';
const candidates = document.querySelectorAll(selector);
for (const el of candidates) {
if (!isTranslated(el)) tryTranslate(el, entry);
}
}
}
// ========== DOM 变化监听 ==========
let pending = false;
const observer = new MutationObserver(() => {
if (pending) return;
pending = true;
requestAnimationFrame(() => {
translateAll();
pending = false;
});
});
// ========== 初始化 ==========
function init() {
console.log(
`%c
` +
` ________ ___ ___ _______ ________ ________ _______
` +
` |\\ __ \\ |\\ \\ / /| |\\ ___ \\ |\\ __ \\ |\\ ____\\ / ___ \\
` +
` \\ \\ \\|\\ /_ \\ \\ \\/ / / \\ \\ __/| \\ \\ \\|\\ \\ \\ \\ \\___|_ /__/|_/ /|
` +
` \\ \\ __ \\ \\ \\ / / \\ \\ \\_|/__\\ \\ \\\\\\ \\ \\ \\_____ \\|__|// / /
` +
` \\ \\ \\|\\ \\ \\/ / / \\ \\ \\_|\\ \\\\ \\ \\\\\\ \\ \\|____|\\ \\ / /_/__
` +
` \\ \\_______\\ __/ / / \\ \\_______\\\\ \\_____ \\ ____\\_\\ \\ |\\________\\
` +
` \\|_______||\\___/ / \\|_______| \\|___| \\__\\|\\_________\\ \\|_______|
` +
` \\|___|/ \\|__|\\|_________|
` +
`%c GitHub 汉化插件 v0.4.0 | %d 条翻译规则已加载 | DOM 监听已启动`,
'color: #00ff41',
'color: #1f883d; font-weight: bold',
dict.length
);
translateAll();
observer.observe(document.body, {
childList: true,
subtree: true,
characterData: true,
});
// 监听 GitHub SPA 路由切换
document.addEventListener('pjax:end', translateAll);
document.addEventListener('turbolinks:load', translateAll);
document.addEventListener('turbo:load', translateAll);
}
if (document.readyState === 'complete' || document.readyState === 'interactive') {
init();
} else {
document.addEventListener('DOMContentLoaded', init);
}
})();