Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for 'feature' as alias for 'feat' #582

Merged
merged 2 commits into from Feb 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -20,7 +20,7 @@ module.exports = function (config) {
if (commit.notes.length > 0) {
breakings += commit.notes.length
level = 0
} else if (commit.type === 'feat') {
} else if (commit.type === 'feat' || commit.type === 'feature') {
features += 1
if (level === 2) {
level = 1
Expand Down
49 changes: 39 additions & 10 deletions packages/conventional-changelog-conventionalcommits/test/test.js
Expand Up @@ -53,7 +53,11 @@ betterThanBefore.setups([
},
function () {
shell.exec('git tag v0.1.0')
gitDummyCommit('feat: some more features')
gitDummyCommit('feat: some more feats')
},
function () {
shell.exec('git tag v0.2.0')
gitDummyCommit('feature: some more features')
},
function () {
gitDummyCommit(['feat(*): implementing #5 by @dlmr', ' closes #10'])
Expand Down Expand Up @@ -322,6 +326,31 @@ describe('conventionalcommits.org preset', function () {
preparing(6)
var i = 0

conventionalChangelogCore({
config: preset,
outputUnreleased: true
})
.on('error', function (err) {
done(err)
})
.pipe(through(function (chunk, enc, cb) {
chunk = chunk.toString()

expect(chunk).to.include('some more feats')
expect(chunk).to.not.include('BREAKING')

i++
cb()
}, function () {
expect(i).to.equal(1)
done()
}))
})

it('should support "feature" as alias for "feat"', function (done) {
preparing(7)
var i = 0

conventionalChangelogCore({
config: preset,
outputUnreleased: true
Expand All @@ -344,7 +373,7 @@ describe('conventionalcommits.org preset', function () {
})

it('should work with unknown host', function (done) {
preparing(6)
preparing(7)
var i = 0

conventionalChangelogCore({
Expand Down Expand Up @@ -374,7 +403,7 @@ describe('conventionalcommits.org preset', function () {
})

it('should work specifying where to find a package.json using conventional-changelog-core', function (done) {
preparing(7)
preparing(8)
var i = 0

conventionalChangelogCore({
Expand Down Expand Up @@ -402,7 +431,7 @@ describe('conventionalcommits.org preset', function () {
})

it('should fallback to the closest package.json when not providing a location for a package.json', function (done) {
preparing(7)
preparing(8)
var i = 0

conventionalChangelogCore({
Expand All @@ -428,7 +457,7 @@ describe('conventionalcommits.org preset', function () {
})

it('should support non public GitHub repository locations', function (done) {
preparing(7)
preparing(8)

conventionalChangelogCore({
config: preset,
Expand All @@ -453,7 +482,7 @@ describe('conventionalcommits.org preset', function () {
})

it('should only replace with link to user if it is an username', function (done) {
preparing(8)
preparing(9)

conventionalChangelogCore({
config: preset
Expand All @@ -474,7 +503,7 @@ describe('conventionalcommits.org preset', function () {
})

it('supports multiple lines of footer information', function (done) {
preparing(8)
preparing(9)

conventionalChangelogCore({
config: preset
Expand All @@ -492,7 +521,7 @@ describe('conventionalcommits.org preset', function () {
})

it('does not require that types are case sensitive', function (done) {
preparing(8)
preparing(9)

conventionalChangelogCore({
config: preset
Expand All @@ -508,7 +537,7 @@ describe('conventionalcommits.org preset', function () {
})

it('populates breaking change if ! is present', function (done) {
preparing(8)
preparing(9)

conventionalChangelogCore({
config: preset
Expand All @@ -524,7 +553,7 @@ describe('conventionalcommits.org preset', function () {
})

it('parses both default (Revert "<subject>") and custom (revert: <subject>) revert commits', function (done) {
preparing(9)
preparing(10)

conventionalChangelogCore({
config: preset
Expand Down
Expand Up @@ -161,6 +161,7 @@ function defaultConfig (config) {
config = config || {}
config.types = config.types || [
{ type: 'feat', section: 'Features' },
{ type: 'feature', section: 'Features' },
{ type: 'fix', section: 'Bug Fixes' },
{ type: 'perf', section: 'Performance Improvements' },
{ type: 'revert', section: 'Reverts' },
Expand Down