github-url-from-git

What is github-url-from-git?

The 'github-url-from-git' npm package is a utility that helps convert Git URLs to GitHub URLs. This can be particularly useful for developers who need to transform repository URLs for various purposes, such as generating links for documentation or automating workflows.

What are github-url-from-git's main functionalities?

Convert Git URL to GitHub URL

This feature allows you to convert a Git URL (SSH format) to a GitHub URL (HTTPS format). This is useful for creating web links from repository URLs.

const githubUrlFromGit = require('github-url-from-git');
const gitUrl = '[e-mail]:user/repo.git';
const githubUrl = githubUrlFromGit(gitUrl);
console.log(githubUrl); // Outputs: 'https://github.com/user/repo'

Handle different Git URL formats

This feature demonstrates the package's ability to handle different Git URL formats, converting both SSH and HTTPS Git URLs to a standard GitHub URL.

const githubUrlFromGit = require('github-url-from-git');
const gitUrl1 = '[e-mail]:user/repo.git';
const gitUrl2 = 'https://github.com/user/repo.git';
const githubUrl1 = githubUrlFromGit(gitUrl1);
const githubUrl2 = githubUrlFromGit(gitUrl2);
console.log(githubUrl1); // Outputs: 'https://github.com/user/repo'
console.log(githubUrl2); // Outputs: 'https://github.com/user/repo'

Other packages similar to github-url-from-git

parse-github-url

The 'parse-github-url' package parses GitHub URLs into their component parts, such as owner, name, and branch. Unlike 'github-url-from-git', which focuses on converting Git URLs to GitHub URLs, 'parse-github-url' is more about breaking down the URL into its components for further processing.

github-url-to-object

The 'github-url-to-object' package converts GitHub URLs into objects containing useful information like user, repo, and branch. While 'github-url-from-git' converts Git URLs to GitHub URLs, 'github-url-to-object' provides a more detailed breakdown of the URL's components.

README

github-url-from-git

describe('parse(url)', function () {
  it('should support git://*', function () {
    var url = 'git://github.com/jamesor/mongoose-versioner'
    parse(url).should.equal('https://github.com/jamesor/mongoose-versioner')
  })

  it('should support git://*.git', function () {
    var url = 'git://github.com/treygriffith/cellar.git'
    parse(url).should.equal('https://github.com/treygriffith/cellar')
  })

  it('should support https://*', function () {
    var url = 'https://github.com/Empeeric/i18n-node'
    parse(url).should.equal('https://github.com/Empeeric/i18n-node')
  })

  it('should support https://*.git', function () {
    var url = 'https://[e-mail]/banchee/tranquil.git'
    parse(url).should.equal('https://github.com/banchee/tranquil')
  })

  it('should return undefined on failure', function () {
    var url = 'git://github.com/justgord/.git'
    assert(parse(url) == null)
  })

  it('should parse [e-mail]:bcoe/thumbd.git', function () {
    var url = '[e-mail]:bcoe/thumbd.git'
    parse(url).should.eql('https://github.com/bcoe/thumbd')
  })

  it('should parse [e-mail]:/bcoe/thumbd.git', function () {
    var url = '[e-mail]:/bcoe/thumbd.git'
    parse(url).should.eql('https://github.com/bcoe/thumbd')
  })

  it('should parse [e-mail]:bcoe/thumbd.git#2.7.0', function () {
    var url = '[e-mail]:bcoe/thumbd.git#2.7.0'
    parse(url).should.eql('https://github.com/bcoe/thumbd')
  })

  it('should parse git+https://github.com/bcoe/thumbd.git', function () {
    var url = 'git+https://github.com/bcoe/thumbd.git'
    parse(url).should.eql('https://github.com/bcoe/thumbd')
  })

  it('should parse git+ssh://github.com/bcoe/thumbd.git', function () {
    var url = 'git+ssh://github.com/bcoe/thumbd.git'
    parse(url).should.eql('https://github.com/bcoe/thumbd')
  })

  it('should parse https://[e-mail]/EastCloud/node-websockets.git', function () {
    var url = 'https://[e-mail]/EastCloud/node-websockets.git'
    parse(url).should.eql('https://github.com/EastCloud/node-websockets')
  })

  // gist urls.

  it('should parse git@gist urls', function () {
    var url = '[e-mail]:3135914.git'
    parse(url).should.equal('https://gist.github.com/3135914')
  })

  it('should parse https://gist urls', function () {
    var url = 'https://gist.github.com/3135914.git'
    parse(url).should.equal('https://gist.github.com/3135914')
  })

  // Handle arbitrary GitHub Enterprise domains.

  it('should parse parse extra GHE urls provided', function () {
    var url = 'git://github.example.com/treygriffith/cellar.git'
    parse(
      url, {extraBaseUrls: ['github.example.com']}
    ).should.equal('https://github.example.com/treygriffith/cellar')
  })

  it('should parse GHE urls with multiple subdomains', function () {
    var url = 'git://github.internal.example.com/treygriffith/cellar.git'
    parse(
      url, {extraBaseUrls: ['github.internal.example.com']}
    ).should.equal('https://github.internal.example.com/treygriffith/cellar')
  })
})

describe('re', function () {
  it('should expose GitHub url parsing regex', function () {
    parse.re.source.should.equal(
      /^(?:https?:\/\/|git:\/\/|git\+ssh:\/\/|git\+https:\/\/)?(?:[^@]+@)?(gist.github.com|github.com)(?::\/?|\/)([^/]+\/[^/]+?|[0-9]+)$/.source
    )
  })
})

Changelog

1.5.0 (2016-11-27)

Features

• support paths starting with / in git@ urls (#20) (0e99827)