Wondering what’s next for npm?Check out our public roadmap! »

    is-github-url

    1.2.2 • Public • Published

    is-github-url Build Status

    Check if a passed string is a valid GitHub URL

    Unlike is-git-url, is-github-url is a domain-specific validator. It returns true if passed URL is a part of github.com domain only.

    Installation

    $ npm install is-github-url --save
    

    Usage

    var isGithubUrl = require('is-github-url');
     
    // Valid examples
    isGithubUrl('https://github.com/facebook');
     // => true
    isGithubUrl('https://github.com/facebook/react');
     // => true
    isGithubUrl('https://github.com/facebook/react/releases/tag/v0.14.0');
    // => true
    isGithubUrl('git@github.com:facebook/react.git');
    // => true
    isGithubUrl('git://github.com/facebook/react.git#gh-pages');
    // => true
     
    // Invalid examples
    isGithubUrl('https://google.com');
     // => false
    isGithubUrl('unknown://github.com');
    // => false
    isGithubUrl('http://facebook.github.io/');
    // => false
     
    // Repository mode can be used to check whether a passed URL
    // is a valid repository URL
    isGithubUrl('https://github.com/facebook/react', { repository: true });
    // => true
    isGithubUrl('https://github.com/facebook', { repository: true });
    // => false
    isGithubUrl('https://github.com/facebook/react/releases/tag/v0.14.0', {
      repository: true
    });
    // => false
     
    // Strict mode is used to validate URLs before cloning
    // Strict mode turns on automatically if URL contains git protocol
    isGithubUrl('https://github.com/facebook/react.git', { strict: true });
    // => true
    isGithubUrl('https://github.com/facebook/react', { strict: true });
    // => false

    API

    isGithubUrl(url, [options])

    Check if a passed string is a valid GitHub URL

    Params

    • String url: A string to be validated
    • Object options: An object containing the following fields:
      • strict (Boolean): Match only URLs ending with .git
      • repository (Boolean): Match only valid GitHub repo URLs

    License

    MIT © Philipp Alferov

    Install

    npm i is-github-url

    DownloadsWeekly Downloads

    319

    Version

    1.2.2

    License

    MIT

    Last publish

    Collaborators

    • avatar