keep-a-changelog 2.1.0 → 2.3.0

package/script/test/changelog.expected.linted.md

@@ -0,0 +1,208 @@
+# 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] [YANKED]
+
+This is a brand new releases with:
+- Configuration is now done within the Web client, for authorized users.
+
+### Added
+
+- Test
+
+## [2.0.0] - Unreleased [YANKED]
+
+### 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 [YANKED]
+
+### 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/script/test/changelog.expected.md

@@ -1,5 +1,4 @@
 # 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/)
@@ -7,6 +6,9 @@ and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased] [YANKED]
+This is a brand new releases with:
+- Configuration is now done within the Web client, for authorized users.
+
 ### Added
 - Test
 

package/script/test/changelog.md

@@ -7,6 +7,10 @@ and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased] [Yanked]
+This is a brand new releases with:
+
+
+- Configuration is now done within the Web client, for authorized users.
 
 ### Added
 

package/script/test/deps.d.ts

@@ -0,0 +1 @@
+export * from "../deps/deno.land/std@0.133.0/testing/asserts.js";

package/script/test/empty.expected.md

@@ -1,5 +1,4 @@
 # Changelog
-
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)

package/script/test/fixture/CustomRelease.d.ts

@@ -0,0 +1,8 @@
+import { Change, Release } from "../../mod.js";
+import { Semver } from "../../src/deps.js";
+declare class CustomRelease extends Release {
+    constructor(version?: Semver | string, date?: Date | string, description?: string);
+    maintenance(change: string | Change): this;
+}
+export default function (version?: Semver | string, date?: Date | string, description?: string): CustomRelease;
+export {};

package/script/test/parser.test.d.ts

@@ -0,0 +1 @@
+export {};

package/script/test/test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/deps/deno.land/std@0.120.0/_util/assert.js

@@ -1,13 +0,0 @@
-// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
-export class DenoStdInternalError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "DenoStdInternalError";
-    }
-}
-/** Make an assertion, if not `true`, then throw. */
-export function assert(expr, msg = "") {
-    if (!expr) {
-        throw new DenoStdInternalError(msg);
-    }
-}

package/esm/deps/deno.land/std@0.120.0/path/_interface.js

@@ -1,3 +0,0 @@
-// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
-// This module is browser compatible.
-export {};

package/esm/deps/deno.land/std@0.120.0/path/mod.js

@@ -1,14 +0,0 @@
-// Copyright the Browserify authors. MIT License.
-// Ported mostly from https://github.com/browserify/path-browserify/
-// This module is browser compatible.
-import { isWindows } from "../_util/os.js";
-import * as _win32 from "./win32.js";
-import * as _posix from "./posix.js";
-const path = isWindows ? _win32 : _posix;
-export const win32 = _win32;
-export const posix = _posix;
-export const { basename, delimiter, dirname, extname, format, fromFileUrl, isAbsolute, join, normalize, parse, relative, resolve, sep, toFileUrl, toNamespacedPath, } = path;
-export * from "./common.js";
-export { SEP, SEP_PATTERN } from "./separator.js";
-export * from "./_interface.js";
-export * from "./glob.js";

package/script/deps/deno.land/std@0.120.0/_util/assert.js

@@ -1,18 +0,0 @@
-"use strict";
-// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assert = exports.DenoStdInternalError = void 0;
-class DenoStdInternalError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "DenoStdInternalError";
-    }
-}
-exports.DenoStdInternalError = DenoStdInternalError;
-/** Make an assertion, if not `true`, then throw. */
-function assert(expr, msg = "") {
-    if (!expr) {
-        throw new DenoStdInternalError(msg);
-    }
-}
-exports.assert = assert;

package/types/deps/deno.land/std@0.120.0/_util/assert.d.ts

@@ -1,5 +0,0 @@
-export declare class DenoStdInternalError extends Error {
-    constructor(message: string);
-}
-/** Make an assertion, if not `true`, then throw. */
-export declare function assert(expr: unknown, msg?: string): asserts expr;

package/types/deps/deno.land/std@0.120.0/_util/os.d.ts

@@ -1,3 +0,0 @@
-export declare type OSType = "windows" | "linux" | "darwin";
-export declare const osType: OSType;
-export declare const isWindows: boolean;

package/types/deps/deno.land/std@0.120.0/flags/mod.d.ts

