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(package): Add support for missing version #25

Merged
merged 7 commits into from
Aug 29, 2017
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/package.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ exports.calculateNewVersion = function (options) {
options = options || {};
return exports.getUserPackage()
.then(function (userPackage) {
if (!userPackage.version) {
return null;
}

var split = userPackage.version.split('.');

if (options.major) {
Expand Down
6 changes: 5 additions & 1 deletion lib/writer.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ exports.markdown = function (version, commits, options) {
heading = '####';
}

heading += ' ' + version + ' (' + date + ')';
if (version) {
heading += ' ' + version + ' (' + date + ')';
} else {
heading += ' ' + date;
}

content.push(heading);
content.push('');
Expand Down
10 changes: 10 additions & 0 deletions test/package.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ describe('package', function () {
Expect(version).to.eql('1.2.3');
});
});

it('returns null if no version is specified', function () {
Package.getUserPackage.restore();
Sinon.stub(Package, 'getUserPackage').returns(Bluebird.resolve({ version: '' }));

return Package.calculateNewVersion()
.then(function (version) {
Expect(version).to.eql(null);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit pick: can you change this to .to.be.null;. We prefer to use the chai shorthands whenever possible.

});
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit pick: can you add a new line after this it block? We usually pad our it blocks with new lines on the top and bottom.

});

});
11 changes: 11 additions & 0 deletions test/writer.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ describe('writer', function () {
});
});

it('keeps only the date if no version is specified', function () {
var options = { major: true };

return Writer.markdown(false, [], options)
.then(function (changelog) {
var heading = changelog.split('\n')[0];

Expect(heading).to.equal('## ' + new Date().toJSON().slice(0,10));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit pick: can you add a space after the comma in the .slice? There should've been a lint rule for that. I'll look into why that didn't err out.

Copy link
Contributor Author

@ffflorian ffflorian Aug 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I copied this from writer.js but I see that you updated it with the new lint version :)

});
});

it('flushes out a commit type with its full name', function () {
var commits = [
{ type: 'feat', category: 'testing', subject: 'did some testing', hash: '1234567890' }
Expand Down