standard-version - npm Package Compare versions

Comparing version 1.1.0 to 2.1.1

CHANGELOG.md

@@ -5,4 +5,36 @@ # Change Log
 
+<a name="2.1.1"></a>
+## [2.1.1](https://github.com/conventional-changelog/standard-version/compare/v2.1.0...v2.1.1) (2016-04-10)
+
+
+### Bug Fixes
+
+* **docs:** had a bad URL in package.json, which was breaking all of our links ([caa6359](https://github.com/conventional-changelog/standard-version/commit/caa6359))
+
+
+
+<a name="2.1.0"></a>
+# [2.1.0](https://github.com/conventional-changelog/standard-version/compare/v2.0.0...v2.1.0) (2016-04-10)
+
+
+### Features
+
+* adds support for GitHub links (see [#13](https://github.com/conventional-changelog/standard-version/issues/13)), great idea [@bcoe](https://github.com/bcoe)! ([7bf6597](https://github.com/conventional-changelog/standard-version/commit/7bf6597))
+
+
+
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/conventional-changelog/standard-version/compare/v1.1.0...v2.0.0) (2016-04-09)
+
+
+* feat(conventional-changelog-standard): Move to conventional-changelog-standard style. This style lifts the character limit on commit messages, and puts us in a position to make more opinionated decisions in the future. ([c7ccadb](https://github.com/conventional-changelog/standard-version/commit/c7ccadb))
+
+
+### BREAKING CHANGES
+
+* we no longer accept the preset configuration option.
+
+
 <a name="1.1.0"></a>
-# [1.1.0](https://github.com/conventional-changelog/standard-verison/compare/v1.0.0...v1.1.0) (2016-04-08)
+# [1.1.0](https://github.com/conventional-changelog/standard-version/compare/v1.0.0...v1.1.0) (2016-04-08)
 
@@ -12,5 +44,5 @@
 
-* **cli:** use conventional default commit message with version ([9fadc5f](https://github.com/conventional-changelog/standard-verison/commit/9fadc5f))
-* **rebrand:** rebrand recommended-workflow to standard-version (#9) ([1f673c0](https://github.com/conventional-changelog/standard-verison/commit/1f673c0))
-* **tests:** adds test suite, fixed several Node 0.10 issues along the way ([03bd86c](https://github.com/conventional-changelog/standard-verison/commit/03bd86c))
+* **cli:** use conventional default commit message with version ([9fadc5f](https://github.com/conventional-changelog/standard-version/commit/9fadc5f))
+* **rebrand:** rebrand recommended-workflow to standard-version (#9) ([1f673c0](https://github.com/conventional-changelog/standard-version/commit/1f673c0))
+* **tests:** adds test suite, fixed several Node 0.10 issues along the way ([03bd86c](https://github.com/conventional-changelog/standard-version/commit/03bd86c))
 
@@ -26,4 +58,1 @@
 * **initial-release:** adds flag for generating CHANGELOG.md on the first release. ([b812b44](https://github.com/bcoe/conventional-recommended-workflow/commit/b812b44))
-
-
-

index.js

 #!/usr/bin/env node
+var conventionalRecommendedBump = require('conventional-recommended-bump')
 var conventionalChangelog = require('conventional-changelog')
-var conventionalRecommendedBump = require('conventional-recommended-bump')
 var path = require('path')
@@ -13,8 +13,2 @@ var argv = require('yargs')
   })
-  .option('preset', {
-    alias: 'p',
-    describe: 'Name of the preset you want to use. Must be one of the following:\nangular, atom, codemirror, ember, eslint, express, jquery, jscs, or jshint',
-    default: 'angular',
-    global: true
-  })
   .option('message', {
@@ -52,3 +46,3 @@ alias: 'm',
 conventionalRecommendedBump({
-  preset: argv.preset
+  preset: 'angular'
 }, function (err, release) {
@@ -87,3 +81,3 @@ if (err) {
   var changelogStream = conventionalChangelog({
-    preset: argv.preset,
+    preset: 'standard',
     outputUnreleased: true,
@@ -90,0 +84,0 @@ pkg: {

package.json

 {
   "name": "standard-version",
-  "version": "1.1.0",
+  "version": "2.1.1",
   "description": "replacement for `npm version` with automatic CHANGELOG generation",
@@ -13,3 +13,3 @@ "bin": "index.js",
     "type": "git",
-    "url": "git+https://github.com/conventional-changelog/standard-verison.git"
+    "url": "git+https://github.com/conventional-changelog/standard-version.git"
   },
@@ -34,2 +34,3 @@ "keywords": [
     "conventional-changelog": "^1.1.0",
+    "conventional-changelog-standard": "^1.2.1",
     "conventional-recommended-bump": "^0.2.0",
@@ -36,0 +37,0 @@ "figures": "^1.5.0",

README.md

@@ -8,11 +8,11 @@ # Standard Version
 
-> stop using `npm version`, use `standard-version` it does so much more:
+> stop using `npm version`, use `standard-version` it rocks!
 
 Automatic release and CHANGELOG management, using GitHub's new squash button and
-the workflow outlined in [conventional-changelog-cli](https://github.com/stevemao/conventional-changelog-cli).
+the workflow outlined in [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
 
-**how it works:**
+_how it works:_
 
 1. when you land commits on your `master` branch, select the _Squash and Merge_ option.
-2. add a title and body that follows the [conventional-changelog conventions](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md).
+2. add a title and body that follows the [conventional-changelog-standard conventions](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).
 3. when you're ready to release to npm:
@@ -26,3 +26,3 @@ 1. checkout `master`.
 1. bumps the version in package.json (based on your commit history).
-2. runs `conventional-changelog` and updates CHANGELOG.md.
+2. uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to update _CHANGELOG.md._
 3. commits _package.json_ and _CHANGELOG.md_.
@@ -39,11 +39,9 @@ 4. tags a new release.
 
-`npm i standard-version`
+`npm i standard-version -g`
 
-## Automating
+_Or, add it as a development dependency like so:_
 
-Do this:
-
 `npm i standard-version --save-dev`
 
-Add this to your _package.json_
+_And add this to your _package.json:_
 
@@ -58,2 +56,36 @@ ```json
 
+## Commit Message Convention, at a Glance
+
+_patches:_
+
+```sh
+-m "fix(parsing): fixed a bug in our parser"
+```
+
+_features:_
+
+```sh
+git commit -a -m "feat(parser): we now have a parser \o/"
+```
+
+_breaking changes:_
+
+```sh
+git commit -a -m "feat(new-parser): introduces a new parsing library
+BREAKING CHANGE: new library does not support foo-construct"
+```
+
+_other changes:_
+
+You decide, e.g., docs, chore, etc.
+
+```sh
+git commit -a -m "docs: fixed up the docs a bit"
+```
+
+_but wait, there's more!_
+
+Github usernames (`@bcoe`) and issue references (#133) will be swapped out for the
+appropriate URLs in your CHANGELOG.
+
 ## Badges!
@@ -60,0 +92,0 @@

test.js

@@ -81,2 +81,17 @@ /* global describe it beforeEach afterEach */
   })
+
+  it('handles commit messages longer than 80 characters', function () {
+    fs.writeFileSync('package.json', JSON.stringify({
+      version: '1.0.0'
+    }), 'utf-8')
+
+    commit('feat: first commit')
+    shell.exec('git tag -a v1.0.0 -m "my awesome first release"')
+    commit('fix: this is my fairly long commit message which is testing whether or not we allow for long commit messages')
+
+    shell.exec(cliPath).code.should.equal(0)
+
+    var content = fs.readFileSync('CHANGELOG.md', 'utf-8')
+    content.should.match(/this is my fairly long commit message which is testing whether or not we allow for long commit messages/)
+  })
 })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15079

increased by18.96%

Lines of code

218

increased by2.35%

Number of lines in readme file

98

increased by48.48%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Addedconventional-changelog-standard@^1.2.1

• + Addedconventional-changelog-standard@1.2.1(transitive)

• + Addedgithub-url-from-git@1.5.0(transitive)