keep-a-changelog - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

CHANGELOG.md

@@ -10,2 +10,9 @@ <!-- deno-fmt-ignore-file -->
 
+## [2.1.0] - 2022-04-03
+### Added
+- Support for `[YANKED]` releases [#25]
+
+### Fixed
+- Updated dependencies
+
 ## [2.0.1] - 2022-01-09
@@ -25,4 +32,6 @@ ### Fixed
 [#23]: https://github.com/oscarotero/keep-a-changelog/issues/23
+[#25]: https://github.com/oscarotero/keep-a-changelog/issues/25
 
+[2.1.0]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/oscarotero/keep-a-changelog/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/oscarotero/keep-a-changelog/releases/tag/v2.0.0

esm/bin.js

 #!/usr/bin/env node
+import "./_dnt.polyfills.js";
 import * as dntShim from "./_dnt.shims.js";
-import { join } from "./deps/deno_land/std_0.120.0/path/mod.js";
+import { join } from "./deps/deno.land/std@0.120.0/path/mod.js";
 import { Changelog, parser, Release } from "./mod.js";
-import { parse as parseFlag } from "./deps/deno_land/std_0.120.0/flags/mod.js";
-import { parse as parseIni } from "./deps/deno_land/x/ini_v2.1.0/mod.js";
+import { parse as parseFlag } from "./deps/deno.land/std@0.120.0/flags/mod.js";
+import { parse as parseIni } from "./deps/deno.land/x/ini@v2.1.0/mod.js";
 const argv = parseFlag(dntShim.Deno.args, {
@@ -25,3 +26,3 @@ default: {
     const changelog = parser(dntShim.Deno.readTextFileSync(file));
-    if (argv['latest-release']) {
+    if (argv["latest-release"]) {
         const release = changelog.releases.find((release) => release.date && release.version);
@@ -28,0 +29,0 @@ if (release) {

esm/mod.js

@@ -0,1 +1,2 @@
+import "./_dnt.polyfills.js";
 import parser from "./src/parser.js";
@@ -2,0 +3,0 @@ import Change from "./src/Change.js";

esm/src/deps.js

@@ -1,1 +0,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/x/semver@v1.4.0/mod.js";

esm/src/parser.js

@@ -26,11 +26,14 @@ import Changelog from "./Changelog.js";
     while ((release = getContent(tokens, "h2").toLowerCase())) {
-        const matches = release.match(/\[?([^\]]+)\]?\s*-\s*([\d]{4}-[\d]{1,2}-[\d]{1,2})$/);
+        const matches = release.match(/\[?([^\]]+)\]?\s*-\s*([\d]{4}-[\d]{1,2}-[\d]{1,2})(\s+\[yanked\])?$/);
         if (matches) {
             release = opts.releaseCreator(matches[1], matches[2]);
+            release.yanked = !!matches[3];
         }
         else if (release.includes("unreleased")) {
-            const matches = release.match(/\[?([^\]]+)\]?\s*-\s*unreleased$/);
+            const matches = release.match(/\[?([^\]]+)\]?\s*-\s*unreleased(\s+\[yanked\])?$/);
+            const yanked = release.includes("[yanked]");
             release = matches
                 ? opts.releaseCreator(matches[1])
                 : opts.releaseCreator();
+            release.yanked = yanked;
         }
@@ -37,0 +40,0 @@ else {

esm/src/Release.js

@@ -23,2 +23,8 @@ import { Semver } from "./deps.js";
         });
+        Object.defineProperty(this, "yanked", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
         Object.defineProperty(this, "description", {
@@ -119,8 +125,9 @@ enumerable: true,
         const hasCompareLink = this.getCompareLink(changelog) !== undefined;
+        const yanked = this.yanked ? " [YANKED]" : "";
         if (this.version) {
             if (hasCompareLink) {
-                t.push(`## [${this.version}] - ${formatDate(this.date)}`);
+                t.push(`## [${this.version}] - ${formatDate(this.date)}${yanked}`);
             }
             else {
-                t.push(`## ${this.version} - ${formatDate(this.date)}`);
+                t.push(`## ${this.version} - ${formatDate(this.date)}${yanked}`);
             }
@@ -130,6 +137,6 @@ }
             if (hasCompareLink) {
-                t.push("## [Unreleased]");
+                t.push(`## [Unreleased]${yanked}`);
             }
             else {
-                t.push("## Unreleased");
+                t.push(`## Unreleased${yanked}`);
             }
@@ -136,0 +143,0 @@ }

esm/test/changelog.expected.md

@@ -9,7 +9,7 @@ # Changelog - demo
 
-## [Unreleased]
+## [Unreleased] [YANKED]
 ### Added
 - Test
 
-## [2.0.0] - Unreleased
+## [2.0.0] - Unreleased [YANKED]
 ### Added
@@ -104,3 +104,3 @@ - None
 
-## [0.0.6] - 2014-12-12
+## [0.0.6] - 2014-12-12 [YANKED]
 ### Added
@@ -107,0 +107,0 @@ - README section on "yanked" releases.

esm/test/changelog.md

@@ -9,3 +9,3 @@ # Changelog - demo
 
-## [Unreleased]
+## [Unreleased] [Yanked]
 
@@ -16,3 +16,3 @@ ### Added
 
-## [2.0.0] - unreleased
+## [2.0.0] - unreleased [Yanked]
 
@@ -127,3 +127,3 @@ ### Added
 
-## [0.0.6] - 2014-12-12
+## [0.0.6] - 2014-12-12 [YANKED]
 
@@ -130,0 +130,0 @@ ### Added

package.json

 {
   "module": "./esm/mod.js",
-  "main": "./umd/mod.js",
+  "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
@@ -9,3 +9,3 @@ "bin": {
   "name": "keep-a-changelog",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Node package to parse and generate changelogs following the [keepachangelog](http://keepachangelog.com/en/1.0.0/) format.",
@@ -30,3 +30,3 @@ "homepage": "https://github.com/oscarotero/keep-a-changelog#readme",
       "import": "./esm/mod.js",
-      "require": "./umd/mod.js",
+      "require": "./script/mod.js",
       "types": "./types/mod.d.ts"
@@ -39,8 +39,8 @@ }
   "dependencies": {
-    "@deno/shim-deno": "~0.1.1"
+    "@deno/shim-deno": "~0.4.3"
   },
   "devDependencies": {
-    "@types/node": "16.11.1",
+    "@types/node": "16.11.26",
     "chalk": "4.1.2"
   }
-}
+}

README.md

@@ -25,3 +25,3 @@ # Changelog
 ```js
-import { parser } from "https://deno.land/x/changelog@2.0.0/mod.ts";
+import { parser } from "https://deno.land/x/changelog@v2.0.0/mod.ts";
 
@@ -38,3 +38,6 @@ //Parse a changelog file
 ```js
-import { Changelog, Release } from "https://deno.land/x/changelog@2.0.0/mod.ts";
+import {
+  Changelog,
+  Release,
+} from "https://deno.land/x/changelog@v2.0.0/mod.ts";
 
@@ -41,0 +44,0 @@ const changelog = new Changelog("My project")

types/_dnt.shims.d.ts

 import { Deno } from "@deno/shim-deno";
 export { Deno } from "@deno/shim-deno";
-declare const dntGlobals: {
-    Deno: typeof Deno;
-};
 export declare const dntGlobalThis: Omit<typeof globalThis, "Deno"> & {
     Deno: typeof Deno;
 };
-export declare type dntGlobalThisType = Omit<typeof dntGlobals, keyof typeof dntGlobals> & typeof dntGlobals & {};

types/bin.d.ts

 #!/usr/bin/env node
-export {};
+import "./_dnt.polyfills.js";

types/mod.d.ts

@@ -0,1 +1,2 @@
+import "./_dnt.polyfills.js";
 import parser from "./src/parser.js";
@@ -2,0 +3,0 @@ import Change from "./src/Change.js";

types/src/deps.d.ts

@@ -1,1 +0,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/x/semver@v1.4.0/mod.js";

types/src/Release.d.ts

@@ -8,2 +8,3 @@ import { Semver } from "./deps.js";
     date?: Date;
+    yanked: boolean;
     description: string;
@@ -10,0 +11,0 @@ changes: Map<string, Change[]>;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of package files

89

increased by3.49%

Number of lines in readme file

170

increased by1.8%

Worsened metrics

Total package byte prevSize

413159

decreased by-5.54%

Lines of code

10761

decreased by-1.18%

Dependency changes

• + Added@deno/shim-deno@0.4.3(transitive)

• + Added@deno/shim-deno-test@0.3.3(transitive)

• - Removed@deno/shim-deno@0.1.2(transitive)

• Updated@deno/shim-deno@~0.4.3