TypeScript icon, indicating that this package has built-in type declarations

    2.3.8 • Public • Published

    gitclone-defaults npm version License Libera Manifesto

    Powerful and flexible signature for gitclone - defaults, checks, validating, etc

    Please consider following this project's author, Charlike Mike Reagent, and ⭐️ the project to show your ❤️ and support.

    Code style CircleCI linux build CodeCov coverage status Renovate App Status Make A Pull Request Time Since Last Commit

    If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents. For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

    Conventional Commits Minimum Required Nodejs NPM Downloads Monthly NPM Downloads Total Share Love Tweet Twitter

    Project is semantically versioned & automatically released from GitHub Actions with Lerna.

    Become a Patron Buy me a Kofi PayPal Donation Bitcoin Coinbase Keybase PGP

    Topic Contact
    Any legal or licensing questions, like private or commerical use tunnckocore_legal
    For any critical problems and security reports tunnckocore_security
    Consulting, professional support, personal or team training tunnckocore_consulting
    For any questions about Open Source, partnerships and sponsoring tunnckocore_opensource

    Table of Contents

    (TOC generated by verb using markdown-toc)


    This project requires Node.js >=10.13 (see Support & Release Policy). Install it using yarn or npm.
    We highly recommend to use Yarn when you think to contribute to this project.

    $ yarn add gitclone-defaults


    Generated using jest-runner-docs.


    Creates consistent parsed object from string pattern or from listed arguments. If owner is object, it can accepts user and repo properties. Treats that owner argument as owner if name is string (which is the repo) from the user/repo pattern.


    function(owner, name, branch, ssh)


    • owner {string|object} - the user/repo pattern or anything that parse-github-url can parse
    • name {string|boolean|object} - if boolean treats it as ssh
    • branch {string|boolean|object} - if boolean treats it as ssh
    • ssh {boolean|object} - useful in higher-level libs, and if it is object it can contains ssh
    • returns {object} - result object contains anything that parse-github-url contains and in addition has ssh and dest properties


    import gitcloneDefaults from 'gitclone-defaults';
        user: 'foo',
        repo: 'bar',
        branch: 'zeta',
      user: 'foo',
      repo: 'bar',
      branch: 'dev2',
        owner: 'foo',
        name: 'bar',
      { dest: 'beta', ssh: true },
        owner: 'foo',
        name: 'bar',
      { dest: 'beta' },
    gitcloneDefaults('foo', 'bar');
    gitcloneDefaults('foo', 'bar', 'dev3');
    gitcloneDefaults('foo', 'bar', 'dev3', { dest: 'dest3' });
    gitcloneDefaults('foo/bar', { ssh: true });
    gitcloneDefaults('foo/bar', { branch: 'opts' });
    gitcloneDefaults('foo/bar', { branch: 'opts' }, { ssh: true });
    gitcloneDefaults('foo/bar', { branch: 'opts' }, true);
    gitcloneDefaults('foo', 'bar', 'baz', true);
    gitcloneDefaults('foo/bar', { branch: 'qux' }, true);
    gitcloneDefaults('foo/bar#dev', { ssh: true });
    gitcloneDefaults('foo/bar#qux', true);
    gitcloneDefaults('foo/bar#qux', true, { dest: 'ok' });

    back to top


    Guides and Community

    Please read the Contributing Guide and Code of Conduct documents for advices.

    For bug reports and feature requests, please join our community forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.

    Consider reading the Support and Release Policy guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.

    Support the project

    Become a Partner or Sponsor? 💵 Check the OpenSource Commision (tier). 🎉 You can get your company logo, link & name on this file. It's also rendered on package's page in and sites too! 🚀

    Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. ✨


    This project follows the all-contributors specification. Contributions of any kind are welcome!

    Thanks goes to these wonderful people (emoji key), consider showing your support to them:

    Charlike Mike Reagent

    🚇 💻 📖 🤔 🚧 ⚠️

    back to top


    Copyright (c) 2016-present, Charlike Mike Reagent <> & contributors.
    Released under the MPL-2.0 License.


    npm i gitclone-defaults

    DownloadsWeekly Downloads






    Unpacked Size

    32.9 kB

    Total Files


    Last publish


    • tunnckocore
    • vanchoy