refined-github / github-url-detection

Which GitHub page are you on? Is it an issue? Is it a list? Perfect for your WebExtension or userscript.

Refined GitHub

Browser extension that simplifies the GitHub interface and adds useful features

We use GitHub a lot and notice many annoyances we'd like to fix. So here be dragons.

Our hope is that GitHub will notice and implement some of these much-needed improvements. So if you like any of these improvements, please open a discussion on GitHub feedback or contact GitHub support about doing it.

GitHub Enterprise is also supported: How to enable it.

The GITHUB and REFINED GITHUB trademarks are owned by GitHub, Inc. and used under license.

Install

and other Chromium browsers

including Firefox Android

on Mac, iOS and iPadOS

If you love Refined GitHub, consider sponsoring or hiring the maintainer @fregante

@fregante’s open source work is supported by the community. Special thanks to: Next-generation Node.js and TypeScript ORM with an intuitive data model, automated migrations, type-safety & auto-completion.

Sindre’s open source work is supported by the community. Special thanks to: Your app, enterprise-ready. Start selling to enterprise customers with just a few lines of code. Add Single Sign-On (and more) in minutes instead of months. Dev environments built for the cloud Natively integrated with GitLab, GitHub, and Bitbucket, Gitpod automatically and continuously prebuilds dev environments for all your branches. As a result team members can instantly start coding with fresh dev environments for each new task - no matter if you are building a new feature, want to fix a bug, or work on a code review.

---

Highlights 🔥

Makes whitespace characters visible	Adds one-click merge conflict fixers
Shows how far behind a PR head branch is + tells you its base commit	Lets you hide every event except comments or unresolved comments in issues and PRs
Lets you subscribe to opening/closing events of issues in one click	Adds a link to the default branch on directory listings and files
Adds a button to discard all the changes to a file in a PR	Select notifications by type and status

Repositories

• 🔥 Adds a build/CI status icon next to the repo’s name.
• Adds useful links to the repository navigation dropdown
• Adds a link to swap branches in the branch compare view.
• Displays the age of the repository in the sidebar.
• In your forked repos, shows number of your open PRs to the original repo.
• Makes some buttons on repository lists more compact to make room for other features.
• Automatically disables projects and wikis when creating a repository.
• Makes sidebars sticky in repositories, issues, and PRs, if they fit the viewport.
• Adds a link to visit the user’s github.io website from its repo.
• In the workflows sidebar, shows an indicator that a workflow can be triggered manually, and its next scheduled time if relevant.
• Lets you delete your repos in a click, if they have no stars, issues, or PRs.
• Helps you find forks on archived repos.
• Moves the "Security" and "Insights" to the repository navigation dropdown. Also moves the "Projects", "Actions" and "Wiki" tabs if they're empty/unused.
• Adds the profile picture to the header of public repositories.
• Adds a link to create issues from anywhere in a repository.
• Shows a small avatar next to the username in issue/PR lists and mentions.
• 🔥 Tells you whether you're looking at the latest version of a repository, or if there are any unreleased commits.
• 🔥 Adds a link back to the PR that ran the workflow.
• Makes the tabs more compact on mobile so more of them can be seen.
• Shows whether a repo is a fork and adds the number of stars to its header.
• When navigating a repo's file on a specific tag, it adds a link to see the release/tag itself.

File management

• Adds a button to download entire folders, via https://download-directory.github.io.
• Adds a button to toggle the repo file list.
• Adds a button to edit files from the repo file list.
• Enables the File Finder keyboard shortcut (t) on entire repository.
• Shows the associated PRs on branches for forked repositories.
• Adds a link to preview HTML files.
• Highlights the most-recently-modified items in file lists.
• Lets you see the previous version of a file in one click.

Code

• Linkifies issue/PR references and URLs in code and issue/PR titles.
• Enhances the y hotkey to also copy the permalink.
• Linkifies symbolic links files.
• Alerts you if the current file is altered by an open PR.
• Reduces tabs’ size to 4 spaces instead of 8 where GitHub doesn't follow the user’s preferences.
• Adds a keyboard shortcut to deselect the current line: esc.
• Shows Markdown front matter as vertical table.
• On branch commit lists, shows the PR that touches the current branch.

Writing comments

