keep-a-changelog 0.10.4 → 2.0.0-beta

package/umd/test/changelog.expected.md

@@ -0,0 +1,169 @@
+# Changelog - demo
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Test
+
+## [2.0.0] - Unreleased
+### Added
+- None
+- Test with issue link [#1]
+- Test with issue link [#4] in the middle of the text
+  - [#3] Test with issue link in the beginning of the text
+  - Test with issue dot [#2], [#10].
+    - Test with no issue link #123b
+    - Test with `package#2.0`
+
+## [1.0.0] - 2017-06-20
+### Added
+- New visual identity by @tylerfortune8.
+- Version navigation.
+- Links to latest released version in previous versions.
+- "Why keep a changelog?" section.
+- "Who needs a changelog?" section.
+- "How do I make a changelog?" section.
+- "Frequently Asked Questions" section.
+- New "Guiding Principles" sub-section to "How do I make a changelog?".
+- Simplified and Traditional Chinese translations from @tianshuo.
+- German translation from @mpbzh & @Art4.
+- Italian translation from @azkidenz.
+- Swedish translation from @magol.
+- Turkish translation from @karalamalar.
+- French translation from @zapashcanon.
+- Brazilian Portugese translation from @aisamu.
+- Polish translation from @amielucha.
+- Russian translation from @aishek.
+- Czech translation from @h4vry.
+- Slovak translation from @jkostolansky.
+
+### Changed
+- Start using "changelog" over "change log" since it's the common usage.
+- Start versioning based on the current English version at 0.3.0 to help
+  translation authors keep things up-to-date.
+- Rewrite "What makes unicorns cry?" section.
+- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
+- Improve "Commit log diffs" sub-section to further argument against them.
+- Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
+- Fix typos in Simplified Chinese and Traditional Chinese translations.
+- Fix typos in Brazilian Portugese translation.
+- Fix typos in Turkish translation.
+- Fix typos in Czech translation.
+- Fix typos in Swedish translation.
+- Improve phrasing in French translation.
+- Fix phrasing and spelling in German translation.
+
+### Removed
+- Section about "changelog" vs "CHANGELOG".
+
+## [0.3.0] - 2015-12-03
+### Added
+- RU translation from @aishek.
+- pt-BR translation from @tallesl.
+- es-ES translation from @ZeliosAriex.
+
+## [0.2.0] - 2015-10-06
+### Changed
+- Remove exclusionary mentions of "open source" since this project can benefit
+  both "open" and "closed" source projects equally.
+
+## [0.1.0] - 2015-10-06
+### Added
+- Answer "Should you ever rewrite a change log?".
+
+### Changed
+- Improve argument against commit logs.
+- Start following [SemVer](http://semver.org) properly.
+
+## [0.0.8] - 2015-02-17
+### Changed
+- Update year to match in every README example.
+- Reluctantly stop making fun of Brits only, since most of the world writes
+  dates in a strange way.
+
+### Fixed
+- Fix typos in recent README changes.
+- Update outdated unreleased diff link.
+
+## [0.0.7] - 2015-02-16
+### Added
+- Link, and make it obvious that date format is ISO 8601.
+
+### Changed
+- Clarified the section on "Is there a standard change log format?".
+
+### Fixed
+- Fix Markdown links to tag comparison URL with footnote-style links.
+
+## [0.0.6] - 2014-12-12
+### Added
+- README section on "yanked" releases.
+
+## [0.0.5] - 2014-08-09
+### Added
+- Markdown links to version tags on release headings.
+- Unreleased section to gather unreleased changes and encourage note keeping
+  prior to releases.
+
+## [0.0.4] - 2014-08-09
+### Added
+- Better explanation of the difference between the file ("CHANGELOG") and its
+  function "the change log".
+
+### Changed
+- Refer to a "change log" instead of a "CHANGELOG" throughout the site to
+  differentiate between the file and the purpose of the file — the logging of
+  changes.
+
+### Removed
+- Remove empty sections from CHANGELOG, they occupy too much space and create
+  too much noise in the file. People will have to assume that the missing
+  sections were intentionally left out because they contained no notable
+  changes.
+
+## [0.0.3] - 2014-08-09
+### Added
+- "Why should I care?" section mentioning The Changelog podcast.
+
+## [0.0.2] - 2014-07-10
+### Added
+- Explanation of the recommended reverse chronological release ordering.
+
+## [0.0.1] - 2014-05-31
+### Added
+- This CHANGELOG file to hopefully serve as an evolving example of a
+  standardized open source project CHANGELOG.
+- CNAME file to enable GitHub Pages custom domain
+- README now contains answers to common questions about CHANGELOGs
+- Good examples and basic guidelines, including proper date formatting.
+- Counter-examples: "What makes unicorns cry?"
+
+[#1]: https://github.com/olivierlacan/keep-a-changelog/issues/1
+[#2]: https://github.com/olivierlacan/keep-a-changelog/issues/2
+[#3]: https://github.com/olivierlacan/keep-a-changelog/issues/3
+[#4]: https://github.com/olivierlacan/keep-a-changelog/issues/4
+[#10]: https://github.com/olivierlacan/keep-a-changelog/issues/10
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[2.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
+[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
+[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1
+
+---
+
+This is a footer

package/umd/test/changelog.md

@@ -0,0 +1,197 @@
+# Changelog - demo
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Test
+
+## [2.0.0] - unreleased
+
+### Added
+
+- None
+- Test with issue link [#1]
+- Test with issue link #4 in the middle of the text
+  - #3 Test with issue link in the beginning of the text
+  - Test with issue dot #2, #10.
+    - Test with no issue link #123b
+    - Test with `package#2.0`
+
+## [1.0.0] - 2017-06-20
+
+### Added
+
+- New visual identity by @tylerfortune8.
+- Version navigation.
+- Links to latest released version in previous versions.
+- "Why keep a changelog?" section.
+- "Who needs a changelog?" section.
+- "How do I make a changelog?" section.
+- "Frequently Asked Questions" section.
+- New "Guiding Principles" sub-section to "How do I make a changelog?".
+- Simplified and Traditional Chinese translations from @tianshuo.
+- German translation from @mpbzh & @Art4.
+- Italian translation from @azkidenz.
+- Swedish translation from @magol.
+- Turkish translation from @karalamalar.
+- French translation from @zapashcanon.
+- Brazilian Portugese translation from @aisamu.
+- Polish translation from @amielucha.
+- Russian translation from @aishek.
+- Czech translation from @h4vry.
+- Slovak translation from @jkostolansky.
+
+### Changed
+
+- Start using "changelog" over "change log" since it's the common usage.
+- Start versioning based on the current English version at 0.3.0 to help
+  translation authors keep things up-to-date.
+- Rewrite "What makes unicorns cry?" section.
+- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal scenario.
+- Improve "Commit log diffs" sub-section to further argument against them.
+- Merge "Why can’t people just use a git log diff?" with "Commit log diffs"
+- Fix typos in Simplified Chinese and Traditional Chinese translations.
+- Fix typos in Brazilian Portugese translation.
+- Fix typos in Turkish translation.
+- Fix typos in Czech translation.
+- Fix typos in Swedish translation.
+- Improve phrasing in French translation.
+- Fix phrasing and spelling in German translation.
+
+### Removed
+
+- Section about "changelog" vs "CHANGELOG".
+
+## [0.3.0] - 2015-12-03
+
+### Added
+
+- RU translation from @aishek.
+- pt-BR translation from @tallesl.
+- es-ES translation from @ZeliosAriex.
+
+## [0.2.0] - 2015-10-06
+
+### Changed
+
+- Remove exclusionary mentions of "open source" since this project can benefit
+  both "open" and "closed" source projects equally.
+
+## [0.1.0] - 2015-10-06
+
+### Added
+
+- Answer "Should you ever rewrite a change log?".
+
+### Changed
+
+- Improve argument against commit logs.
+- Start following [SemVer](http://semver.org) properly.
+
+## [0.0.8] - 2015-02-17
+
+### Changed
+
+- Update year to match in every README example.
+- Reluctantly stop making fun of Brits only, since most of the world writes
+  dates in a strange way.
+
+### Fixed
+
+- Fix typos in recent README changes.
+- Update outdated unreleased diff link.
+
+## [0.0.7] - 2015-02-16
+
+### Added
+
+- Link, and make it obvious that date format is ISO 8601.
+
+### Changed
+
+- Clarified the section on "Is there a standard change log format?".
+
+### Fixed
+
+- Fix Markdown links to tag comparison URL with footnote-style links.
+
+## [0.0.6] - 2014-12-12
+
+### Added
+
+- README section on "yanked" releases.
+
+## [0.0.5] - 2014-08-09
+
+### Added
+
+- Markdown links to version tags on release headings.
+- Unreleased section to gather unreleased changes and encourage note keeping
+  prior to releases.
+
+## [0.0.4] - 2014-08-09
+
+### Added
+
+- Better explanation of the difference between the file ("CHANGELOG") and its
+  function "the change log".
+
+### Changed
+
+- Refer to a "change log" instead of a "CHANGELOG" throughout the site to
+  differentiate between the file and the purpose of the file — the logging of
+  changes.
+
+### Removed
+
+- Remove empty sections from CHANGELOG, they occupy too much space and create
+  too much noise in the file. People will have to assume that the missing
+  sections were intentionally left out because they contained no notable
+  changes.
+
+## [0.0.3] - 2014-08-09
+
+### Added
+
+- "Why should I care?" section mentioning The Changelog podcast.
+
+## [0.0.2] - 2014-07-10
+
+### Added
+
+- Explanation of the recommended reverse chronological release ordering.
+
+## 0.0.1 - 2014-05-31
+
+### Added
+
+- This CHANGELOG file to hopefully serve as an evolving example of a
+  standardized open source project CHANGELOG.
+- CNAME file to enable GitHub Pages custom domain
+- README now contains answers to common questions about CHANGELOGs
+- Good examples and basic guidelines, including proper date formatting.
+- Counter-examples: "What makes unicorns cry?"
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
+[0.3.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.8...v0.1.0
+[0.0.8]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
+
+---
+
+This is a footer

package/umd/test/empty.expected.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).

package/bin.js

@@ -1,128 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-const url = require('url');
-const { parser, Changelog, Release } = require('./src');
-const argv = require('yargs-parser')(process.argv.slice(2), {
-    default: {
-        file: 'CHANGELOG.md',
-        url: null,
-        https: true,
-        quiet: false,
-    },
-    boolean: ['https', 'init', 'latest-release', 'quiet'],
-});
-
-const file = path.join(process.cwd(), argv.file);
-
-try {
-    if (argv.init) {
-        const changelog = new Changelog('Changelog').addRelease(
-            new Release('0.1.0', new Date(), 'First version')
-        );
-
-        save(file, changelog, true);
-        process.exit(0);
-    }
-
-    const changelog = parser(fs.readFileSync(file, 'UTF-8'));
-
-    if (argv.latestRelease) {
-        const release = changelog.releases.find((release) => release.date && release.version);
-
-        if (release) {
-            console.log(release.version.toString());
-        }
-
-        process.exit(0);
-    }
-
-    if (argv.release) {
-        const release = changelog.releases.find((release) => {
-            if (release.date) {
-                return false;
-            }
-
-            if (typeof argv.release === "string") {
-                return !release.version || argv.release === release.version.toString();
-            }
-
-            return !!release.version;
-        });
-
-        if (release) {
-            release.date = new Date();
-            if (typeof argv.release === "string") {
-                release.setVersion(argv.release);
-            }
-        } else {
-            console.error("Not found any valid unreleased version");
-            process.exit(1);
-        }
-    }
-
-    if (!changelog.url && !argv.url) {
-        const gitconfig = require('gitconfiglocal');
-
-        gitconfig(process.cwd(), (err, config) => {
-            if (err) {
-                console.error(red(err));
-                return;
-            }
-
-            changelog.url = getHttpUrl(
-                config.remote && config.remote.origin && config.remote.origin.url
-            );
-            save(file, changelog);
-        });
-    } else {
-        changelog.url = getHttpUrl(argv.url || changelog.url);
-        save(file, changelog);
-    }
-} catch (err) {
-    console.error(red(err.message));
-    if (!argv.quiet) {
-        process.exit(1);
-    }
-}
-
-function getHttpUrl(remoteUrl) {
-    if (!remoteUrl) {
-        return;
-    }
-
-    const parsed = url.parse(remoteUrl.replace('git@', `https://`));
-
-    if (!argv.https) {
-        parsed.protocol = 'http';
-    }
-
-    parsed.pathname = parsed.pathname.replace(/\.git$/, '').replace(/^\/\:/, '/');
-
-    return url.format(parsed);
-}
-
-function save(file, changelog, isNew) {
-    const url = changelog.url;
-
-    if (url && url.includes('gitlab.com')) {
-        changelog.head = 'master';
-    }
-
-    fs.writeFileSync(file, changelog.toString());
-
-    if (isNew) {
-        console.log(green('Generated new file'), file);
-    } else {
-        console.log(green('Updated file'), file);
-    }
-}
-
-function red(message) {
-    return '\u001b[' + 31 + 'm' + message + '\u001b[' + 39 + 'm';
-}
-
-function green(message) {
-    return '\u001b[' + 32 + 'm' + message + '\u001b[' + 39 + 'm';
-}

package/src/Change.js

@@ -1,40 +0,0 @@
-class Change {
-    constructor(title, description = '') {
-        this.issues = [];
-        this.title = Change.extractIssues(title, this.issues);
-        this.description = Change.extractIssues(description, this.issues);
-    }
-
-    toString() {
-        let t = this.title.split('\n').map((line) => `  ${line}`);
-        t[0] = '-' + t[0].substr(1);
-
-        if (this.description) {
-            t.push('');
-
-            t = t.concat(this.description.split('\n').map((line) => `  ${line}`));
-        }
-
-        return t.join('\n').trim();
-    }
-}
-
-module.exports = Change;
-
-Change.extractIssues = function (text, issues) {
-    return text
-        .replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (matches, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-
-            return `${start}[#${index}]`;
-        })
-        .replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (matches, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-
-            return `${start}[#${index}]`;
-        });
-};

package/src/Changelog.js

@@ -1,121 +0,0 @@
-const Release = require('./Release');
-const eq = require('semver/functions/eq');
-
-class Changelog {
-    constructor(title, description = '') {
-        this.title = title;
-        this.description = description;
-        this.head = 'HEAD';
-        this.footer = null;
-        this.url = null;
-        this.releases = [];
-        this.tagNameBuilder = null;
-    }
-
-    addRelease(release) {
-        if (!(release instanceof Release)) {
-            throw new Error('Invalid release. Must be an instance of Release');
-        }
-
-        this.releases.push(release);
-        this.sortReleases();
-        release.changelog = this;
-
-        return this;
-    }
-
-    findRelease(version) {
-        if (!version) {
-            return this.releases.find((release) => !release.version);
-        }
-        return this.releases.find((release) => release.version && eq(release.version, version));
-    }
-
-    sortReleases() {
-        this.releases.sort((a, b) => a.compare(b));
-    }
-
-    tagName(release) {
-        if (this.tagNameBuilder) {
-            return this.tagNameBuilder(release);
-        }
-
-        return `v${release.version}`;
-    }
-
-    toString() {
-        const t = [`# ${this.title}`];
-
-        const links = [];
-        const compareLinks = [];
-
-        const description =
-            this.description.trim() ||
-            `All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).`;
-
-        if (description) {
-            t.push('');
-            t.push(description);
-        }
-
-        this.releases.forEach((release) => {
-            t.push('');
-            t.push(release.toString(this));
-
-            release.getLinks(this).forEach((link) => {
-                if (!links.includes(link)) {
-                    links.push(link);
-                }
-            });
-
-            const link = release.getCompareLink(this);
-
-            if (link) {
-                compareLinks.push(link);
-            }
-        });
-
-        if (links.length) {
-            t.push('');
-            links.sort(compare);
-            links.forEach((link) => t.push(link));
-        }
-
-        if (compareLinks.length) {
-            t.push('');
-
-            compareLinks.forEach((link) => t.push(link));
-        }
-
-        t.push('');
-
-        if (this.footer) {
-            t.push('---');
-            t.push('');
-            t.push(this.footer);
-            t.push('');
-        }
-
-        return t.join('\n');
-    }
-}
-
-module.exports = Changelog;
-
-function compare(a, b) {
-    if (a === b) {
-        return 0;
-    }
-    const reg = /^\[#(\d+)\]:/;
-    const aNumber = a.match(reg);
-    const bNumber = b.match(reg);
-
-    if (aNumber && bNumber) {
-        return parseInt(aNumber[1]) - parseInt(bNumber[1]);
-    }
-
-    return a < b ? -1 : 1;
-}