keep-a-changelog 2.1.0 → 2.3.0

package/esm/deps/deno.land/{std@0.120.0 → std@0.189.0}/path/win32.js

@@ -1,10 +1,11 @@
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 // Copyright the Browserify authors. MIT License.
 // Ported from https://github.com/browserify/path-browserify/
 // This module is browser compatible.
 import * as dntShim from "../../../../_dnt.shims.js";
 import { CHAR_BACKWARD_SLASH, CHAR_COLON, CHAR_DOT, CHAR_QUESTION_MARK, } from "./_constants.js";
-import { _format, assertPath, encodeWhitespace, isPathSeparator, isWindowsDeviceRoot, normalizeString, } from "./_util.js";
-import { assert } from "../_util/assert.js";
+import { _format, assertPath, encodeWhitespace, isPathSeparator, isPosixPathSeparator, isWindowsDeviceRoot, lastPathSegment, normalizeString, stripSuffix, stripTrailingSeparators, } from "./_util.js";
+import { assert } from "../_util/asserts.js";
 export const sep = "\\";
 export const delimiter = ";";
 /**
@@ -506,8 +507,8 @@ export function toNamespacedPath(path) {
     return path;
 }
 /**
- * Return the directory name of a `path`.
- * @param path to determine name for
+ * Return the directory path of a `path`.
+ * @param path - path to extract the directory from.
  */
 export function dirname(path) {
     assertPath(path);
@@ -597,25 +598,26 @@ export function dirname(path) {
         else
             end = rootEnd;
     }
-    return path.slice(0, end);
+    return stripTrailingSeparators(path.slice(0, end), isPosixPathSeparator);
 }
 /**
- * Return the last portion of a `path`. Trailing directory separators are ignored.
- * @param path to process
- * @param ext of path directory
+ * Return the last portion of a `path`.
+ * Trailing directory separators are ignored, and optional suffix is removed.
+ *
+ * @param path - path to extract name from.
+ * @param [suffix] - suffix to remove from extracted name.
  */
