configorama 0.4.4 → 0.4.6

package/lib/main.js

@@ -13,7 +13,7 @@ const getValueFromString = require('./resolvers/valueFromString')
 const getValueFromNumber = require('./resolvers/valueFromNumber')
 const getValueFromEnv = require('./resolvers/valueFromEnv')
 const getValueFromOptions = require('./resolvers/valueFromOptions')
-const getValueFromGit = require('./resolvers/valueFromGit')
+const createGitResolver = require('./resolvers/valueFromGit')
 /* Default File Parsers */
 const YAML = require('./parsers/yaml')
 const TOML = require('./parsers/toml')
@@ -88,7 +88,7 @@ class Configorama {
     } else if (typeof fileOrObject === 'string') {
       // read and parse file
       const fileContents = fs.readFileSync(fileOrObject, 'utf-8')
-      const fileDirectory = path.dirname(fileOrObject)
+      const fileDirectory = path.dirname(path.resolve(fileOrObject))
       const fileType = path.extname(fileOrObject)
 
       let configObject
@@ -194,7 +194,7 @@ class Configorama {
       },
 
       // Git refs
-      getValueFromGit,
+      createGitResolver(this.configPath),
       /* Internal Resolvers */
       // {
       //   match: funcRegex,

package/lib/resolvers/valueFromGit.js

@@ -18,77 +18,145 @@ async function _exec(cmd, options = { timeout: 1000 }) {
   })
 }
 
