npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

shorten-repo-url

1.5.0 • Public • Published

shorten-repo-url Build Status

Shorten GitHub links like GitHub shortens Issues and Commit links. Used on refined-github

Demo

Look at the tests to see what each URL is shortened to. GitLab URLs are mostly compatible but they're not officially supported.

It works on any domain, so GitHub Enterprise is also supported.

Install

$ npm install shorten-repo-url

Usage

const shortenRepoUrl = require('shorten-repo-url');
 
 
const HTML = shortenRepoUrl(
    'https://github.com/nodejs/node/tree/v0.12/doc',
    'https://github.com/nodejs/node' // same repo
);
//=> '<code>v0.12</code>' // repo-less URL
 
const HTML = shortenRepoUrl(
    'https://github.com/nodejs/node/tree/v0.12/doc',
    'https://github.com' // not the same repo
);
//=> 'nodejs/node@<code>v0.12</code>' // URL with repo
 

API

shortenRepoUrl(url, currentUrl)

Returns the shortened URL in HTML as a string like nodejs/node@<code>v0.12</code>.

url

Type: string

The GitHub URL to shorten.

currentUrl

Type: string, like location.href

The URL of the current page, to build relative URLs like <code>v0.12</code> instead of the longer nodejs/node@<code>v0.12</code>

shortenRepoUrl.applyToLink(link, currentUrl)

Automatically shorten the link's text if the text matches the URL, i.e. <a href="https://github.com">https://github.com</a>

It will return true or false depending on whether the link was shortened.

link

Type: Element

Example: shortenRepoUrl.applyToLink(document.querySelector(a))

currentUrl

Type: string, like location.href

Same as before.

License

MIT © Federico Brigante

install

npm i shorten-repo-url

Downloadsweekly downloads

278

version

1.5.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability