conventional-changelog-cli - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "conventional-changelog-cli",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Generate a changelog from git metadata",
@@ -12,30 +12,39 @@ "homepage": "https://github.com/stevemao/conventional-changelog-cli",
   },
+  "bin": {
+    "conventional-changelog": "cli.js"
+  },
   "files": [
-    "lib"
+    "cli.js"
   ],
   "keywords": [
     "cli",
-    "app",
-    "cli",
+    "cli-app",
+    "conventional-changelog",
     "conventional",
     "changelog",
-    "conventional",
-    "changelog",
     "log"
   ],
   "devDependencies": {
-    "gulp": "^3.6.0",
-    "gulp-eslint": "^0.8.0",
-    "gulp-istanbul": "^0.8.1",
-    "gulp-jscs": "^1.1.0",
-    "gulp-jshint": "^1.5.3",
-    "gulp-mocha": "^2.0.0",
-    "gulp-plumber": "^1.0.0",
-    "jshint-stylish": "^1.0.0",
-    "gulp-coveralls": "^0.1.0"
+    "chai": "^3.4.1",
+    "concat-stream": "^1.5.1",
+    "coveralls": "^2.11.6",
+    "jscs": "^2.7.0",
+    "jshint": "^2.8.0",
+    "mocha": "*",
+    "nyc": "^5.0.1",
+    "shelljs": "^0.5.3"
   },
+  "dependencies": {
+    "add-stream": "^1.0.0",
+    "conventional-changelog": "^0.5.3",
+    "lodash": "^4.1.0",
+    "meow": "^3.7.0",
+    "tempfile": "^1.1.1"
+  },
   "scripts": {
-    "test": "gulp"
+    "test": "nyc mocha --timeout 30000 && npm run-script lint",
+    "lint": "jshint *.js --exclude node_modules && jscs *.js",
+    "coveralls": "nyc report --reporter=text-lcov | coveralls"
   },
   "license": "MIT"
 }

README.md

@@ -5,17 +5,67 @@ # conventional-changelog-cli [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
 
-## Install
+## Quick start
 
 ```sh
-$ npm install --save conventional-changelog-cli
+$ npm install -g conventional-changelog-cli
+$ cd my-project
+$ conventional-changelog -p angular -i CHANGELOG.md -w
 ```
 
+This will *not* overwrite any previous changelog. The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
 
-## Usage
+If you first time use this tool and want to generate all previous changelog, you could do
 
