Skip to content
This repository was archived by the owner on Apr 3, 2024. It is now read-only.

fix: Relative GitHub paths when a directory is specified #455

Open
mofojed wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: Relative GitHub paths when a directory is specified #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions lib/plugin/github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,22 @@ var path = require('path')

var DEFAULT_REF = 'HEAD'

function repositorySuffix (repository) {
if (repository.directory) {
return repository.directory + '/'
}
return ''
}

function buildImageUrl (repository, url) {
var prefix = 'https://raw.githubusercontent.com/'
return prefix + path.join(repository.user, repository.repo, DEFAULT_REF, url.href)
var suffix = repositorySuffix(repository)
return prefix + path.join(repository.user, repository.repo, DEFAULT_REF, suffix, url.href)
}

function buildLinkUrl (repository, url) {
return repository.https_url + path.join('/blob/' + DEFAULT_REF + '/', url.href)
var suffix = repositorySuffix(repository)
return repository.https_url + path.join('/blob/', DEFAULT_REF, suffix, url.href)
}

// search the provided HTML snippet and rewrite the attribute on the given tag
Expand Down Expand Up @@ -53,6 +62,11 @@ module.exports = function (md, opts) {

if (!repo) return

if (opts.package.repository.directory) {
// Add the directory to the repository if specified
repo.directory = opts.package.repository.directory
}

// rewrite image locations to be fully qualified github URLs
var originalImageRule = md.renderer.rules.image
md.renderer.rules.image = function (tokens, idx, options, env, self) {
Expand Down
29 changes: 29 additions & 0 deletions test/repo-github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ var cheerio = require('cheerio')
describe('when package repo is on github', function () {
var $
var $short
var $long
var pkg = {
name: 'wahlberg',
repository: {
Expand All @@ -19,16 +20,26 @@ describe('when package repo is on github', function () {
name: 'wahlberg',
repository: 'mark/wahlberg'
}
var longPkg = {
name: '@wahlberg/boogie-nights',
repository: {
type: 'git',
url: 'https://github.com/mark/wahlberg',
directory: 'packages/boogie-nights'
}
}

before(function () {
$ = cheerio.load(marky(fixtures.github, {package: pkg}))
$short = cheerio.load(marky(fixtures.github, {package: shortPkg}))
$long = cheerio.load(marky(fixtures.github, {package: longPkg}))
})

it('rewrites relative link hrefs to absolute', function () {
assert(~fixtures.github.indexOf('(relative/file.js)'))
assert($("a[href='https://github.com/mark/wahlberg/blob/HEAD/relative/file.js']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/relative/file.js']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/relative/file.js']").length)
})

it('rewrites relative link hrefs to absolute (HTML)', function () {
Expand All @@ -38,12 +49,15 @@ describe('when package repo is on github', function () {
assert($("a[href='https://github.com/mark/wahlberg/blob/HEAD/html-page-and-image.html']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/html-page.html']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/html-page-and-image.html']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/html-page.html']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/html-page-and-image.html']").length)
})

it('rewrites slashy relative links hrefs to absolute', function () {
assert(~fixtures.github.indexOf('(/slashy/poo)'))
assert($("a[href='https://github.com/mark/wahlberg/blob/HEAD/slashy/poo']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/slashy/poo']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/slashy/poo']").length)
})

it('rewrites slashy relative links hrefs to absolute (HTML)', function () {
Expand All @@ -53,24 +67,29 @@ describe('when package repo is on github', function () {
assert($("a[href='https://github.com/mark/wahlberg/blob/HEAD/html/block.html']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/nested/link/image']").length)
assert($short("a[href='https://github.com/mark/wahlberg/blob/HEAD/html/block.html']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/nested/link/image']").length)
assert($long("a[href='https://github.com/mark/wahlberg/blob/HEAD/packages/boogie-nights/html/block.html']").length)
})

it('leaves protocol-relative URLs alone', function () {
assert(~fixtures.github.indexOf('(//protocollie.com)'))
assert($("a[href='//protocollie.com']").length)
assert($short("a[href='//protocollie.com']").length)
assert($long("a[href='//protocollie.com']").length)
})

it('leaves hashy URLs alone', function () {
assert(~fixtures.github.indexOf('(#header)'))
assert($("a[href='#header']").length)
assert($short("a[href='#header']").length)
assert($long("a[href='#header']").length)
})

it('replaces relative img URLs with github URLs', function () {
assert(~fixtures.github.indexOf('![](relative.png)'))
assert($("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/relative.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/relative.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/relative.png']").length)
})

it('replaces relative img URLs with github URLs (HTML)', function () {
Expand All @@ -80,22 +99,28 @@ describe('when package repo is on github', function () {
assert($("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html-page-and-image.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html-image.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html-page-and-image.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/html-image.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/html-page-and-image.png']").length)
})

it('replaces relative img URLs with github URLs (HTML, multiline)', function () {
var src = "<p>\n<img src='html-image.png'/>\n</p>"
var $$ = cheerio.load(marky(src, {package: pkg}))
var $$short = cheerio.load(marky(src, {package: shortPkg}))
var $$long = cheerio.load(marky(src, {package: longPkg}))
assert($("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html-image.png']").length)
assert($$short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html-image.png']").length)
assert($$long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/html-image.png']").length)
assert.equal(-1, $$.html().indexOf('<p></p>'))
assert.equal(-1, $$short.html().indexOf('<p></p>'))
assert.equal(-1, $$long.html().indexOf('<p></p>'))
})

it('replaces slashy relative img URLs with github URLs', function () {
assert(~fixtures.github.indexOf('![](/slashy/deep.png)'))
assert($("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/slashy/deep.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/slashy/deep.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/slashy/deep.png']").length)
})

it('replaces slashy relative img URLs with github URLs (HTML)', function () {
Expand All @@ -105,18 +130,22 @@ describe('when package repo is on github', function () {
assert($("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html/block.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/nested/link/image/image.png']").length)
assert($short("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/html/block.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/nested/link/image/image.png']").length)
assert($long("img[src='https://raw.githubusercontent.com/mark/wahlberg/HEAD/packages/boogie-nights/html/block.png']").length)
})

it('leaves protocol relative URLs alone', function () {
assert(~fixtures.github.indexOf('![](//protocollie.com/woof.png)'))
assert($("img[src='//protocollie.com/woof.png']").length)
assert($short("img[src='//protocollie.com/woof.png']").length)
assert($long("img[src='//protocollie.com/woof.png']").length)
})

it('leaves HTTPS URLs alone', function () {
assert(~fixtures.github.indexOf('![](https://secure.com/good.png)'))
assert($("img[src='https://secure.com/good.png']").length)
assert($short("img[src='https://secure.com/good.png']").length)
assert($long("img[src='https://secure.com/good.png']").length)
})

it('survives a falsy repository.url', function () {
Expand Down