feat(type): add API method to tell if commit type is public or chore, c…

…lose #12

README.md

@@ -68,6 +68,10 @@ const result = simple.parse(message)
 simple.validate(message, log)
 // message wizard built on top of inquirer
 simple.prompter(inquirer, cb)
+// returns true if the commit message is public ("feat", etc)
+simple.isPublic(
+  simple.parse("feat(foo): add foo feature").type
+) // true
 ```
 
 See [inquirer](https://www.npmjs.com/package/inquirer) for details.

__snapshots__/is-public-spec.js.snap-shot

@@ -0,0 +1,38 @@
+exports['determines if commit is public 1'] = {
+  "name": "isPublicCommitType",
+  "behavior": [
+    {
+      "given": "major",
+      "expect": true
+    },
+    {
+      "given": "break",
+      "expect": true
+    },
+    {
+      "given": "minor",
+      "expect": true
+    },
+    {
+      "given": "feat",
+      "expect": true
+    },
+    {
+      "given": "fix",
+      "expect": true
+    },
+    {
+      "given": "patch",
+      "expect": true
+    },
+    {
+      "given": "chore",
+      "expect": false
+    },
+    {
+      "given": "anything else",
+      "expect": false
+    }
+  ]
+}
+

package.json

@@ -47,8 +47,8 @@
     "ramda": "0.23.0",
     "rocha": "2.3.0",
     "semantic-release": "6.0.3",
-    "snap-shot": "2.7.2",
-    "standard": "8.6.0"
+    "snap-shot": "2.17.0",
+    "standard": "10.0.2"
   },
   "config": {
     "pre-git": {

src/index.js

@@ -17,7 +17,8 @@ const analyze = eval( // eslint-disable-line no-eval
 const props = {
   parse: require('./valid-message').parse,
   validate: require('./valid-message').validate,
-  prompter: require('./message-wizard').prompter
+  prompter: require('./message-wizard').prompter,
+  isPublic: require('./is-public')
 }
 
 const combined = Object.assign(analyze, props)

src/is-public-spec.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const snapshot = require('snap-shot')
+
+/* global describe, it */
+describe('is-public', () => {
+  const isPublic = require('./is-public')
+
+  it('determines if commit is public', () => {
+    snapshot(isPublic,
+      'major', 'break', 'minor', 'feat', 'fix', 'patch', 'chore',
+      'anything else'
+    )
+  })
+})

src/is-public.js

@@ -0,0 +1,20 @@
+const validMessage = require('./valid-message')
+
+// users only care about these commit types
+const publicTypes = {
+  major: true,
+  break: true,
+  minor: true,
+  feat: true,
+  fix: true,
+  patch: true
+}
+
+function isPublicCommitType (s) {
+  if (!validMessage.isValidType(s)) {
+    return false
+  }
+  return Boolean(publicTypes[s])
+}
+
+module.exports = isPublicCommitType

src/message-wizard.js

@@ -8,8 +8,8 @@ const join = require('path').join
 function fillQuestions (questions) {
   // assumes commit from the package folder
   const pkg = require(join(process.cwd(), 'package.json'))
-  const currentTag = pkg.publishConfig &&
-    pkg.publishConfig.tag || 'latest'
+  const configuredTag = pkg.publishConfig && pkg.publishConfig.tag
+  const currentTag = configuredTag || 'latest'
 
   const filledQuestions = updateQuestion(questions, {
     name: 'tag',

src/valid-message.js

@@ -36,6 +36,16 @@ const TYPE_MAP = {
   chore: 'chore'
 }
 
+// given "major" or "break" returns "major" for example
+function normalizeCommitType (s) {
+  return TYPE_MAP[s] || s
+}
+
+function isValidType (s) {
+  const type = normalizeCommitType(s)
+  return TYPES.hasOwnProperty(type)
+}
+
 // removes all lines that start with '#'
 function removeComments (str) {
   return str.split('\n').filter(s => !/^\s*#/.test(s)).join('\n')
@@ -51,7 +61,7 @@ function parseMessage (str) {
     return
   }
 
-  const type = TYPE_MAP[match[2]] || match[2]
+  const type = normalizeCommitType(match[2])
   return {
     firstLine: match[1],
     type: type,
@@ -101,7 +111,7 @@ function validateMessage (message, log) {
     return false
   }
 
-  if (!TYPES.hasOwnProperty(parsed.type)) {
+  if (!isValidType(parsed.type)) {
     failedMessage('"%s" is not allowed type !', parsed.type)
     return false
   }
@@ -121,5 +131,7 @@ function validateMessage (message, log) {
 
 module.exports = {
   validate: validateMessage,
-  parse: parseMessage
+  parse: parseMessage,
+  normalize: normalizeCommitType,
+  isValidType: isValidType
 }