-```js
-var conventionalChangelogCli = require('conventional-changelog-cli');
-
-conventionalChangelogCli('Rainbow');
+```sh
+$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0
 ```
 
+This *will* overwrite any previous changelog if exist.
+
+All available command line parameters can be listed using [CLI](#cli) : `conventional-changelog --help`.
+
+**Hint:** You can alias your command or add it to your package.json. EG: `"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"`.
+
+
+## Recommended workflow
+
+1. Make changes
+2. Commit those changes
+3. Make sure Travis turns green
+4. Bump version in `package.json`
+5. `conventionalChangelog`
+6. Commit `package.json` and `CHANGELOG.md` files
+7. Tag
+8. Push
+
+
+The reason why you should commit and tag after `conventionalChangelog` is that the CHANGELOG should be included in the new release, hence `gitRawCommitsOpts.from` defaults to the latest semver tag.
+
+Please use this [gist](https://gist.github.com/stevemao/280ef22ee861323993a0) to make a release or change it to your needs.
+
+
+## Example output
+
+- https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md
+- https://github.com/karma-runner/karma/blob/master/CHANGELOG.md
+- https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md
+
+
+## Why
+
+- Used by AngularJS and related projects.
+- Ignoring reverted commits, templating with [handlebars.js](https://github.com/wycats/handlebars.js) and links to references, etc. Open an [issue](../../issues/new) if you want more reasonable features.
+- Intelligently setup defaults but yet fully configurable with presets of popular projects.
+- Everything internally or externally is pluggable.
+- A lot of tests and actively maintained.
+
+
+## Related
+
+- [conventional-github-releaser](https://github.com/stevemao/conventional-github-releaser) - Make a new GitHub release from git metadata
+- [conventional-recommended-bump](https://github.com/stevemao/conventional-recommended-bump) - Get a recommended version bump based on conventional commits
+- [conventional-commits-detector](https://github.com/stevemao/conventional-commits-detector) - Detect what commit message convention your repository is using
+- [commitizen](https://github.com/commitizen/cz-cli) - Simple commit conventions for internet citizens.
+- [angular-precommit](https://github.com/ajoslin/angular-precommit) - Pre commit with angular conventions
+
+
 ## License
@@ -28,7 +78,7 @@
 [npm-url]: https://npmjs.org/package/conventional-changelog-cli
-[travis-image]: https://travis-ci.org//conventional-changelog-cli.svg?branch=master
-[travis-url]: https://travis-ci.org//conventional-changelog-cli
-[daviddm-image]: https://david-dm.org//conventional-changelog-cli.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org//conventional-changelog-cli
-[coveralls-image]: https://coveralls.io/repos//conventional-changelog-cli/badge.svg
-[coveralls-url]: https://coveralls.io/r//conventional-changelog-cli
+[travis-image]: https://travis-ci.org/stevemao/conventional-changelog-cli.svg?branch=master
+[travis-url]: https://travis-ci.org/stevemao/conventional-changelog-cli
+[daviddm-image]: https://david-dm.org/stevemao/conventional-changelog-cli.svg?theme=shields.io
+[daviddm-url]: https://david-dm.org/stevemao/conventional-changelog-cli
+[coveralls-image]: https://coveralls.io/repos/stevemao/conventional-changelog-cli/badge.svg
+[coveralls-url]: https://coveralls.io/r/stevemao/conventional-changelog-cli

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10543

increased by236.73%

Dev dependency count

8

decreased by-11.11%

Number of package files

5

increased by25%

Lines of code

152

increased by7500%

Number of lines in readme file

83

increased by151.52%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

5

increased byInfinity%

Number of low supply chain risk alerts

6

increased by500%

Dependency changes

• + Addedadd-stream@^1.0.0

• + Addedconventional-changelog@^0.5.3

• + Addedlodash@^4.1.0

• + Addedmeow@^3.7.0

• + Addedtempfile@^1.1.1

• + AddedJSONStream@1.3.5(transitive)

• + Addedadd-stream@1.0.0(transitive)

• + Addedarray-find-index@1.0.2(transitive)

• + Addedarray-ify@1.0.0(transitive)

• + Addedarrify@1.0.1(transitive)

• + Addedcamelcase@2.1.14.1.0(transitive)

• + Addedcamelcase-keys@2.1.04.2.0(transitive)

• + Addedcompare-func@1.3.4(transitive)

• + Addedconventional-changelog@0.5.3(transitive)

• + Addedconventional-changelog-writer@0.4.2(transitive)

• + Addedconventional-commits-filter@0.1.1(transitive)

• + Addedconventional-commits-parser@0.1.2(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addedcurrently-unhandled@0.4.1(transitive)

• + Addeddargs@4.1.0(transitive)

• + Addeddateformat@1.0.12(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addeddecamelize-keys@1.1.1(transitive)

• + Addeddot-prop@3.0.0(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedfind-up@1.1.22.1.0(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-pkg-repo@0.1.0(transitive)

• + Addedget-stdin@4.0.1(transitive)

• + Addedgit-raw-commits@0.1.2(transitive)

• + Addedgit-semver-tags@1.3.6(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhandlebars@4.7.8(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhosted-git-info@2.8.9(transitive)

• + Addedindent-string@2.1.03.2.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-core-module@2.15.0(transitive)

• + Addedis-finite@1.1.0(transitive)

• + Addedis-obj@1.0.1(transitive)

• + Addedis-plain-obj@1.1.0(transitive)

• + Addedis-subset@0.1.1(transitive)

• + Addedis-text-path@1.0.1(transitive)

• + Addedis-utf8@0.2.1(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedjson-parse-better-errors@1.0.2(transitive)

• + Addedjsonparse@1.3.1(transitive)

• + Addedload-json-file@1.1.04.0.0(transitive)

• + Addedlocate-path@2.0.0(transitive)

• + Addedlodash@3.10.14.17.21(transitive)

• + Addedlodash._basecopy@3.0.1(transitive)

• + Addedlodash._basetostring@3.0.1(transitive)

• + Addedlodash._basevalues@3.0.0(transitive)

• + Addedlodash._getnative@3.9.1(transitive)

• + Addedlodash._isiterateecall@3.0.9(transitive)

• + Addedlodash._reinterpolate@3.0.0(transitive)

• + Addedlodash._root@3.0.1(transitive)

• + Addedlodash.escape@3.2.0(transitive)

• + Addedlodash.isarguments@3.1.0(transitive)

• + Addedlodash.isarray@3.0.4(transitive)

• + Addedlodash.keys@3.1.2(transitive)

• + Addedlodash.restparam@3.6.1(transitive)

• + Addedlodash.template@3.6.2(transitive)

• + Addedlodash.templatesettings@3.1.1(transitive)

• + Addedloud-rejection@1.6.0(transitive)

• + Addedmap-obj@1.0.12.0.0(transitive)

• + Addedmeow@3.7.04.0.1(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedminimist-options@3.0.2(transitive)

• + Addedmodify-values@1.0.1(transitive)

• + Addedneo-async@2.6.2(transitive)

• + Addednormalize-package-data@2.5.0(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedobject-assign@4.1.1(transitive)

• + Addedos-tmpdir@1.0.2(transitive)

• + Addedp-limit@1.3.0(transitive)

• + Addedp-locate@2.0.0(transitive)

• + Addedp-try@1.0.0(transitive)

• + Addedparse-json@2.2.04.0.0(transitive)

• + Addedpath-exists@2.1.03.0.0(transitive)

• + Addedpath-parse@1.0.7(transitive)

• + Addedpath-type@1.1.03.0.0(transitive)

• + Addedpify@2.3.03.0.0(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedq@1.5.1(transitive)

• + Addedquick-lru@1.1.0(transitive)

• + Addedread-pkg@1.1.03.0.0(transitive)

• + Addedread-pkg-up@1.0.13.0.0(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedredent@1.0.02.0.0(transitive)

• + Addedrepeating@2.0.1(transitive)

• + Addedresolve@1.22.8(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsemver@5.7.2(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedsource-map@0.6.1(transitive)

• + Addedspdx-correct@3.2.0(transitive)

• + Addedspdx-exceptions@2.5.0(transitive)

• + Addedspdx-expression-parse@3.0.1(transitive)

• + Addedspdx-license-ids@3.0.18(transitive)

• + Addedsplit@1.0.1(transitive)

• + Addedsplit2@1.1.1(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedstrip-bom@2.0.03.0.0(transitive)

• + Addedstrip-indent@1.0.12.0.0(transitive)

• + Addedsupports-preserve-symlinks-flag@1.0.0(transitive)

• + Addedtempfile@1.1.1(transitive)

• + Addedtext-extensions@1.9.0(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedthrough2@2.0.5(transitive)

• + Addedtrim-newlines@1.0.02.0.0(transitive)

• + Addedtrim-off-newlines@1.0.3(transitive)

• + Addeduglify-js@3.19.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addeduuid@2.0.3(transitive)

• + Addedvalidate-npm-package-license@3.0.4(transitive)

• + Addedwordwrap@1.0.0(transitive)

• + Addedxtend@4.0.2(transitive)