Merge fcdd488 into 18f71d2

conventional-changelog · Mar 31, 2019 · 933493f · 933493f
2 parents 18f71d2 + fcdd488
commit 933493f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 15 deletions.
diff --git a/packages/conventional-changelog-conventionalcommits/README.md b/packages/conventional-changelog-conventionalcommits/README.md
@@ -6,8 +6,8 @@ A concrete implementation of the specification described at
 [conventionalcommits.org](https://conventionalcommits.org/) for automated
 CHANGELOG generation and version management.
 
-TODO: once we flesh out the spec for configuring conventional-changelog tools,
-fill in this section of the README [see](https://github.com/conventional-changelog/conventional-changelog-config-spec/issues/1).
+See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec]) for available
+configuration options.
 
 [travis-image]: https://travis-ci.org/conventional-changelog/conventional-changelog.svg?branch=master
 [travis-url]: https://travis-ci.org/conventional-changelog/conventional-changelog

diff --git a/packages/conventional-changelog-conventionalcommits/writer-opts.js b/packages/conventional-changelog-conventionalcommits/writer-opts.js
@@ -65,9 +65,9 @@ function getWriterOpts (config) {
 
       // breaking changes attached to any type are still displayed.
       if (discard && (typesLookup[typeKey] === undefined ||
-          typesLookup[typeKey].hide)) return
+          typesLookup[typeKey].hidden)) return
 
-      if (typesLookup[typeKey]) commit.type = typesLookup[typeKey].name
+      if (typesLookup[typeKey]) commit.type = typesLookup[typeKey].section
 
       if (commit.scope === `*`) {
         commit.scope = ``
@@ -134,17 +134,17 @@ function getWriterOpts (config) {
 function defaultConfig (config) {
   config = config || {}
   config.types = config.types || [
-    { type: 'feat', name: 'Features' },
-    { type: 'fix', name: 'Bug Fixes' },
-    { type: 'perf', name: 'Performance Improvements' },
-    { type: 'revert', name: 'Reverts' },
-    { type: 'docs', name: 'Documentation', hide: true },
-    { type: 'style', name: 'Styles', hide: true },
-    { type: 'chore', name: 'Miscellaneous Chores', hide: true },
-    { type: 'refactor', name: 'Code Refactoring', hide: true },
-    { type: 'test', name: 'Tests', hide: true },
-    { type: 'build', name: 'Build System', hide: true },
-    { type: 'ci', name: 'Continuous Integration', hide: true }
+    { type: 'feat', section: 'Features' },
+    { type: 'fix', section: 'Bug Fixes' },
+    { type: 'perf', section: 'Performance Improvements' },
+    { type: 'revert', section: 'Reverts' },
+    { type: 'docs', section: 'Documentation', hidden: true },
+    { type: 'style', section: 'Styles', hidden: true },
+    { type: 'chore', section: 'Miscellaneous Chores', hidden: true },
+    { type: 'refactor', section: 'Code Refactoring', hidden: true },
+    { type: 'test', section: 'Tests', hidden: true },
+    { type: 'build', section: 'Build System', hidden: true },
+    { type: 'ci', section: 'Continuous Integration', hidden: true }
   ]
   config.issueUrlFormat = config.issueUrlFormat ||
     '{{host}}/{{owner}}/{{repository}}/issues/{{id}}'