refactor(naming): releaseAs => releaseType

BREAKING CHANGE: `releaseAs` => `releaseType` Fixes #15
conventional-changelog-archived-repos · Aug 13, 2016 · 1476f1e · 1476f1e
1 parent 3ec3d7d
commit 1476f1e
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ var conventionalRecommendedBump = require('conventional-recommended-bump');
 conventionalRecommendedBump({
   preset: 'angular'
 }, function(err, result) {
-  console.log(result.releaseAs);
+  console.log(result.releaseType);
   //=> 'major'
 });
 ```
@@ -91,7 +91,7 @@ Type: `function`
 
 Object includes what's returned by `whatBump` and
 
-####### releaseAs
+####### releaseType
 
 Type: `string` Possible values: `'major'`, `'minor'` and `'patch'`
 

diff --git a/cli.js b/cli.js
@@ -60,8 +60,8 @@ conventionalRecommendedBump(options, flags, function(err, data) {
     process.exit(1);
   }
 
-  if (data.releaseAs) {
-    console.log(data.releaseAs);
+  if (data.releaseType) {
+    console.log(data.releaseType);
   }
 
   if (flags.verbose && data.reason) {

diff --git a/index.js b/index.js
@@ -75,7 +75,7 @@ function conventionalRecommendedBump(options, parserOpts, cb) {
         }
 
         if (result && result.level != null) {
-          result.releaseAs = VERSIONS[result.level];
+          result.releaseType = VERSIONS[result.level];
         } else if (result == null) {
           result = {};
         }

diff --git a/test/angular.js b/test/angular.js
@@ -27,11 +27,11 @@ describe('preset', function() {
     });
 
     it('should release as minor', function(done) {
-      conventionalRecommendedBump(opts, function(err, releaseAs) {
-        equal(releaseAs, {
+      conventionalRecommendedBump(opts, function(err, releaseType) {
+        equal(releaseType, {
           level: 1,
           reason: 'There are 0 BREAKING CHANGES and 1 features',
-          releaseAs: 'minor'
+          releaseType: 'minor'
         });
 
         done();
@@ -41,11 +41,11 @@ describe('preset', function() {
     it('should merge parserOpts', function(done) {
       conventionalRecommendedBump(opts, {
         headerPattern: /^(\w*)\: (.*)$/,
-      }, function(err, releaseAs) {
-        equal(releaseAs, {
+      }, function(err, releaseType) {
+        equal(releaseType, {
           level: 2,
           reason: 'There are 0 BREAKING CHANGES and 0 features',
-          releaseAs: 'patch'
+          releaseType: 'patch'
         });
 
         done();
@@ -56,11 +56,11 @@ describe('preset', function() {
       writeFileSync('test4', '');
       // fix this until https://github.com/arturadib/shelljs/issues/175 is solved
       child.exec('git add --all && git commit -m "feat(): amazing new module" -m "BREAKING CHANGE: Not backward compatible."', function() {
-        conventionalRecommendedBump(opts, function(err, releaseAs) {
-          equal(releaseAs, {
+        conventionalRecommendedBump(opts, function(err, releaseType) {
+          equal(releaseType, {
             level: 0,
             reason: 'There are 1 BREAKING CHANGES and 1 features',
-            releaseAs: 'major'
+            releaseType: 'major'
           });
 
           done();
@@ -72,11 +72,11 @@ describe('preset', function() {
       writeFileSync('test5', '');
       // fix this until https://github.com/arturadib/shelljs/issues/175 is solved
       child.exec('git add --all && git commit -m "feat(): another amazing new module" -m "Super backward compatible."', function() {
-        conventionalRecommendedBump(opts, function(err, releaseAs) {
-          equal(releaseAs, {
+        conventionalRecommendedBump(opts, function(err, releaseType) {
+          equal(releaseType, {
             level: 0,
             reason: 'There are 1 BREAKING CHANGES and 2 features',
-            releaseAs: 'major'
+            releaseType: 'major'
           });
 
           done();
@@ -89,11 +89,11 @@ describe('preset', function() {
       child.exec('git rev-parse HEAD~1', function(err, hash) {
         // fix this until https://github.com/arturadib/shelljs/issues/175 is solved
         child.exec('git add --all && git commit -m "revert: feat(): amazing new module" -m "This reverts commit ' + hash.trim() + '."', function() {
-          conventionalRecommendedBump(opts, function(err, releaseAs) {
-            equal(releaseAs, {
+          conventionalRecommendedBump(opts, function(err, releaseType) {
+            equal(releaseType, {
               level: 1,
               reason: 'There are 0 BREAKING CHANGES and 2 features',
-              releaseAs: 'minor'
+              releaseType: 'minor'
             });
 
             done();
@@ -106,11 +106,11 @@ describe('preset', function() {
       conventionalRecommendedBump({
         preset: 'angular',
         ignoreReverted: false
-      }, function(err, releaseAs) {
-        equal(releaseAs, {
+      }, function(err, releaseType) {
+        equal(releaseType, {
           level: 0,
           reason: 'There are 1 BREAKING CHANGES and 2 features',
-          releaseAs: 'major'
+          releaseType: 'major'
         });
 
         done();

diff --git a/test/test.js b/test/test.js
@@ -28,8 +28,8 @@ describe('conventional-recommended-bump', function() {
   it('should return `{}` if no `whatBump` is found', function(done) {
     shell.exec('git add --all && git commit -m"First commit"');
 
-    conventionalRecommendedBump({}, function(err, releaseAs) {
-      equal(releaseAs, {});
+    conventionalRecommendedBump({}, function(err, releaseType) {
+      equal(releaseType, {});
 
       done();
     });
@@ -44,8 +44,8 @@ describe('conventional-recommended-bump', function() {
           test: 'test'
         };
       }
-    }, function(err, releaseAs) {
-      equal(releaseAs, {
+    }, function(err, releaseType) {
+      equal(releaseType, {
         test: 'test'
       });
 
@@ -58,10 +58,10 @@ describe('conventional-recommended-bump', function() {
       whatBump: function() {
         return 0;
       }
-    }, function(err, releaseAs) {
-      equal(releaseAs, {
+    }, function(err, releaseType) {
+      equal(releaseType, {
         level: 0,
-        releaseAs: 'major'
+        releaseType: 'major'
       });
 
       done();