Merge pull request #1 from teambit/feature/url-parser

Feature/url parser

README.md

@@ -77,7 +77,7 @@ Usage
 ```javascript
 'use strict'
 
-const gitconfig = require('gitconfig')
+const gitconfig = require('@teambit/gitconfig')
 
 // Set git config values.
 gitconfig.set({
@@ -101,9 +101,20 @@ gitconfig.get({
 }).then((config) => {
   /* ... */
 })
+
+/**
+ * @name getUrl
+ * @description Get git remote name url or all remotes urls.
+ * @param remoteName - string - remotname to fetch url
+ * @return returns the remote names url if specified or all remote names urls if nothing is passed
+ */
+gitconfig.getUrl().then((config) => {
+  /* ... */
+})
 ```
 
 
+
 <!-- Section from "doc/guides/02.Usage.md.hbs" End -->
 
 <!-- Section from "doc/guides/03.API.md.hbs" Start -->

lib/fetchRepo.js

@@ -0,0 +1,45 @@
+const get = require('./get');
+const lget = require('lodash.get');
+
+ /**
+ * Get remote url.
+ * @param remoteName - remote name to fetch git url
+ * @function getRepoRemoteUrl
+ * @returns {String}
+ */
+function getRepoRemoteUrl (getGitInfo, remoteName) {
+    return lget(getGitInfo, `remote.${remoteName}.url`);
+}
+
+ /**
+ * Get all remote urls from current project
+ * @function getAllRemotesUrls
+ * @returns {Array<String>}
+ */
+function getAllRemotesUrls (getGitInfo) {
+    const remotes = lget(getGitInfo, 'remote', {});
+    return Object.keys(remotes).map(key => lget(remotes[key],'url'));
+}
+
+
+ /**
+ * Get gitInfo
+ * @function getGitInfo
+ * @returns {Object}
+ */
+function getGitInfo () {
+    return get.sync();
+}
+
+ /**
+ * Get all remote url or all remote urls from current project
+ * @param remoteName - string
+ * @function getAllRemotesUrls
+ * @returns {Array<string> | string}
+ */
+function getUrl(remoteName){
+    const gitInfo = getGitInfo();
+    return remoteName ? getRepoRemoteUrl(gitInfo, remoteName) : getAllRemotesUrls(gitInfo);
+}
+
+module.exports = getUrl

lib/index.js

@@ -10,5 +10,6 @@ let d = (module) => module.default || module
 module.exports = {
   get get () { return d(require('./get')) },
   get set () { return d(require('./set')) },
-  get unset () { return d(require('./unset')) }
+  get unset () { return d(require('./unset')) },
+  get getUrl () { return d(require('./fetchRepo')) }
 }

package.json

@@ -27,6 +27,7 @@
     "askconfig": "^3.0.5",
     "co": "^4.6.0",
     "execcli": "^4.0.8",
+    "lodash.get": "^4.4.2",
     "objnest": "^3.0.6"
   },
   "devDependencies": {
@@ -43,4 +44,4 @@
     "node": ">=6",
     "npm": ">=3"
   }
-}
+}