@@ -1,50 +0,0 @@
-export interface Args {
-    /** Contains all the arguments that didn't have an option associated with
-     * them. */
-    _: Array<string | number>;
-    [key: string]: any;
-}
-export interface ArgParsingOptions {
-    /** When `true`, populate the result `_` with everything before the `--` and
-     * the result `['--']` with everything after the `--`. Here's an example:
-     *
-     * ```ts
-     *      // $ deno run example.ts -- a arg1
-     *      import { parse } from "./mod.ts";
-     *      console.dir(parse(Deno.args, { "--": false }));
-     *      // output: { _: [ "a", "arg1" ] }
-     *      console.dir(parse(Deno.args, { "--": true }));
-     *      // output: { _: [], --: [ "a", "arg1" ] }
-     * ```
-     *
-     * Defaults to `false`.
-     */
-    "--"?: boolean;
-    /** An object mapping string names to strings or arrays of string argument
-     * names to use as aliases */
-    alias?: Record<string, string | string[]>;
-    /** A boolean, string or array of strings to always treat as booleans. If
-     * `true` will treat all double hyphenated arguments without equal signs as
-     * `boolean` (e.g. affects `--foo`, not `-f` or `--foo=bar`) */
-    boolean?: boolean | string | string[];
-    /** An object mapping string argument names to default values. */
-    default?: Record<string, unknown>;
-    /** When `true`, populate the result `_` with everything after the first
-     * non-option. */
-    stopEarly?: boolean;
-    /** A string or array of strings argument names to always treat as strings. */
-    string?: string | string[];
-    /** A function which is invoked with a command line parameter not defined in
-     * the `options` configuration object. If the function returns `false`, the
-     * unknown option is not added to `parsedArgs`. */
-    unknown?: (arg: string, key?: string, value?: unknown) => unknown;
-}
-/** Take a set of command line arguments, with an optional set of options, and
- * return an object representation of those argument.
- *
- * ```ts
- *      import { parse } from "./mod.ts";
- *      const parsedArgs = parse(Deno.args);
- * ```
- */
-export declare function parse(args: string[], { "--": doubleDash, alias, boolean, default: defaults, stopEarly, string, unknown, }?: ArgParsingOptions): Args;

package/types/deps/deno.land/x/semver@v1.4.0/mod.d.ts

