Merge branch 'main' into copilot/add-typed-query-selector-strict-again

fregante · web-flow · commit dd52b115e59c · 2026-04-05T15:30:20.000+07:00
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -15,6 +15,10 @@ on:
         description: 'Version accepted by `npm version *`'
         required: true
 
+permissions:
+  contents: write
+  id-token: write
+
 jobs:
   NPM:
     runs-on: ubuntu-latest
@@ -23,17 +27,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version-file: package.json
-          registry-url: https://registry.npmjs.org
       - run: npm ci || npm install
       - uses: fregante/setup-git-user@v2
       - name: Create version
         # Get the generated version, this enables support for keywords: `npm version patch`
         run: |
           VERSION="$(npm version "${{ github.event.inputs.Version }}")"
           echo "VERSION=$VERSION" >> $GITHUB_ENV
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: npm publish --provenance --access public
       - run: git push --follow-tags
       - run: gh release create "$VERSION" --generate-notes
         env:
diff --git a/index.test.ts b/index.test.ts
@@ -5,8 +5,15 @@ import stripIndent from 'strip-indent';
 import {getAllUrls, getTests} from './collector.js';
 import * as pageDetect from './index.js';
 
-(globalThis as any).document = {title: ''};
+(globalThis as any).document = {title: '', readyState: 'loading'};
 (globalThis as any).location = new URL('https://github.com/');
+(globalThis as any).requestAnimationFrame = (callback: FrameRequestCallback) => setTimeout(() => {
+	callback(Date.now());
+}, 0) as unknown as number;
+
+(globalThis as any).cancelAnimationFrame = (id: number) => {
+	clearTimeout(id);
+};
 
 const allUrls = getAllUrls();
 
@@ -281,3 +288,45 @@ test('parseRepoExplorerTitle', () => {
 		undefined,
 	);
 });
+
+test('waitFor - immediately true', async () => {
+	const detection = () => true;
+	const result = await pageDetect.utils.waitFor(detection);
+	assert.equal(result, true);
+});
+
+test('waitFor - becomes true', async () => {
+	let callCount = 0;
+	const detection = () => {
+		callCount++;
+		return callCount >= 3;
+	};
+
+	const result = await pageDetect.utils.waitFor(detection);
+	assert.equal(result, true);
+	assert.ok(callCount >= 3);
+});
+
+test('waitFor - false when document complete', async () => {
+	// Save original state
+	const originalReadyState = Object.getOwnPropertyDescriptor(document, 'readyState');
+
+	// Mock document.readyState to be 'complete'
+	Object.defineProperty(document, 'readyState', {
+		writable: true,
+		configurable: true,
+		value: 'complete',
+	});
+
+	const detection = () => false;
+	const result = await pageDetect.utils.waitFor(detection);
+	assert.equal(result, false);
+
+	// Restore original state
+	if (originalReadyState) {
+		Object.defineProperty(document, 'readyState', originalReadyState);
+	} else {
+		// If readyState wasn't a property before, delete it
+		delete (document as any).readyState;
+	}
+});
diff --git a/index.ts b/index.ts
@@ -20,6 +20,35 @@ function exists(selector: string): boolean {
 	return Boolean(document.querySelector(selector));
 }
 