-async function _getValueFromGit(variableString) {
-  const variable = variableString.split(`${GIT_PREFIX}:`)[1]
-  let value = null
-  // console.log('variableStringvariableString', variableString)
-  if (variable.match(/^remote/)) {
-    const hasParams = functionRegex.exec(variableString)
-    const remoteName = (hasParams && hasParams[2]) ? formatFunctionArgs(hasParams[2]) : 'origin'
-    value = await getGitRemote(remoteName)
-    return value
-  }
+function createResolver(cwd) {
+  async function _getValueFromGit(variableString) {
+    const variable = variableString.split(`${GIT_PREFIX}:`)[1]
+    let value = null
+    // console.log('variableStringvariableString', variableString)
+    if (variable.match(/^remote/i)) {
+      const hasParams = functionRegex.exec(variableString)
+      const remoteName = (hasParams && hasParams[2]) ? formatFunctionArgs(hasParams[2]) : 'origin'
+      value = await getGitRemote(remoteName)
+      return value
+    }
 
-  const verifyMsg = `Verify the cwd has a .git directory\n`
+    const verifyMsg = `Verify the cwd has a .git directory\n`
+    const normalizedVar = (variable || '').toLowerCase()
 
-  switch (variable) {
-    case 'describe':
-      try {
-        value = await _exec('git describe --always')
-      } catch (err) {
-        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
-      }
-      break
-    case 'describeLight':
-      try {
-        value = await _exec('git describe --always --tags')
-      } catch (err) {
-        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
-      }
-      break
-    case 'sha1':
-      try {
-        value = await _exec('git rev-parse --short HEAD')
-      } catch (err) {
-        throw new Error(`\${git:sha1} error ${verifyMsg}`)
-      }
-      break
-    case 'commit':
-      try {
-        value = await _exec('git rev-parse HEAD')
-      } catch (err) {
-        throw new Error(`\${git:commit} error. ${verifyMsg}`)
-      }
-      break
-    case 'branch':
-      try {
-        value = await _exec('git rev-parse --abbrev-ref HEAD')
-      } catch (err) {
-        throw new Error(`\${git:branch} error. ${verifyMsg}`)
-      }
-      break
-    case 'message':
-      try {
-        value = await _exec('git log -1 --pretty=%B')
-      } catch (err) {
-        throw new Error(`\${git:message} error. ${verifyMsg}`)
-      }
-      break
-    case 'isDirty':
-      const writeTree = await _exec('git write-tree')
-      const changes = await _exec(`git diff-index ${writeTree} --`)
-      value = `${changes.length > 0}`
-      break
-    case 'repository':
-      value = await _exec('basename `git rev-parse --show-toplevel`')
-      break
-    case 'url': case 'repoUrl':
-      value = await getGitRemote()
-      break
-    default:
-      throw new Error(`Git variable ${variable} is unknown. Candidates are 'describe', 'describeLight', 'sha1', 'commit', 'branch', 'message', 'repository'`)
+    switch (normalizedVar) {
+      // Repo owner/name
+      case 'repo':
+      case 'repository':
+      case 'reposlug':
+      case 'repo-slug':
+        const urla = await getGitRemote()
+        const parseda = GitUrlParse(urla)
+        value = parseda.full_name
+        break;
+      // Repo name
+      case 'name':
+      case 'reponame': // repoName
+      case 'repo-name':
+        value = await _exec('basename `git rev-parse --show-toplevel`')
+        break;
+      // Repo org or owner
+      case 'org':
+      case 'owner':
+      case 'organization':
+      case 'repoowner': // repoOwner
+      case 'repo-owner':
+        const url = await getGitRemote()
+        const parsed = GitUrlParse(url)
+        value = parsed.organization || parsed.owner
+        break;
+      // Repo name
+      case 'dir':
+      case 'dirpath': // dirPath
+      case 'dir-path':
+      case 'dir_path':
+        const gitBasePath = await _exec('git rev-parse --show-toplevel')
+        if (cwd) {
+          const subPath = cwd.replace(gitBasePath, '')
+          const branch = await _exec('git rev-parse --abbrev-ref HEAD')
+          const url = await getGitRemote()
+          value = (subPath) ? `${url}/tree/${branch}${subPath}` : url
+        }
+        break;
+      // Repo url
+      case 'url':
+      case 'repourl': // repoUrl
+      case 'repo-url':
+        value = await getGitRemote()
+        break;
+      // Current commit sha
+      case 'sha':
+      case 'sha1':
+        try {
+          value = await _exec('git rev-parse --short HEAD')
+        } catch (err) {
+          throw new Error(`\${git:sha1} error ${verifyMsg}`)
+        }
+        break
+      // Current commit full sha
+      case 'commit':
+      case 'commitsha':
+      case 'commit-sha':
+      case 'commithash':
+      case 'commit-hash':
+        try {
+          value = await _exec('git rev-parse HEAD')
+        } catch (err) {
+          throw new Error(`\${git:commit} error. ${verifyMsg}`)
+        }
+        break
+      // Branches
+      case 'branch':
+      case 'branchname':
+      case 'branch-name':
+      case 'currentbranch': // currentBranch
+      case 'current-branch':
+        try {
+          value = await _exec('git rev-parse --abbrev-ref HEAD')
+        } catch (err) {
+          throw new Error(`\${git:branch} error. ${verifyMsg}`)
+        }
+        break
+      // Commit msg
+      case 'msg':
+      case 'message':
+      case 'commitmessage': // commitMessage
+      case 'commit-message':
+      case 'commitmsg': // commitMsg
+      case 'commit-msg':
+        try {
+          value = await _exec('git log -1 --pretty=%B')
+        } catch (err) {
+          throw new Error(`\${git:message} error. ${verifyMsg}`)
+        }
+        break;
+      // Git tags
+      case 'tag':
+      case 'describe':
+        try {
+          value = await _exec('git describe --always')
+        } catch (err) {
+          throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
+        }
+        break;
+      // Git tags
+      case 'describeLight':
+      case 'describelight':
+      case 'describe-light':
+        try {
+          value = await _exec('git describe --always --tags')
+        } catch (err) {
+          throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
+        }
+        break;
+      // Is branch dirty
+      case 'isDirty':
+      case 'isdirty':
+      case 'is-dirty':
+        const writeTree = await _exec('git write-tree')
+        const changes = await _exec(`git diff-index ${writeTree} --`)
+        value = `${changes.length > 0}`
+        break
+      default:
+        throw new Error(`Git variable ${variable} is unknown. Candidates are 'describe', 'describeLight', 'sha1', 'commit', 'branch', 'message', 'repository'`)
+    }
+    return value
   }
-  return value
+  return _getValueFromGit
 }
 
 async function getGitRemote(name = 'origin') {
@@ -130,7 +198,9 @@ async function getGitRemote(name = 'origin') {
   }
 }
 
-module.exports = {
-  match: gitVariableSyntax,
-  resolver: _getValueFromGit
+module.exports = function createGitResolver(cwd) {
+  return {
+    match: gitVariableSyntax,
+    resolver: createResolver(cwd)
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configorama",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "Variable support for configuration files",
   "main": "lib/index.js",
   "files": [