1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
import React from 'dom-chef';
import select from 'select-dom';
import onetime from 'onetime';
import elementReady from 'element-ready';
import * as pageDetect from 'github-url-detection';
import features from '../feature-manager.js';
import * as api from '../github-helpers/api.js';
import GitHubURL from '../github-helpers/github-url.js';
import getDefaultBranch from '../github-helpers/get-default-branch.js';
import {getCleanPathname} from '../github-helpers/index.js';
type File = {
previous_filename?: string;
filename: string;
status: string;
blob_url: string;
};
type FileChanges = {
file: File;
commit: {
parentSha: string;
date: Date;
url: string;
};
};
function getType(): string {
return location.pathname.split('/').pop()!.includes('.') ? 'file' : 'object';
}
async function is404(url: string): Promise<boolean> {
const {status} = await fetch(url, {method: 'head'});
return status === 404;
}
function getStrikeThrough(text: string): HTMLElement {
return <del className="color-fg-subtle">{text}</del>;
}
async function checkAnchor(anchor: HTMLElement): Promise<void> {
if (anchor instanceof HTMLAnchorElement && await is404(anchor.href)) {
anchor.replaceWith(getStrikeThrough(anchor.textContent!));
}
}
function parseCurrentURL(): string[] {
const parts = getCleanPathname().split('/');
if (parts[2] === 'blob') { // Blob URLs are never useful
parts[2] = 'tree';
}
return parts;
}
async function getLatestCommitToFile(branch: string, filePath: string): Promise<string | void> {
const {repository} = await api.v4(`
repository() {
object(expression: "${branch}") {
... on Commit {
history(first: 1, path: "${filePath}") {
nodes {
oid
}
}
}
}
}
`);
const commit = repository.object?.history.nodes[0];
return commit?.oid;
}
async function getChangesToFileInCommit(sha: string, filePath: string): Promise<FileChanges | void> {
// API v4 doesn't support it: https://github.community/t/what-is-the-corresponding-object-in-graphql-api-v4-for-patch-which-is-available-in-rest-api-v3/13590
const commit = await api.v3(`commits/${sha}`);
for (const fileInfo of commit.files as File[]) {
if ([fileInfo.filename, fileInfo.previous_filename].includes(filePath)) {
return {
commit: {
parentSha: commit.parents[0].sha,
date: commit.commit.committer.date,
url: commit.html_url,
},
file: fileInfo,
};
}
}
}
async function getUrlToFileOnDefaultBranch(): Promise<string | void> {
const parsedUrl = new GitHubURL(location.href);
if (!parsedUrl.branch) {
return;
}
parsedUrl.assign({branch: await getDefaultBranch()});
const urlOnDefault = parsedUrl.href;
if (urlOnDefault !== location.href && !await is404(urlOnDefault)) {
return urlOnDefault;
}
}
async function showMissingPart(): Promise<void> {
const pathParts = parseCurrentURL();
const breadcrumbs = [...pathParts.entries()]
.reverse() // Checks the anchors right to left
.map(([i, part]) => {
if (
// Exclude parts that don't exist as standalones
(i === 0 && part === 'orgs') // #5483
|| (i === 2 && ['tree', 'blob', 'edit'].includes(part))
|| i === pathParts.length - 1 // The last part is a known 404
) {
return getStrikeThrough(part);
}
const pathname = '/' + pathParts.slice(0, i + 1).join('/');
const link = <a href={pathname}>{part}</a>;
void checkAnchor(link);
return link;
})
.reverse() // Restore order
.flatMap((link, i) => [i > 0 && ' / ', link]); // Add separators
select('main > :first-child, #parallax_illustration')!.after(
<h2 className="container mt-4 text-center">{breadcrumbs}</h2>,
);
}
async function showDefaultBranchLink(): Promise<void> {
const urlToFileOnDefaultBranch = await getUrlToFileOnDefaultBranch();
if (!urlToFileOnDefaultBranch) {
return;
}
select('main > .container-lg')!.before(
<p className="container mt-4 text-center">
<a href={urlToFileOnDefaultBranch}>This {getType()}</a> exists on the default branch.
</p>,
);
}
async function showAlternateLink(): Promise<void> {
const url = new GitHubURL(location.href);
if (!url.branch || !url.filePath) {
return;
}
const commitSha = await getLatestCommitToFile(url.branch, url.filePath);
if (!commitSha) {
return;
}
const fileChanges = await getChangesToFileInCommit(commitSha, url.filePath);
if (!fileChanges) {
return;
}
url.assign({route: 'commits'});
const commitHistory = <a href={url.href}>Commit history</a>;
url.assign({route: 'blob', branch: fileChanges.commit.parentSha, filePath: url.filePath});
const lastVersionUrl = fileChanges.file.status === 'removed' ? fileChanges.file.blob_url : url.href;
const lastVersion = <a href={lastVersionUrl}>This {getType()}</a>;
const permalink = <a href={fileChanges.commit.url}><relative-time datetime={fileChanges.commit.date}/></a>;
const verb = fileChanges.file.status === 'removed'
? 'deleted'
: <a href={fileChanges.file.blob_url}>moved</a>;
select('main > .container-lg')!.before(
<p className="container mt-4 text-center">
{lastVersion} was {verb} ({permalink}) - {commitHistory}.
</p>,
);
}
function init(): void {
void showDefaultBranchLink();
void showAlternateLink();
}
async function initPRCommit(): Promise<void | false> {
const commitUrl = location.href.replace(/pull\/\d+\/commits/, 'commit');
if (await is404(commitUrl)) {
return false;
}
const blankSlateParagraph = await elementReady('.blankslate p', {waitForChildren: false});
blankSlateParagraph!.after(
<p>You can also try to <a href={commitUrl}>view the detached standalone commit</a>.</p>,
);
}
void features.add(import.meta.url, {
asLongAs: [
pageDetect.is404,
() => parseCurrentURL().length > 1,
],
awaitDomReady: true, // Small page
init: onetime(showMissingPart),
},
{
asLongAs: [
pageDetect.is404,
],
include: [
pageDetect.isSingleFile,
pageDetect.isRepoTree,
pageDetect.isEditingFile,
],
awaitDomReady: true, // Small page
init: onetime(init),
}, {
include: [
pageDetect.isPRCommit404,
],
init: onetime(initPRCommit),
});
|