-export function basename(path, ext = "") {
-    if (ext !== undefined && typeof ext !== "string") {
-        throw new TypeError('"ext" argument must be a string');
-    }
+export function basename(path, suffix = "") {
     assertPath(path);
-    let start = 0;
-    let end = -1;
-    let matchedSlash = true;
-    let i;
+    if (path.length === 0)
+        return path;
+    if (typeof suffix !== "string") {
+        throw new TypeError(`Suffix must be a string. Received ${JSON.stringify(suffix)}`);
+    }
     // Check for a drive letter prefix so as not to mistake the following
     // path separator as an extra separator at the end of the path that can be
     // disregarded
+    let start = 0;
     if (path.length >= 2) {
         const drive = path.charCodeAt(0);
         if (isWindowsDeviceRoot(drive)) {
@@ -623,77 +625,14 @@ export function basename(path, ext = "") {
                 start = 2;
         }
     }
-    if (ext !== undefined && ext.length > 0 && ext.length <= path.length) {
-        if (ext.length === path.length && ext === path)
-            return "";
-        let extIdx = ext.length - 1;
-        let firstNonSlashEnd = -1;
-        for (i = path.length - 1; i >= start; --i) {
-            const code = path.charCodeAt(i);
-            if (isPathSeparator(code)) {
-                // If we reached a path separator that was not part of a set of path
-                // separators at the end of the string, stop now
-                if (!matchedSlash) {
-                    start = i + 1;
-                    break;
-                }
-            }
-            else {
-                if (firstNonSlashEnd === -1) {
-                    // We saw the first non-path separator, remember this index in case
-                    // we need it if the extension ends up not matching
-                    matchedSlash = false;
-                    firstNonSlashEnd = i + 1;
-                }
-                if (extIdx >= 0) {
-                    // Try to match the explicit extension
-                    if (code === ext.charCodeAt(extIdx)) {
-                        if (--extIdx === -1) {
-                            // We matched the extension, so mark this as the end of our path
-                            // component
-                            end = i;
-                        }
-                    }
-                    else {
-                        // Extension does not match, so our result is the entire path
-                        // component
-                        extIdx = -1;
-                        end = firstNonSlashEnd;
-                    }
-                }
-            }
-        }
-        if (start === end)
-            end = firstNonSlashEnd;
-        else if (end === -1)
-            end = path.length;
-        return path.slice(start, end);
-    }
-    else {
-        for (i = path.length - 1; i >= start; --i) {
-            if (isPathSeparator(path.charCodeAt(i))) {
-                // If we reached a path separator that was not part of a set of path
-                // separators at the end of the string, stop now
-                if (!matchedSlash) {
-                    start = i + 1;
-                    break;
-                }
-            }
-            else if (end === -1) {
-                // We saw the first non-path separator, mark this as the end of our
-                // path component
-                matchedSlash = false;
-                end = i + 1;
-            }
-        }
-        if (end === -1)
-            return "";
-        return path.slice(start, end);
-    }
+    const lastSegment = lastPathSegment(path, isPathSeparator, start);
+    const strippedSegment = stripTrailingSeparators(lastSegment, isPathSeparator);
+    return suffix ? stripSuffix(strippedSegment, suffix) : strippedSegment;
 }
 /**
- * Return the extension of the `path`.
+ * Return the extension of the `path` with leading period.
  * @param path with extension
+ * @returns extension (ex. for `file.ts` returns `.ts`)
  */
 export function extname(path) {
     assertPath(path);
@@ -827,13 +766,14 @@ export function parse(path) {
                             // `path` contains just a drive root, exit early to avoid
                             // unnecessary work
                             ret.root = ret.dir = path;
+                            ret.base = "\\";
                             return ret;
                         }
                         rootEnd = 3;
                     }
                 }
                 else {
-                    // `path` contains just a drive root, exit early to avoid
+                    // `path` contains just a relative drive root, exit early to avoid
                     // unnecessary work
                     ret.root = ret.dir = path;
                     return ret;
@@ -845,6 +785,7 @@ export function parse(path) {
         // `path` contains just a path separator, exit early to avoid
         // unnecessary work
         ret.root = ret.dir = path;
+        ret.base = "\\";
         return ret;
     }
     if (rootEnd > 0)
@@ -903,6 +844,8 @@ export function parse(path) {
         ret.base = path.slice(startPart, end);
         ret.ext = path.slice(startDot, end);
     }
+    // Fallback to '\' in case there is no basename
+    ret.base = ret.base || "\\";
     // If the directory is the root, use the entire root as the `dir` including
     // the trailing slash if any (`C:\abc` -> `C:\`). Otherwise, strip out the
     // trailing slash (`C:\abc\def` -> `C:\abc`).
@@ -917,7 +860,7 @@ export function parse(path) {
  * Converts a file URL to a path string.
  *
  * ```ts
- *      import { fromFileUrl } from "./win32.ts";
+ *      import { fromFileUrl } from "https://deno.land/std@$STD_VERSION/path/win32.ts";
  *      fromFileUrl("file:///home/foo"); // "\\home\\foo"
  *      fromFileUrl("file:///C:/Users/foo"); // "C:\\Users\\foo"
  *      fromFileUrl("file://localhost/home/foo"); // "\\\\localhost\\home\\foo"
@@ -942,7 +885,7 @@ export function fromFileUrl(url) {
  * Converts a path string to a file URL.
  *
  * ```ts
- *      import { toFileUrl } from "./win32.ts";
+ *      import { toFileUrl } from "https://deno.land/std@$STD_VERSION/path/win32.ts";
  *      toFileUrl("\\home\\foo"); // new URL("file:///home/foo")
  *      toFileUrl("C:\\Users\\foo"); // new URL("file:///C:/Users/foo")
  *      toFileUrl("\\\\127.0.0.1\\home\\foo"); // new URL("file://127.0.0.1/home/foo")

package/esm/src/Change.js

@@ -1,4 +1,19 @@
 export default class Change {
+    static extractIssues(text, issues) {
+        return text
+            .replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (_, start, index) => {
+            if (!issues.includes(index)) {
+                issues.push(index);
+            }
+            return `${start}[#${index}]`;
+        })
+            .replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (_, start, index) => {
+            if (!issues.includes(index)) {
+                issues.push(index);
+            }
+            return `${start}[#${index}]`;
+        });
+    }
     constructor(title, description = "") {
         Object.defineProperty(this, "title", {
             enumerable: true,
@@ -21,21 +36,6 @@ export default class Change {
         this.title = Change.extractIssues(title, this.issues);
         this.description = Change.extractIssues(description, this.issues);
     }
-    static extractIssues(text, issues) {
-        return text
-            .replace(/(^|[^\\])\[#(\d+)\](?=[^\(]|$)/g, (_, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-            return `${start}[#${index}]`;
-        })
-            .replace(/(^|[\s,])#(\d+)(?=[\s,\.]|$)/g, (_, start, index) => {
-            if (!issues.includes(index)) {
-                issues.push(index);
-            }
-            return `${start}[#${index}]`;
-        });
-    }
     toString() {
         let t = this.title.split("\n").map((line) => `  ${line}`.trimEnd());
         t[0] = "-" + t[0].substr(1);

package/{types → esm}/src/Changelog.d.ts

@@ -9,6 +9,7 @@ export default class Changelog {
     url?: string;
     releases: Release[];
     tagNameBuilder?: (release: Release) => string;
+    format: "compact" | "markdownlint";
     constructor(title: string, description?: string);
     addRelease(release: Release): this;
     findRelease(version?: Semver | string): Release | undefined;

package/esm/src/Changelog.js

@@ -49,6 +49,12 @@ export default class Changelog {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "compact"
+        });
         this.title = title;
         this.description = description;
     }
@@ -80,6 +86,9 @@ export default class Changelog {
             t.push("");
         }
         t.push(`# ${this.title}`);
+        if (this.format === "markdownlint") {
+            t.push("");
+        }
         const links = [];
         const compareLinks = [];
         const description = this.description.trim() ||
@@ -88,7 +97,6 @@ export default class Changelog {
 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) => {

package/{types → esm}/src/Release.d.ts

@@ -13,6 +13,7 @@ export default class Release {
     isEmpty(): boolean;
     setVersion(version?: string | Semver): void;
     setDate(date?: Date | string): void;
+    setYanked(yanked?: boolean): this;
     addChange(type: string, change: Change | string): this;
     added(change: Change | string): this;
     changed(change: Change | string): this;

package/esm/src/Release.js

@@ -90,6 +90,10 @@ export default class Release {
         }
         this.date = date;
     }
+    setYanked(yanked = true) {
+        this.yanked = yanked;
+        return this;
+    }
     addChange(type, change) {
         if (!(change instanceof Change)) {
             change = new Change(change);
@@ -138,6 +142,9 @@ export default class Release {
                 t.push(`## Unreleased${yanked}`);
             }
         }
+        if (changelog?.format === "markdownlint") {
+            t.push("");
+        }
         if (this.description.trim()) {
             t.push(this.description.trim());
             t.push("");
@@ -145,6 +152,9 @@ export default class Release {
         this.changes.forEach((changes, type) => {
             if (changes.length) {
                 t.push(`### ${type[0].toUpperCase()}${type.substring(1)}`);
+                if (changelog?.format === "markdownlint") {
+                    t.push("");
+                }
                 t = t.concat(changes.map((change) => change.toString()));
                 t.push("");
             }

package/esm/src/deps.d.ts

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

package/esm/src/deps.js

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

package/esm/src/parser.js

@@ -19,7 +19,7 @@ function processTokens(tokens, opts) {
     const changelog = new Changelog("");
     changelog.flag = getContent(tokens, "flag");
     changelog.title = getContent(tokens, "h1", true);
-    changelog.description = getContent(tokens, "p");
+    changelog.description = getTextContent(tokens);
     //Releases
     let release;
     while ((release = getContent(tokens, "h2").toLowerCase())) {
@@ -40,7 +40,7 @@ function processTokens(tokens, opts) {
             throw new Error(`Syntax error in the release title`);
         }
         changelog.addRelease(release);
-        release.description = getContent(tokens, "p");
+        release.description = getTextContent(tokens);
         let type;
         while ((type = getContent(tokens, "h3").toLowerCase())) {
             let change;
@@ -71,7 +71,8 @@ function processTokens(tokens, opts) {
 }
 /** Returns the content of a token */
 function getContent(tokens, type, required = false) {
-    if (!tokens[0] || tokens[0][1] !== type) {
+    const types = Array.isArray(type) ? type : [type];
+    if (!tokens[0] || types.indexOf(tokens[0][1]) === -1) {
         if (required) {
             throw new Error(`Required token missing in: "${tokens[0][0]}"`);
         }
@@ -79,6 +80,21 @@ function getContent(tokens, type, required = false) {
     }
     return tokens.shift()[2].join("\n");
 }
+/** Return the next text content */
+function getTextContent(tokens) {
+    const lines = [];
+    const types = ["p", "li"];
+    while (tokens[0] && types.indexOf(tokens[0][1]) !== -1) {
+        const token = tokens.shift();
+        if (token[1] === "li") {
+            lines.push("- " + token[2].join("\n"));
+        }
+        else {
+            lines.push(token[2].join("\n"));
+        }
+    }
+    return lines.join("\n");
+}
 /** Tokenize a markdown string */
 function tokenize(markdown) {
     const tokens = [];

package/esm/test/Change.test.d.ts

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

package/esm/test/changelog.custom.type.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/)

package/esm/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/esm/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/esm/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/esm/test/deps.d.ts

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

package/esm/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/esm/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/esm/test/parser.test.d.ts

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

package/esm/test/test.d.ts

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