• 🔥 Enables tab and shift tab for indentation in comment fields.
• Adds a button to insert collapsible content (via <details>).
• 🔥 Auto-resizes comment fields to fit their content and no longer show scroll bars.
• Lets you edit any comment with one click instead of having to open a dropdown.
• Adds a shortcut to edit your last comment: ↑. (Only works in the following comment field, if it’s empty.)
• Wraps selected text when pressing one of Markdown symbols instead of replacing it: [ ` ' " * ~ _
• Hides unnecessary comment field tooltips and toolbar items (each one has a keyboard shortcut.)
• Adds a button to @mention a user in issues and PRs.
• Adds a button in the text editor to quickly insert a simplified HTML table.
• Notifies the user of unfinished comments in hidden tabs.
• Adds a button to delete review comments in one click when editing them.
• Disables the enter-to-submit shortcut in some commit/PR/issue title fields to avoid accidental submissions. Use ctrl enter instead.

Reading comments

• 🔥 Adds reaction avatars showing who reacted to a comment.
• Embeds short gists when linked in comments on their own lines.
• Adds links to browse the repository and linked files at the time of each comment.
• Adds the real name of users by their usernames.
• Shortens URLs and repo URLs to readable references like "_user/repo/.file@d71718d".
• 🔥 Previews hidden comments inline.
• 🔥 Highlights the most useful comment in issues.
• Hides reaction comments ("+1", "👍", …) (except the maintainers’) but they can still be shown.
• Limits the height of tall code blocks and quotes.
• Simplifies the UI to hide comments.
• Makes the "comment" icon in issue lists link to the latest comment of the issue.
• On long conversations where GitHub hides comments under a "N hidden items. Load more...", alt-clicking it will load up to 200 comments at once instead of 60.
• Adds shortcuts to issues, PRs conversations, and PR file lists: j focuses the comment/file below; k focuses the comment/file above.
• Informs you that there are hidden comments in the header of long issues. Also scrolls down to the hidden comments when pressing Cmd+F or Ctrl+F.

Conversations

• Lets you open all visible issues/PRs at once.
• Makes the issue/PR list’s filters toolbar sticky.
• Highlights issues/PRs opened by you or the current repo’s collaborators.
• In issue/PR lists, aligns the labels to the left, below each title.
• 🔥 Changes the default sort order of issues/PRs to Recently updated.
• Adds Everything you’re involved in and Everything you subscribed to filters in the search box dropdown.
• Adds filters for issues/PRs in your repos and commented on by you in the global issue/PR search.
• 🔥 Hides empty sections (or just their "empty" label) in the issue/PR sidebar.
• Hides Projects and Milestones filters in issue/PR lists if they are empty.
• Adds a shortcut to toggle all similar items (minimized comments, deferred diffs, etc) at once: alt click on each button or checkbox.
• Lets you toggle between is:open/is:closed/is:merged filters in searches.
• Adds a "Bugs" tab to repos, if there are any open issues with the "bug" label.
• Replaces the "opened" time with the "updated" time on pinned issues.
• Changes the layout of pinned issues from side-by-side to a standard list.
• Adds one-click buttons to remove labels in issues/PRs.
• Removes duplicate information in the header of issues and PRs ("User wants to merge X commits from Y into Z")
• Dims commits and PRs by bots to reduce noise.
• Adds a shortcut to cancel editing a issue/PR title: esc.
• Hides the update time of issues/PRs in lists when it matches the open/closed/merged time.
• Links the "Contributor" and "Member" labels on comments to the author’s commits on the repo.
• Adds a link to jump to the latest close event of a issue/PR.
• Lets you "close issue as unplanned" in one click instead of three.
• Show a label on locked issues and PRs.

Viewing pull requests

• Adds a link to the non-PR commit when visiting a PR commit.
• Adds Checks and Draft PR dropdown filters in PR lists.
• Shows color-coded review counts in PR lists.
• Shows the base branch in PR lists if it’s not the default branch.
• Hides inactive deployments in PRs.
• Adds duplicate commit navigation buttons at the bottom of the Commits tab page.
• Adds comment indicators when comments are hidden in PR review.
• Shows which PRs have conflicts in PR lists.
• Adds diff stats on PR commits.
• Adds a line-through to the deleted branches in PRs.
• Mark/unmark multiple files as “Viewed” in the PR Files tab. Click on the first checkbox you want to mark/unmark and then shift-click another one; all the files between the two checkboxes will be marked/unmarked as “Viewed”.
• 🔥 Shows the first Git tag a merged PR was included in or suggests creating a release if not yet released.
• Jumps to first non-viewed file in a PR when clicking on the progress bar.
• Adds a link to jump to the latest changed requested comment.
• Adds a link to open the latest deployment from the header of a PR.
• Always uses unified diffs on files where split diffs aren’t useful.
• Makes it easier to distinguish draft PR in lists.

Editing pull requests

• 🔥 Uses the PR’s title as the default squash commit title and updates the PR’s title to match the commit title, if changed.
• Adds an "Update branch" button to every PR. GitHub has the same feature, but it must be manually configured with protected branches.
• Simplifies the PR review form: Approve or reject reviews faster with one-click review-type buttons.
• Adds keyboard shortcuts to cycle through PR tabs: g ← and g →, or g 1, g 2, g 3, and g 4.
• Automatically deletes the branch right after merging a PR, if possible.
• Lets you create draft PRs and public gists in one click.
• Clears the PR merge commit message of clutter, leaving only deduplicated co-authors.
• Adds quick-review buttons to the PR sidebar, automatically focuses the review textarea, and adds a keyboard shortcut to open the review popup: v.
• Uses the first commit for a new PR’s title and description.

Commits

• Adds links to .patch and .diff files in commits.
• Adds links to view the raw version, the blame, and the history of files in PRs and commits.
• Adds one-click buttons to change diff style and to ignore the whitespace and a keyboard shortcut to ignore the whitespace: d w.
• Widens the Expand diff button to be clickable across the screen.
• Hides diff signs since diffs are color coded already.
• Suggests limiting commit and PR titles to 72 characters.
• Displays the corresponding tags next to commits.
• Marks merge commits in commit lists.
• When exploring blames, Alt-clicking the “Reblame” buttons will extract the associated PR’s commits first, instead of treating the commit as a single change.
• Indicates with an icon whether files in commits and PRs are being added or removed.
• Enables toggling file diffs by clicking on their header bar.
• Preserves current branch and path when viewing all commits by an author.
• Enables toggling commit messages by clicking on the commit box.
• Linkifies the "X files changed" text on compare pages to allow jumping to the diff.

Tags and releases

• Adds a download count next to release assets.
• Adds a Releases tab and a keyboard shortcut: g r.
• Adds a tags dropdown/search on tag/release pages.
• Adds a keyboard shortcut to create a new release while on the Releases page: c.
• 🔥 Adds a link to changes since last tag/release for each tag/release.
• Adds a button to convert a release to draft.
• Adds a button to view the changelog file from the releases page.

Profiles

• On profiles, it shows whether the user follows you.
• Adds a link to the user’s public gists on their profile.
• Marks private organizations on your own profile.
• Adds a keyboard shortcut to visit your own profile: g m.
• Adds a link to the user’s most starred repositories.
• Hides forks and archived repos from profiles (but they can still be shown.)
• Linkifies the user location in their hovercard and profile page.
• Shows the user local time in their hovercard (based on their last commit).
• Adds a link to the issues and pulls on the user profile repository tab and global search.

Newsfeed

• Hides other inutile newsfeed events (commits, forks, new followers).
• Automagically expands the newsfeed when you scroll down.

Notifications

• Adds a button to open all your unread notifications at once.
• Adds a shortcut to select all visible notifications: a.
• Linkifies the header of each notification group (when grouped by repository).
• Stops redirecting to notification inbox from notification bar actions while holding Alt.
• Adds a link to the last page of notifications.
• Points PR notifications to the Conversation tabs instead of the commits page, which may be a 404.
• Make the notifications action bar sticky.

Global

• 🔥 Adds possible related pages and alternatives on 404 pages.
• Adds a keyboard shortcut to open selection in new tab when navigating via j and k: shift o.
• Automatically closes dropdown menus when they’re no longer visible.
• GitHub renders `text in backticks` in some places but not others; this features fills in where forgotten.
• Adds shortcuts to navigate through pages with pagination: ← and →.
• Lets you see how others are using the current Action in the Marketplace.
• Shows all of Refined GitHub’s new keyboard shortcuts in the help modal (? hotkey).

Netiquette

• Adds unobtrusive netiquette reminders.
• Warns you when creating a PR from the default branch, as it’s an anti-pattern.
• Warns you when unchecking Allow edits from maintainers, as it’s maintainer-hostile.
• Reminds you you’re commenting on a draft PR by changing the submit button’s label.

Fixes for GitHub shortcomings

• Removes the file hover effect in the repo file browser.
• Removes unnecessary or redundant information from the repository sidebar.
• Linkifies branch references in "Quick PR" pages.
• Removes the autocomplete on search fields.
• Adds a menu item to embed a gist via <iframe>.
• Points the "View file" on PRs to the branch instead of the commit, so the Edit/Delete buttons will be enabled on the "View file" page.
• Makes labels clickable on the dashboard.
• Retries downloading images that failed downloading due to GitHub limited proxying.
• Makes some dropdowns 1-click instead of unnecessarily 2-click.
• Suggests fixing links that are wrongly shortened by GitHub.
• Linkifies the username in the edit history popup.
• Avoids creating duplicate PRs when mistakenly clicking "Create pull request" more than once.
• Moves the "Convert PR to Draft" button to the mergeability box and adds visual feedback to its confirm button.
• Prevents the merge panel from automatically opening on every page load after it’s been opened once.
• Adds keyboard shortcuts to select items in command palette using ctrl n and ctrl p (macOS only).
• Enables submission via ctrl enter on every page possible.
• While writing/editing comments, open the preview links in new tab instead of navigating away from the page.
• Redirect to repo issue list when the search doesn‘t include is:pr.
• Drops redundant "readme-ov-file" parameter from repo URLs.
• Closes checks list when clicking outside of modal.
• Linkifies the line numbers where GitHub forgot to add links.

Previously part of Refined GitHub

GitHub took inspiration from Refined GitHub and natively implemented dozens of its features, 🎉 so they've been removed from this extension. You can also see all the past features of Refined GitHub in a single list.

Customization

Most features can be disabled if they are JavaScript-based and you can override our CSS with your own in the extension options.

We're happy to receive suggestions and contributions, but be aware this is a highly opinionated project. There's a high bar for adding features. Users will always disagree with something. That being said, we're open to discussing things.

Links

• More extensions
• Contribution guide

github-url-detection's Issues

`isRepoRoot` Fails on https://github.com/Witold101/wpw

https://github.com/Witold101/wpw

I can't figure out why. Maybe because the username start with an upper case letter? but in this repo we are not doing .toLowercase()??

Is `isProfile` supposed to include gist profiles?

github-url-detection/index.ts

Lines 520 to 523 in f92d888

	export const isProfile = (url: URL | HTMLAnchorElement | Location = location): boolean => {
	const pathname = getCleanPathname(url);
	return pathname.length > 0 && !pathname.includes('/') && !pathname.includes('.') && !reservedNames.includes(pathname);
	};

I am getting an error in RGH
profile-gists-link and show-user-top-repositories due to isProfile working on gists.
https://gist.github.com/yakov116

Add `isExplore`, `isSponsors`, `isTopics`, `isCollections`, `isExploreNewsletter`, and `isEvents`

Examples

isExplore('https://github.com/explore')                      // true
isSponsors('https://github.com/sponsors')                    // true
isSponsors('https://github.com/sponsors/accounts')           // true
isSponsors('https://github.com/sponsors/{profile}/waitlist') // true
isSponsors('https://github.com/sponsors/community')          // true
isTopics('https://github.com/topics')                        // true
isTopics('https://github.com/topics/{topic}')                // true
isCollections('https://github.com/collections')              // true
isCollections('https://github.com/collections/{collection}') // true
isEvents('https://github.com/events')                        // true
isEvents('https://github.com/events/{event}')                // true
isExploreNewsletter('https://github.com/explore/email')      // true

Are you willing to submit a pull request?

Yes

Organization sub tabs are not detected

Example URL https://github.com/orgs/tc39/packages

I would think it would be included in isOrganizationProfile() just like is isUserProfile

I think just checking for /orgs should be enough

Template generation page should not be part of `isRepo`

Test URL https://github.com/fregante/browser-extension-template/generate

Potentially use new `route-pattern` meta tag

I see a new meta tag that we could use in some situations. I don't think we should actually drop our own URL-based detections, but we can use these to disambiguate some situations

isRepoHome

<meta name="route-pattern" content="/:user_id/:repository">

isIssueList

<meta name="route-pattern" content="/:user_id/:repository/issues(.:format)">

isRepoTree

<meta name="route-pattern" content="/:user_id/:repository/tree/*name(/*path)">

`[property="og:url"]` does not give the full url on the release page

=> "/sindresorhus/refined-github/releases"

https://github.com/sindresorhus/refined-github/releases

Calls for major release

I'm going to release a breaking version. Anything else you'd like to see?

• #132
• #131
• #130
• #139
• #138
• #136

Fix auto-deployment

It's unclear what the problem is, but npm publish throws for some reason. Help wanted to debug this.

npm notice 📦  [email protected]
npm notice === Tarball Contents === 
npm notice 1.1kB  license         
npm notice 11.8kB cjs/index.js    
npm notice 11.5kB esm/index.js    
npm notice 22B    esm/package.json
npm notice 1.7kB  package.json    
npm notice 2.8kB  readme.md       
npm notice 5.2kB  cjs/index.d.ts  
npm notice 5.2kB  esm/index.d.ts  
npm notice === Tarball Details === 
npm notice name:          github-url-detection                    
npm notice version:       1.2.1                                   
npm notice package size:  7.1 kB                                  
npm notice unpacked size: 39.4 kB                                 
npm notice shasum:        6f51c2edac9a387c670b71c28f0144026fa708b9
npm notice integrity:     sha512-KB+69+slQ+NTG[...]BjP0a3QJ2oEXA==
npm notice total files:   8                                       
npm notice 
npm ERR! code E404
npm ERR! 404 Not Found - PUT https://registry.npmjs.org/github-url-detection - Not found
npm ERR! 404 
npm ERR! 404  '[email protected]' is not in the npm registry.
npm ERR! 404 You should bug the author to publish it (or use the name yourself!)

https://github.com/fregante/github-url-detection/actions/runs/137623208/workflow

`canUserEditRepo` is broken?

refined-github/refined-github#3783 added this line

// Hide empty meta if it’s not editable by the current user
// TODO: once it's fixed, use https://github.com/fregante/github-url-detection/blob/4840d85d31d59bfe71e884ef42c482fbfff2d955/index.ts#L490
if (!select.exists('.repository-content [aria-label="Edit repository metadata"]')) {

Implying that canUserEditRepo is broken. Needs to be checked on multiple pages to make sure it works and where it doesn't.

cc @cheap-glitch since you wrote that comment you might have more details.

`isFileFinder` should include `/tree/*/?search=1`

`isRepoIssueList` doesn't include `/user/repo/labels/label`

See refined-github/refined-github#4154.

Add `isUserTheRepositoryCollaborator`

I noticed there are duplicate separators for checking write access in Refined GitHub:

• https://github.com/refined-github/refined-github/blob/1fd96d7e4f50b998390562080500881c2c626c8e/source/features/quick-comment-edit.tsx#L13
• https://github.com/refined-github/refined-github/blob/1fd96d7e4f50b998390562080500881c2c626c8e/source/features/wait-for-build.tsx#L109

Maybe add a isUserTheRepositoryCollaborator (candidate name) method to check for the existence of .lock-toggle-link or canUserEditRepo().

The problem is that this only works on hasComments()...

Create release notes via GitHub Actions

Tags created via GA don't currently have an associated release. Help wanted to find an easy-to-use action to create it.

https://github.com/fregante/github-url-detection/releases

`isOrganizationRepo` is broken due to new search

I don't see any tags in the head to determine this anymore. I think the earliest indicator is #repository-container-header .author[data-hovercard-type="organization"]

.AppHeader-context-full [data-hovercard-type="organization"]

Re-include `isRepoSearch` in `isRepo`

As described in refined-github/refined-github#5739 (comment)

1. Drop isRepoSearch exclusion from isRepo
2. Add hasRepoHeader (isRepo && !isRepoSearch)
3. Ensure that other detections aren't affected by this change (e.g. isSingleFile depends on isRepo, but it never matched isRepoSearch in the first place, so that's fine)
4. Release breaking version
5. All isRepo usage in the extension to hasRepoHeader

Migrate `getCurrentCommittish` and `GitHubURL` here?

Another GitHub-related browser extension Gitako encountered the infamous "slash-in-branch-name" issue: EnixCoda/Gitako#243

Refined GitHub had similar experience and that (along with other issues) resulted in the GitHubURL helper (and its dependency getCurrentCommittish). I think these helpers are generally useful for others as well, so is there any interest maintaining them here?

Issue with this approach is that the helpers are huge comparing to the existing getRepo helper. And it's not super related to URL detection, so it probably should be its own thing.

`isReleasesOrTags` !== `isReleases || isTags`

I think isReleasesOrTags is wrong.

• isReleases: /user/repo/releases
• isTags: /user/repo/tags
• isReleasesOrTags: ?

You'd think that it would match ONLY those two URLs, but it also matches isSingleTag

https://refined-github.github.io/github-url-detection/?url=%2Frefined-github%2Frefined-github%2Freleases%2Ftag%2F2

Possible resolutions (non-exclusive):

• drop isSingleTag from isReleasesOrTags
• rename to isReleaseList and isTagList and isReleaseOrTagList
• add isSingleReleaseOrTag

Use meta tags in isRepoPublic

I see these tags:

<meta name="octolytics-dimension-user_id" content="1402241" />
<meta
  name="octolytics-dimension-user_login"
  content="fregante"
/>
<meta name="octolytics-dimension-repository_id" content="47542242" />
<meta
  name="octolytics-dimension-repository_nwo"
  content="fregante/iphone-inline-video"
/>
<meta name="octolytics-dimension-repository_public" content="true" />
<meta
  name="octolytics-dimension-repository_is_fork"
  content="false"
/>
<meta
  name="octolytics-dimension-repository_network_root_id"
  content="47542242"
/>
<meta
  name="octolytics-dimension-repository_network_root_nwo"
  content="fregante/iphone-inline-video"
/>

octolytics-dimension-repository_public can probably be used for this

Demo website is broken

It seems like the demo website is broken (tested in latest Firefox and Chromium). The page is blank except for the explanation message and the following console error is produced:

Uncaught TypeError: e.default is not a constructor
    epB2 https://fregante.github.io/github-url-detection/main.127a4158.js:4
    f https://fregante.github.io/github-url-detection/main.127a4158.js:1
    parcelRequire https://fregante.github.io/github-url-detection/main.127a4158.js:1
    <anonymous> https://fregante.github.io/github-url-detection/main.127a4158.js:1
main.127a4158.js:4:182

Change any references to `discussions`

Until GitHub Discussions was introduced, I referred to "issues and PRs" as "discussions."

This needs to change because "discussions" now are their own thing.

GitHub internally refers to them both as "issues" or "issues and pull requests"

Perhaps:

• s/issue/issueOnly/
• s/pr/prOnly/
• s/discussion/issue/

or just

• s/discussion/issueOrPR/ - Example, kinda: 364d37b

Both solutions are super awkward

`isArchivedRepo` broken on Global navigation update

No ".Label" element anymore, it only appears on the repo home

https://github.com/fregante/iphone-inline-video

📕 0.0.0 → TypeError: Cannot read properties of null (reading 'textContent')
    at Module.isArchivedRepo (refined-github.js:26029:90)
    at isArchivedRepoAsync (refined-github.js:18073:60)
    at async init (refined-github.js:12546:7)
    at async runFeature (refined-github.js:3797:16)
    at async setupPageLoad (refined-github.js:3809:5)

Update isOpenPR and related detections

From

exists('#partial-discussion-header [title="Status: Open"], #partial-discussion-header [title="Status: Draft"]')

to

exists('.gh-header-meta [title$="Open"], .gh-header-meta [title$="Draft"]'),

but more likely a mix of the 2.

Note: let's not use :is yet, it'd be a breaking change.

Missing detection for creating new files

Per refined-github/refined-github#4252 (comment)

In the PR above I want to match patterns of both these URL examples:

- Create new file:         https://github.com/sindresorhus/refined-github/new/main
- Modify an existing file: https://github.com/sindresorhus/refined-github/edit/main/readme.md

Checking them via https://fregante.github.io/github-url-detection/ I see that :

So I have in the PR the following:

	include: [
		...
		pageDetect.isRepo,
		pageDetect.isEditingFile
	],

But, as mentioned by @yakov116:

Adding isRepo will add it to all repo pages (PR's Issues etc)

Include example URLs in JSDocs

It would be good to expose the example/test URLs in the JSDocs:

I'm not sure how how to do this automatically though:

• write the test URLs in JSDocs and have the test runner read them (how?!). This has the advantage of "just working" when building it via TS
• manually extending the types via build, either via typescript transform or via post-build step (gives me a headache just thinking about it)

Something similar was suggested by @kidonng on the RG repo if I remember correctly.

Current situation:

Add `isSingleGistCode`

Extracted from #80

---

This "is gist" but it's not the standard page with a gist. Do we need a more specific detection?

https://gist.github.com/fregante/2205329b71218fa2c1d3/revisions

Discussions aren't part of `hasComments`

Was this a conscious choice or should we add it?

Example aminomancer/uc.css.js#4

Detect if the current user profile page has a readme

Add `elementReady`-like helper for DOM detections

Sometimes we want to test whether a page matches before it's done downloading, this can be done by passing a selector to element-ready.

I have 2 ideas:

Static definitions

Instead of being just a function, we can define the detections as a list of constraints like:

- const canUserEditOrg = (url) => isOrganizationProfile() && exists('.pagehead-tabs-item[href$="/settings/profile"]')
+ const canUserEditOrgDefinition = [isOrganizationProfile, '.pagehead-tabs-item[href$="/settings/profile"]']
+ export canUserEditOrg = solveConstraints(canUserEditOrgDefinition);
+ export canUserEditOrgAsync = solveConstraintsAsync(canUserEditOrgDefinition);

But this gets wordy FAST

Duplicate functions

  const canUserEditOrg = (url) => isOrganizationProfile() && exists('.pagehead-tabs-item[href$="/settings/profile"]')
+ const canUserEditOrgAsync = async (url) => isOrganizationProfile() && await existsReady('.pagehead-tabs-item[href$="/settings/profile"]')

Update vite once they fix a bug

Blocked by:

• vitejs/vite#10735

Context:

• #157
• vitejs/vite#11925 (comment)

Once that's fixed, the first step is to delete .npmrc

Publish script broken?

npm notice 
npm ERR! code ENEEDAUTH
npm ERR! need auth This command requires you to be logged in to https://registry.npmjs.org/
npm ERR! need auth You need to authorize this machine using `npm adduser`

This line was removed:

https://github.com/refined-github/github-url-detection/actions/runs/4082945529/workflow#L28

Maybe it's still needed. What's the minimum required setup for publishing? 🤔

Also the ENV is probably not being shared… https://github.com/fregante/GhostText-for-VSCode/actions/runs/4467201432/jobs/7846357122

error

Run gh release create "$VERSION" --generate-notes
tag required when not running interactively

`getRepositoryInfo` breaks on some pages

Related: refined-github/refined-github#3743
Buggy page: https://github.com/sindresorhus/refined-github/runs/1428929640?check_suite_focus=true

Code to be fixed: https://github.com/fregante/github-url-detection/blob/59527fa38de89231435b6d3a35df8e52c2b6015a/index.ts#L542-L543

I use og:url here instead of location to try to normalize the capitalization.

The problem is that GitHub misuses the og:url here so on that page it lists https://github.com instead of the real URL.

We should put some checks so that it uses location when og:url is broken, like:

if !location.href.toLowerCase().startsWith(canonical.content.toLowerCase) {
	use location
}

Detecting the two kinds of GitHub Security advisories

GitHub has two different kinds of advisories.

The first is the advisories that are published by the repository owners themselves. The last URL part will always end with 'GHSA'. Here's an example of the URL for these:

• GHSA-g3wg-6mcf-8jj6

The second is the advisory that is curated by GitHub, these are similar, but not the same as the advisories published by the project maintainers. These versions are curated/modified/updated by GitHub staff themselves. These get generated after an advisory is published and processed by GitHub. Here's an example of the URL for that:

• GHSA-g3wg-6mcf-8jj6

Also, the above URL incorrectly reports that that URL is:

isRepo(url) // true
isRepoHome(url) // true
isRepoRoot(url) // true
isRepoTree(url) // true

`isRepoRoot` matches all of the `isUserProfile` tabs

Example: https://github.com/sindresorhus?tab=repositories&type=source

I think the following needs isRepo
https://github.com/fregante/github-url-detection/blob/4ff46aa7f89141e45c09bc9957fda4dfa4787b54/index.ts#L297

// cc @FloEdelmann

Add `?url=http://etc` to the demo

So it can be permalinked:

https://refined-github.github.io/github-url-detection/?url=https://github.com/refined-github

bug: is404 incorrect when not logged in

This code doesn't seem to work when not logged in because the title is Page not found · GitHub · GitHub:
https://github.com/fregante/github-url-detection/blob/ca4edcfdc87e26241c10fb27985d73af8d024630/index.ts#L14

Logged in

Not logged in

`hasRenderedText` (markdown etc)

export const isRenderedTextFile = isSingleFile && endsWith(md)
export const hasRenderedText = isRepoRoot || isRenderedTextFile || etc

These shouldn't include SVG and other rendered content

Partially implemented in https://github.com/refined-github/refined-github/pull/4151/files#diff-a1b04b00ad1bdc63f8898dfbf43b2faf61ae3be4f50182d5a144d3e7f0dc7c29R14

Detect password pages

Like https://github.com/sindresorhus/refined-github/blob/2fc61cf1ce9ea8f0d7d4f8cb5e5220ad7faad354/source/features/index.tsx#L87-L91

document.title === 'Confirm password' || document.title === 'Confirm access'

Alternatively it should have "is empty page" that includes both 500 and this password page

`isRepoRoot` doesn't work on branches with slashes

I think I found a way to determine isRepoRoot: use the title

/fregante/github-url-detection	fregante/github-url-detection: Which GitHub page are you on? Is it an issue? Is it a list? Perfect for your WebExtension or userscript
/fregante/github-url-detection/tree/npm-test	fregante/github-url-detection at npm-test
/fregante/github-url-detection/tree/npm-test/esm	github-url-detection/esm at npm-test · fregante/github-url-detection

You can see 2 behaviors:

• isRepoRoot starts with getRepoURL
• isRepoTree does not (but ends with getRepoURL)
  • warning: if the repo is called fregante/fregante and the folder is fregante, then title starts with fregante/fregante and ends with fregante/fregante

The code might be:

const isRepoRoot = (url) => /^(tree\/[^/]+)?$/.test(getRepoPath(url)!) || (!url && document.title.startsWith(getRepoURL()) && !document.title.endsWith(getRepoURL()))

---

Originally discussed at refined-github/refined-github#3254 (comment)

Add `isBlank`

There are several situations where the repo may only show a takedown notice:

• "This repository has been disabled." (TOS takedown)
• "Repository unavailable due to DMCA takedown." (DMCA takedown)
• "Repository unavailable in your location" (GOV takedown)

Additionally, an issue may be deleted and only the repository header is shown.

I propose to add a isBlank detection for them. There are several ways to check for them:

• document.title !== 'GitHub · Where software is built': this is already used in isIssue
• Check for existence of main .blankslate: this may catch more cases and if GitHub ever changes their tagline again 😄

`isPRFiles` doesn't include "PR Files with single commit selected"

Example:

https://github.com/refined-github/refined-github/pull/6635/commits/3b9ad8cd926337efa500c0a496639022cd15c74d

https://github.com/refined-github/refined-github/pull/6635/files/0971327bfbf6509d7c2b8b9abb7868228c43f844..715c21222c67ce7f320f979ecd226c356ff565fe

It appears that isPRFiles is always used together with isPRCommit:

https://github.com/refined-github/refined-github/blob/930d7d5a43536c87c65f189092d868c26ec69dee/source/features/restore-file.tsx#L143-L144

Rename `isActions`

There are 2 kind of actions.

1. Marketplace actions
2. Repo Actions

isMarketplaceActions?

I think that isActions should be the repo one and have isMarketplaceActions as an addition

WDYT?

The current actions
https://github.com/fregante/github-url-detection/blob/0f8a4260f3f869c537b2e9f878ff2f712c4a363d/index.ts#L448-L453

Add `typed-query-selector/strict` locally to ensure selectors are valid

https://github.com/g-plane/typed-query-selector#strict-mode

This type should make TS fail if a selector is invalid. This would avoid:

• #120 (comment)
• 1a04193

cc @yakov116

Move to `refined-github` org

Originally posted in #105 (comment)

• I have to set up redirects for the github.io domain
• change the meta
• ensure that the secrets still work

`isSingleGist` is too broad and incorrect

1. These two (old) URLs are not detected as isSingleGist:

https://gist.github.com/fregante/2205329b71218fa2c1d3
https://gist.github.com/fregante/2205329b71218fa2c1d3/d1ebf7d9cfaba4d4596d2ea9174e202479a5f9ad # this is a specific gist revision

2. This is also detected as isGist, but is actually a /raw/ file, not a gist at all:

https://gist.github.com/fregante/2205329b71218fa2c1d3/raw/d1ebf7d9cfaba4d4596d2ea9174e202479a5f9ad/iframe.js

3. This is correctly detected as isGist, but maybe we should have a more specific isSingleGistCode so that only the code tab is detected.

https://gist.github.com/fregante/2205329b71218fa2c1d3/revisions

---

These changes should probably be based on https://github.com/sindresorhus/refined-github/blob/1a9c4f9b/source/features/embed-gist-inline.tsx#L9-L23 and will replace that inline function (which intends to be isSingleGistCode, but is more like a more specific isSingleGist)

Go to demo: https://fregante.github.io/github-url-detection/

Add `isNewActionRun`

https://github.com/sindresorhus/refined-github/actions/new

isNewActionRun?
isNewAction?

Specific detection for file and directory commit lists

Following from refined-github/refined-github#4677 (review)

We do not have a detection that distinguishes commit lists for files and directories. There is isCommitList which is a merge of isRepoCommitList and isPRCommitList.

Maybe, we should add a isFileCommitList and isDirectoryCommitList and merge them into isRepoCommitList.

However, I am not sure how to distinguish between a directory and a file from the URL. File extensions seems like a non-safe of detection. If there is a more safer way to distinguish between the file and directories, I will be happy to open a pull request for it.

Include wiki diffs in `hasCode`

Example:

https://github.com/pixiebrix/pixiebrix-extension/wiki/Web-Extensions-behaviors/_compare/664a8f7^...664a8f7

There might be more URLs.

Convert package to be pure ESM

The minimum version can be increased to Node 12 and the CJS build can be dropped. The ESM build is still necessary to tree shake the tests however.

AVA configuration should be copied from https://github.com/sindresorhus/refined-github/blob/main/package.json

It’s probably best not to update dependencies in the same PR unless necessary because they’re likely to compound issues.

Create a logger option

Not sure if this belongs here but it can useful in RH. Allow the user to pass a url and it returs all matches. Would be super nice if even the dom ones are returned.