summaryrefslogtreecommitdiff
path: root/source/features/rgh-feature-descriptions.tsx
blob: d1a7d655bebfe97c05b20c22548e21356a2a8f23 (plain) (blame)
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
import './rgh-feature-descriptions.css';
import React from 'dom-chef';
import * as pageDetect from 'github-url-detection';
import {CopyIcon} from '@primer/octicons-react';
import cache from 'webext-storage-cache';

import features from '../feature-manager.js';
import {featuresMeta} from '../../readme.md';
import {getNewFeatureName} from '../options-storage.js';
import {isRefinedGitHubRepo} from '../github-helpers/index.js';
import observe from '../helpers/selector-observer.js';
import {HotfixStorage} from '../helpers/hotfix.js';
import {createRghIssueLink} from '../helpers/rgh-issue-link.js';

async function add(infoBanner: HTMLElement): Promise<void> {
	const [, currentFeature] = /source\/features\/([^.]+)/.exec(location.pathname) ?? [];
	// Enable link even on past commits
	const currentFeatureName = getNewFeatureName(currentFeature);
	const feature = featuresMeta.find(feature => feature.id === currentFeatureName);
	if (!feature) {
		return;
	}

	const conversationsUrl = new URL('https://github.com/refined-github/refined-github/issues');
	conversationsUrl.searchParams.set('q', `sort:updated-desc "${feature.id}"`);

	infoBanner.before(
		// Block and width classes required to avoid margin collapse
		<div className="Box mb-3 d-inline-block width-full">
			<div className="Box-row d-flex gap-3 flex-wrap">
				<div className="rgh-feature-description">
					<h3 className="mb-2"><code>{feature.id}</code>
						<clipboard-copy
							aria-label="Copy"
							data-copy-feedback="Copied!"
							value={feature.id}
							class="Link--onHover color-fg-muted d-inline-block ml-2"
							tabindex="0"
							role="button"
						>
							<CopyIcon className="v-align-baseline"/>
						</clipboard-copy>
					</h3>
					{ /* eslint-disable-next-line react/no-danger */ }
					<div dangerouslySetInnerHTML={{__html: feature.description}} className="h3"/>
					<div className="no-wrap" data-turbo-frame="repo-content-turbo-frame">
						<a href={conversationsUrl.href}>Related issues</a>
						{
							location.pathname.endsWith('css')
								? <><a href={location.pathname.replace('.css', '.tsx')}>See JavaScript</a></>
								: undefined
						}
					</div>
				</div>
				{feature.screenshot && (
					<a href={feature.screenshot} className="flex-self-center">
						<img
							src={feature.screenshot}
							className="d-block border"
							style={{
								maxHeight: 100,
								maxWidth: 150,
							}}/>
					</a>
				)}
			</div>
		</div>,
	);

	// Skip dev check present in `getLocalHotfixes`, we want to see this even when developing
	const hotfixes = await cache.get<HotfixStorage>('hotfixes:') ?? [];

	const hotfixed = hotfixes.find(([feature]) => feature === currentFeatureName);
	if (!hotfixed) {
		return;
	}

	const [_name, issue, unaffectedVersion] = hotfixed;

	infoBanner.before(
		<div className="mb-3 d-inline-block width-full flash flash-warn mb-2">
			<strong>Note:</strong> This feature is disabled due to {createRghIssueLink(issue)}
			{unaffectedVersion && ` until version ${unaffectedVersion}`}
		</div>,
	);
}

function init(signal: AbortSignal): void {
	observe('#repos-sticky-header', add, {signal});
}

void features.add(import.meta.url, {
	asLongAs: [
		isRefinedGitHubRepo,
	],
	include: [
		pageDetect.isSingleFile,
	],
	init,
});

/*

Test URLs:

- https://github.com/refined-github/refined-github/blob/main/source/features/sync-pr-commit-title.tsx
- https://github.com/refined-github/refined-github/blob/main/source/features/clean-conversation-sidebar.css

*/