+/**
+ * Waits for a detection to return true by repeatedly checking it on each animation frame.
+ * Useful for DOM-based detections that need to wait for elements to appear.
+ * @param detection - A detection function to check repeatedly
+ * @returns A promise that resolves to the final result of the detection
+ * @example
+ * ```
+ * import {utils} from 'github-url-detection';
+ *
+ * async function init() {
+ *   if (!await utils.waitFor(isOrganizationProfile)) {
+ *     return;
+ *   }
+ *   // Do something when on organization profile
+ * }
+ * ```
+ */
+async function waitFor(detection: () => boolean): Promise<boolean> {
+	// eslint-disable-next-line no-await-in-loop -- We need to wait on each frame
+	while (!detection() && document.readyState !== 'complete') {
+		// eslint-disable-next-line no-await-in-loop
+		await new Promise(resolve => {
+			requestAnimationFrame(resolve);
+		});
+	}
+
+	return detection();
+}
+
 const combinedTestOnly = ['combinedTestOnly']; // To be used only to skip tests of combined functions, i.e. isPageA() || isPageB()
 
 TEST: addTests('__urls_that_dont_match__', [
@@ -68,9 +97,7 @@ TEST: addTests('isCompare', [
 	'https://github.com/sindresorhus/refined-github/compare',
 	'https://github.com/sindresorhus/refined-github/compare/',
 	'https://github.com/sindresorhus/refined-github/compare/master...branch-name',
-	'https://github.com/sindresorhus/refined-github/compare/master...branch-name?quick_pull=1',
-	'https://github.com/sindresorhus/refined-github/compare/branch-1...branch-2?quick_pull=1',
-	'https://github.com/sindresorhus/refined-github/compare/test-branch?quick_pull=1',
+	'isQuickPR',
 ]);
 
 export const isCompareWikiPage = (url: URL | HTMLAnchorElement | Location = location): boolean => isRepoWiki(url) && getCleanPathname(url).split('/').slice(3, 5).includes('_compare');
@@ -79,17 +106,19 @@ TEST: addTests('isCompareWikiPage', [
 	'https://github.com/brookhong/Surfingkeys/wiki/Color-Themes/_compare/8ebb46b1a12d16fc1af442b7df0ca13ca3bb34dc...80e51eeabe69b15a3f23880ecc36f800b71e6c6d',
 ]);
 
+/**
+ * @deprecated Use `isHome` and/or `isFeed` instead
+ */
 export const isDashboard = (url: URL | HTMLAnchorElement | Location = location): boolean => !isGist(url) && /^$|^(orgs\/[^/]+\/)?dashboard(-feed)?(\/|$)/.test(getCleanPathname(url));
 TEST: addTests('isDashboard', [
 	'https://github.com///',
 	'https://github.com//',
 	'https://github.com/',
 	'https://github.com',
-	'https://github.com/orgs/test/dashboard',
+	'https://github.com/orgs/refined-github/dashboard',
 	'https://github.com/dashboard/index/2',
 	'https://github.com//dashboard',
 	'https://github.com/dashboard',
-	'https://github.com/orgs/edit/dashboard',
 	'https://github.big-corp.com/',
 	'https://not-github.com/',
 	'https://my-little-hub.com/',
@@ -102,6 +131,31 @@ TEST: addTests('isDashboard', [
 	'https://github.com/dashboard-feed',
 ]);
 
+export const isHome = (url: URL | HTMLAnchorElement | Location = location): boolean => !isGist(url) && /^$|^dashboard\/?$/.test(getCleanPathname(url));
+TEST: addTests('isHome', [
+	'https://github.com',
+	'https://github.com//dashboard',
+	'https://github.com///',
+	'https://github.com//',
+	'https://github.com/',
+	'https://github.com/dashboard',
+	'https://github.big-corp.com/',
+	'https://not-github.com/',
+	'https://my-little-hub.com/',
+	'https://github.com/?tab=repositories', // Gotcha for `isUserProfileRepoTab`
+	'https://github.com/?tab=stars', // Gotcha for `isUserProfileStarsTab`
+	'https://github.com/?tab=followers', // Gotcha for `isUserProfileFollowersTab`
+	'https://github.com/?tab=following', // Gotcha for `isUserProfileFollowingTab`
+	'https://github.com/?tab=overview', // Gotcha for `isUserProfileMainTab`
+	'https://github.com?search=1', // Gotcha for `isRepoTree`
+]);
+
+export const isFeed = (url: URL | HTMLAnchorElement | Location = location): boolean => !isGist(url) && /^(feed|orgs\/[^/]+\/dashboard)\/?$/.test(getCleanPathname(url));
+TEST: addTests('isFeed', [
+	'https://github.com/feed',
+	'https://github.com/orgs/refined-github/dashboard',
+]);
+
 export const isEnterprise = (url: URL | HTMLAnchorElement | Location = location): boolean => url.hostname !== 'github.com' && url.hostname !== 'gist.github.com';
 TEST: addTests('isEnterprise', [
 	'https://github.big-corp.com/',
@@ -204,7 +258,11 @@ TEST: addTests('isNotifications', [
 
 export const isOrganizationProfile = (): boolean => exists('meta[name="hovercard-subject-tag"][content^="organization"]');
 
-export const isOrganizationRepo = (): boolean => exists('.AppHeader-context-full [data-hovercard-type="organization"]');
+export const isOrganizationRepo = (): boolean => exists([
+	'qbsearch-input[data-current-repository][data-current-org]:not([data-current-repository=""], [data-current-org=""])',
+	// TODO: Remove after June 2026
+	'.AppHeader-context-full [data-hovercard-type="organization"]',
+].join(','));
 
 export const isTeamDiscussion = (url: URL | HTMLAnchorElement | Location = location): boolean => Boolean(getOrg(url)?.path.startsWith('teams'));
 TEST: addTests('isTeamDiscussion', [
@@ -304,18 +362,20 @@ TEST: addTests('isPRFiles', [
 	'https://github.com/refined-github/refined-github/pull/148/changes/1e27d7998afdd3608d9fc3bf95ccf27fa5010641..e1aba6febb3fe38aafd1137cff28b536eeeabe7e',
 ]);
 
-export const isQuickPR = (url: URL | HTMLAnchorElement | Location = location): boolean => isCompare(url) && /[?&]quick_pull=1(&|$)/.test(url.search);
+export const isQuickPR = (url: URL | HTMLAnchorElement | Location = location): boolean => isCompare(url) && /[?&](quick_pull|expand)=1(&|$)/.test(url.search);
 TEST: addTests('isQuickPR', [
 	'https://github.com/sindresorhus/refined-github/compare/master...branch-name?quick_pull=1',
 	'https://github.com/sindresorhus/refined-github/compare/branch-1...branch-2?quick_pull=1',
 	'https://github.com/sindresorhus/refined-github/compare/test-branch?quick_pull=1',
+	'https://github.com/refined-github/sandbox/compare/fregante-patch-2?expand=1',
+	'https://github.com/refined-github/sandbox/compare/default-a...fregante-patch-2?expand=1',
 ]);
 
 const getStateLabel = (): string | undefined => $([
 	'.State', // Old view
 	// React versions
-	'[class^="StateLabel"]',
-	'[data-testid="header-state"]',
+	'[class^="StateLabel"]', // TODO: Remove after July 2026
+	'[class^="prc-StateLabel-StateLabel"]',
 ].join(','))?.textContent?.trim();
 
 export const isMergedPR = (): boolean => getStateLabel() === 'Merged';
@@ -409,9 +469,16 @@ TEST: addTests('isRepo', [
 export const hasRepoHeader = (url: URL | HTMLAnchorElement | Location = location): boolean => isRepo(url) && !isRepoSearch(url);
 TEST: addTests('hasRepoHeader', combinedTestOnly);
 
-// On empty repos, there's only isRepoHome; this element is found in `<head>`
-export const isEmptyRepoRoot = (): boolean => isRepoHome() && !exists('link[rel="canonical"]');
+export const isEmptyRepoRoot = (): boolean => isRepoHome() && exists([
+	// If you don't have write access
+	'.blankslate-icon',
+	// If you have write access
+	'#empty-setup-clone-url',
+].join(','));
 
+/**
+ * @deprecated Doesn't work anymore. Use `isEmptyRepoRoot` or API instead.
+ */
 export const isEmptyRepo = (): boolean => exists('[aria-label="Cannot fork because repository is empty."]');
 
 export const isPublicRepo = (): boolean => exists('meta[name="octolytics-dimension-repository_public"][content="true"]');
@@ -677,6 +744,16 @@ TEST: addTests('isGistRevision', [
 	'https://gist.github.com/kidonng/0d16c7f17045f486751fad1b602204a0/revisions',
 ]);
 
+export const isGistFile = (url: URL | HTMLAnchorElement | Location = location): boolean => {
+	const pathname = getCleanGistPathname(url);
+	return pathname?.replace(/[^/]/g, '').length === 1;
+};
+
+TEST: addTests('isGistFile', [
+	'https://gist.github.com/fregante/2205329b71218fa2c1d3',
+	'https://gist.github.com/sindresorhus/0ea3c2845718a0a0f0beb579ff14f064',
+]);
+
 export const isTrending = (url: URL | HTMLAnchorElement | Location = location): boolean => url.pathname === '/trending' || url.pathname.startsWith('/trending/');
 TEST: addTests('isTrending', [
 	'https://github.com/trending',
@@ -728,7 +805,7 @@ TEST: addTests('isGistProfile', [
 
 export const isUserProfile = (): boolean => isProfile() && !isOrganizationProfile();
 
-export const isPrivateUserProfile = (): boolean => isUserProfile() && !exists('.UnderlineNav-item[href$="tab=stars"]');
+export const isPrivateUserProfile = (): boolean => isUserProfile() && exists('#user-private-profile-frame');
 
 export const isUserProfileMainTab = (): boolean =>
 	isUserProfile()
@@ -860,7 +937,20 @@ TEST: addTests('isRepositoryActions', [
 
 export const isUserTheOrganizationOwner = (): boolean => isOrganizationProfile() && exists('[aria-label="Organization"] [data-tab-item="org-header-settings-tab"]');
 
-export const canUserAdminRepo = (): boolean => isRepo() && exists('.reponav-item[href$="/settings"], [data-tab-item$="settings-tab"]');
+/**
+ * @deprecated Use canUserAccessRepoSettings or API instead.
+ */
+export const canUserAdminRepo = (): boolean => {
+	const repo = getRepo();
+	return Boolean(repo && exists(`:is(${[
+		'.GlobalNav',
+		// Remove after June 2026
+		'.js-repo-nav',
+	].join(',')}) a[href="/${repo.nameWithOwner}/settings"]`));
+};
+
+// eslint-disable-next-line @typescript-eslint/no-deprecated
+export const canUserAccessRepoSettings = canUserAdminRepo;
 
 export const isNewRepo = (url: URL | HTMLAnchorElement | Location = location): boolean => !isGist(url) && (url.pathname === '/new' || /^organizations\/[^/]+\/repositories\/new$/.test(getCleanPathname(url)));
 TEST: addTests('isNewRepo', [
@@ -968,4 +1058,5 @@ export const utils = {
 	getCleanGistPathname,
 	getRepositoryInfo: getRepo,
 	parseRepoExplorerTitle,
+	waitFor,
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "github-url-detection",
-	"version": "11.0.1",
+	"version": "11.1.3",
 	"description": "Which GitHub page are you on? Is it an issue? Is it a list? Perfect for your WebExtension or userscript.",
 	"keywords": [
 		"github",
@@ -42,7 +42,7 @@
 		"xo": "xo"
 	},
 	"dependencies": {
-		"github-reserved-names": "^2.1.1"
+		"github-reserved-names": "^2.1.3"
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^8.1.0",
diff --git a/readme.md b/readme.md
@@ -67,6 +67,30 @@ if (pageDetect.isOrganizationProfile()) {
 }
 ```
 
+### Async detections with `waitFor`
+
+The `waitFor` helper function allows you to wait for a detection to become true by repeatedly checking it on each animation frame. This is useful for DOM-based detections that need to wait for elements to appear before the document is fully loaded.
+
+```js
+import {utils, isOrganizationProfile} from 'github-url-detection';
+
+async function init() {
+	// Wait for the detection to return true or for the document to be complete
+	if (!await utils.waitFor(isOrganizationProfile)) {
+		return; // Not an organization profile
+	}
+
+	// The page is now confirmed to be an organization profile
+	console.log('On organization profile!');
+}
+```
+
+The `waitFor` function:
+- Repeatedly calls the detection function on each animation frame
+- Stops when the detection returns `true` or when `document.readyState` is `'complete'`
+- Returns the final result of the detection
+- Works with any detection function that returns a boolean
+
 ## Related
 
 - [github-reserved-names](https://github.com/Mottie/github-reserved-names) - Get a list, or check if a user or organization name is reserved by GitHub.
