https://github.com/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.
https://github.com/refined-github/github-url-detection

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/refined-github/github-url-detection
• Owner: refined-github
• License: mit
• Created: 2020-05-06T00:15:00.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-28T05:39:24.000Z (3 months ago)
• Last Synced: 2024-07-03T14:55:11.570Z (3 months ago)
• Language: TypeScript
• Homepage: https://npm.im/github-url-detection
• Size: 2.28 MB
• Stars: 122
• Watchers: 5
• Forks: 25
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

README

        
#  github-url-detection

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

Battle-tested by and extracted from the [Refined GitHub](https://github.com/sindresorhus/refined-github) extension.

- Try the live [demo](https://refined-github.github.io/github-url-detection/)

- See the code and expected URLs for [every detection](https://github.com/refined-github/github-url-detection/blob/main/index.ts)

## Install

```sh

npm install github-url-detection

```

```js

// This package is pure ESM

import * as pageDetect from 'github-url-detection';

```

## Usage

```js

const href = 'https://github.com/refined-github/github-url-detection/issues/1';

if (pageDetect.isIssue(new URL(href))) { // Pass the URL as an `URL` object

	alert('The passed URL is of an issue!')

}

if (pageDetect.isRepo()) { // Uses `window.location.href` by default

	alert('You’re looking at a repo!')

}

if (pageDetect.isIssueOrPRList()) {

	alert('You’re looking at a issues and PRs list!')

}

```

## API

Most detections are URL-based while others need access to the current `document`. You can determine which ones are URL-based by looking at their signature: URL-based functions have a `url` parameter.

### URL-based detections

By default, URL-based detections use the `location` global if you don't pass a `url` argument.

```js

if (pageDetect.isIssueOrPRList()) {

	alert('You’re looking at a issues or PRs list!')

}

```

```js

if (pageDetect.isIssueOrPRList(new URL('https://github.com/refined-github/github-url-detection/pulls'))) {

	alert('You’re looking at a issues or PRs list!')

}

```

Notice that the `url` parameter is not a plain string but it has to be a proper `URL` or `location` object.

### Document-based detections

By default, `document`-based detections use the `document` global, which means they can only be used if you have the whole page, you can't just test any random URL string.

```js

if (pageDetect.isOrganizationProfile()) {

	alert('You’re on an organization profile, like https://github.com/babel')

}

```

## 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.

- [shorten-repo-url](https://github.com/fregante/shorten-repo-url) - Shorten GitHub links like GitHub shortens Issues and Commit links.

## License

MIT © [Federico Brigante](https://fregante.com)