Merge pull request #20 from zanerock/work-liquid-labs/github-toolkit/19

Add getGitHubOrgAndProject helper

src/get-github-org-and-project.mjs

@@ -0,0 +1,17 @@
+const urlRegEx = /github.com\/([^/]+)\/([^.]+)/
+
+const getGitHubOrgAndProject = ({ packageJSON, require }) => {
+  const { repository } = packageJSON
+
+  const url = typeof repository === 'string' ? repository : repository.url
+
+  const [, org, project] = url.match(urlRegEx) || []
+
+  if (org === undefined && require === true) {
+    throw new Error(`Could not extract GitHub org and project from url '${url}'; this may not be a GitHub project.`)
+  }
+
+  return { org, project }
+}
+
+export { getGitHubOrgAndProject }

src/index.js

@@ -1,6 +1,7 @@
 export * from './access-lib'
 export * from './branch-lib'
 export * from './determine-current-release'
+export * from './get-github-org-and-project'
 export * from './issues-lib'
 export * from './labels-lib'
 export * from './milestones-lib'

src/test/get-github-org-and-project.test.js

@@ -0,0 +1,26 @@
+/* global describe expect test */
+
+import { getGitHubOrgAndProject } from '../get-github-org-and-project'
+
+// requires user to have API access
+describe('getGitHubOrgAndProject', () => {
+  test('works with string repositories', () => {
+    const packageJSON = { repository : 'git+ssh://[email protected]/acme/foo-bar.git' }
+    expect(getGitHubOrgAndProject({ packageJSON })).toEqual({ org : 'acme', project : 'foo-bar' })
+  })
+
+  test('works with object repositories', () => {
+    const packageJSON = { repository : { url : 'git+ssh://[email protected]/acme/foo-bar.git' } }
+    expect(getGitHubOrgAndProject({ packageJSON })).toEqual({ org : 'acme', project : 'foo-bar' })
+  })
+
+  test('returns undefined values when no match', () => {
+    const packageJSON = { repository : 'git+ssh://[email protected]/acme/foo-bar.git' }
+    expect(getGitHubOrgAndProject({ packageJSON })).toEqual({ org : undefined, project : undefined })
+  })
+
+  test('throws error when no match and required', () => {
+    const packageJSON = { repository : 'git+ssh://[email protected]/acme/foo-bar.git' }
+    expect(() => getGitHubOrgAndProject({ packageJSON, require : true })).toThrow()
+  })
+})