@@ -1,116 +0,0 @@
-export declare type ReleaseType = "pre" | "major" | "premajor" | "minor" | "preminor" | "patch" | "prepatch" | "prerelease";
-export declare type Operator = "===" | "!==" | "" | "=" | "==" | "!=" | ">" | ">=" | "<" | "<=";
-export interface Options {
-    loose?: boolean;
-    includePrerelease?: boolean;
-}
-export declare const SEMVER_SPEC_VERSION = "2.0.0";
-export declare function parse(version: string | SemVer | null, optionsOrLoose?: boolean | Options): SemVer | null;
-export declare function valid(version: string | SemVer | null, optionsOrLoose?: boolean | Options): string | null;
-export declare function clean(version: string, optionsOrLoose?: boolean | Options): string | null;
-export declare class SemVer {
-    raw: string;
-    loose: boolean;
-    options: Options;
-    major: number;
-    minor: number;
-    patch: number;
-    version: string;
-    build: ReadonlyArray<string>;
-    prerelease: Array<string | number>;
-    constructor(version: string | SemVer, optionsOrLoose?: boolean | Options);
-    format(): string;
-    compare(other: string | SemVer): 1 | 0 | -1;
-    compareMain(other: string | SemVer): 1 | 0 | -1;
-    comparePre(other: string | SemVer): 1 | 0 | -1;
-    compareBuild(other: string | SemVer): 1 | 0 | -1;
-    inc(release: ReleaseType, identifier?: string): SemVer;
-    toString(): string;
-}
-/**
- * Return the version incremented by the release type (major, minor, patch, or prerelease), or null if it's not valid.
- */
-export declare function inc(version: string | SemVer, release: ReleaseType, optionsOrLoose?: boolean | Options, identifier?: string): string | null;
-export declare function diff(version1: string | SemVer, version2: string | SemVer, optionsOrLoose?: boolean | Options): ReleaseType | null;
-export declare function compareIdentifiers(a: string | number | null, b: string | number | null): 1 | 0 | -1;
-export declare function rcompareIdentifiers(a: string | null, b: string | null): 1 | 0 | -1;
-/**
- * Return the major version number.
- */
-export declare function major(v: string | SemVer, optionsOrLoose?: boolean | Options): number;
-/**
- * Return the minor version number.
- */
-export declare function minor(v: string | SemVer, optionsOrLoose?: boolean | Options): number;
-/**
- * Return the patch version number.
- */
-export declare function patch(v: string | SemVer, optionsOrLoose?: boolean | Options): number;
-export declare function compare(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): 1 | 0 | -1;
-export declare function compareLoose(a: string | SemVer, b: string | SemVer): 1 | 0 | -1;
-export declare function compareBuild(a: string | SemVer, b: string | SemVer, loose?: boolean | Options): 1 | 0 | -1;
-export declare function rcompare(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): 1 | 0 | -1;
-export declare function sort<T extends string | SemVer>(list: T[], optionsOrLoose?: boolean | Options): T[];
-export declare function rsort<T extends string | SemVer>(list: T[], optionsOrLoose?: boolean | Options): T[];
-export declare function gt(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function lt(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function eq(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function neq(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function gte(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function lte(v1: string | SemVer, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare function cmp(v1: string | SemVer, operator: Operator, v2: string | SemVer, optionsOrLoose?: boolean | Options): boolean;
-export declare class Comparator {
-    semver: SemVer;
-    operator: "" | "=" | "<" | ">" | "<=" | ">=";
-    value: string;
-    loose: boolean;
-    options: Options;
-    constructor(comp: string | Comparator, optionsOrLoose?: boolean | Options);
-    parse(comp: string): void;
-    test(version: string | SemVer): boolean;
-    intersects(comp: Comparator, optionsOrLoose?: boolean | Options): boolean;
-    toString(): string;
-}
-export declare class Range {
-    range: string;
-    raw: string;
-    loose: boolean;
-    options: Options;
-    includePrerelease: boolean;
-    set: ReadonlyArray<ReadonlyArray<Comparator>>;
-    constructor(range: string | Range | Comparator, optionsOrLoose?: boolean | Options);
-    format(): string;
-    parseRange(range: string): ReadonlyArray<Comparator>;
-    test(version: string | SemVer): boolean;
-    intersects(range?: Range, optionsOrLoose?: boolean | Options): boolean;
-    toString(): string;
-}
-export declare function toComparators(range: string | Range, optionsOrLoose?: boolean | Options): string[][];
-export declare function satisfies(version: string | SemVer, range: string | Range, optionsOrLoose?: boolean | Options): boolean;
-export declare function maxSatisfying<T extends string | SemVer>(versions: ReadonlyArray<T>, range: string | Range, optionsOrLoose?: boolean | Options): T | null;
-export declare function minSatisfying<T extends string | SemVer>(versions: ReadonlyArray<T>, range: string | Range, optionsOrLoose?: boolean | Options): T | null;
-export declare function minVersion(range: string | Range, optionsOrLoose?: boolean | Options): SemVer | null;
-export declare function validRange(range: string | Range | null, optionsOrLoose?: boolean | Options): string | null;
-/**
- * Return true if version is less than all the versions possible in the range.
- */
-export declare function ltr(version: string | SemVer, range: string | Range, optionsOrLoose?: boolean | Options): boolean;
-/**
- * Return true if version is greater than all the versions possible in the range.
- */
-export declare function gtr(version: string | SemVer, range: string | Range, optionsOrLoose?: boolean | Options): boolean;
-/**
- * Return true if the version is outside the bounds of the range in either the high or low direction.
- * The hilo argument must be either the string '>' or '<'. (This is the function called by gtr and ltr.)
- */
-export declare function outside(version: string | SemVer, range: string | Range, hilo: ">" | "<", optionsOrLoose?: boolean | Options): boolean;
-export declare function prerelease(version: string | SemVer, optionsOrLoose?: boolean | Options): ReadonlyArray<string | number> | null;
-/**
- * Return true if any of the ranges comparators intersect
- */
-export declare function intersects(range1: string | Range | Comparator, range2: string | Range | Comparator, optionsOrLoose?: boolean | Options): boolean;
-/**
- * Coerces a string to semver if possible
- */
-export declare function coerce(version: string | SemVer, optionsOrLoose?: boolean | Options): SemVer | null;
-export default SemVer;

package/types/src/deps.d.ts

@@ -1 +0,0 @@
-export { default as Semver, eq, } from "../deps/deno.land/x/semver@v1.4.0/mod.js";