Add rgh-pr-template feature (#6947)

fregante · web-flow · commit 790025bdd9cf · 2023-09-27T19:01:56.000+08:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -2,7 +2,7 @@
 
 Thanks for contributing! 🍄 Do not ignore this template, plz.
 
-1. Does this PR close/fix an existing issue? Write something like `Closes #10`
+1. Does this PR close/fix an existing issue? Write something like: Closes #10
 
 Help us test and visualize this PR:
 
@@ -21,4 +21,3 @@ Lastly:
 
 
 ## Screenshot
-
diff --git a/source/features/rgh-pr-template.tsx b/source/features/rgh-pr-template.tsx
@@ -0,0 +1,39 @@
+import React from 'dom-chef';
+import {replace} from 'text-field-edit';
+import * as pageDetect from 'github-url-detection';
+
+import features from '../feature-manager.js';
+import {isRefinedGitHubRepo} from '../github-helpers/index.js';
+import observe from '../helpers/selector-observer.js';
+
+function extract(textarea: HTMLTextAreaElement): void {
+	replace(textarea, /<!--(.+)-->\n/s, (_, match) => {
+		textarea.closest('tab-container')!.before(
+			<div style={{whiteSpace: 'pre-wrap'}} className="flash mx-2 p-2">
+				{match.trim()}
+			</div>,
+		);
+
+		return '';
+	});
+}
+
+function init(signal: AbortSignal): void {
+	observe('#pull_request_body', extract, {signal});
+}
+
+void features.add(import.meta.url, {
+	asLongAs: [
+		isRefinedGitHubRepo,
+		pageDetect.isCompare,
+	],
+	init,
+});
+
+/*
+
+Test URLs:
+
+https://github.com/refined-github/refined-github/compare/main...sandbox/keep-branch?quick_pull=1
+
+*/
diff --git a/source/refined-github.ts b/source/refined-github.ts
@@ -215,3 +215,4 @@ import './features/action-pr-link.js';
 import './features/rgh-dim-commits.js';
 import './features/mobile-tabs.js';
 import './features/repo-header-info.js';
+import './features/rgh-pr-template.js';
