@homer0/package-info - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

./dist/index.js

@@ -22,2 +22,6 @@ "use strict";
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
@@ -46,4 +50,15 @@ mod
   constructor({ inject = {} } = {}) {
+    /**
+     * A deferred promise that resolves when the package.json file is read. It will be
+     * `undefined` if the file hasn't been read yet, or the contents are already saved in
+     * the service.
+     */
     __publicField(this, "defer");
+    /**
+     * This property will store the contents of the file once it is read.
+     */
     __publicField(this, "contents");
+    /**
+     * The absolute path to the package.json file.
+     */
     __publicField(this, "filepath");
@@ -53,2 +68,5 @@ const usePathUtils = deps.get(inject, "pathUtils", () => (0, import_path_utils.pathUtils)());
   }
+  /**
+   * Gets the contents of the implementation's package.json file.
+   */
   async get() {
@@ -63,2 +81,5 @@ if (this.contents)
   }
+  /**
+   * Synchronously gets the contents of the implementation's package.json file.
+   */
   getSync() {
@@ -70,2 +91,8 @@ if (this.contents)
   }
+  /**
+   * This is a helper that takes care of updating the property with the file contents, and
+   * if the deferred promise exists, resolve it and delete it.
+   *
+   * @param contents  The contents of the package.json file.
+   */
   updateContents(contents) {
@@ -72,0 +99,0 @@ this.contents = JSON.parse(contents);

dist/esm/index.js

@@ -15,4 +15,15 @@ var __defProp = Object.defineProperty;
   constructor({ inject = {} } = {}) {
+    /**
+     * A deferred promise that resolves when the package.json file is read. It will be
+     * `undefined` if the file hasn't been read yet, or the contents are already saved in
+     * the service.
+     */
     __publicField(this, "defer");
+    /**
+     * This property will store the contents of the file once it is read.
+     */
     __publicField(this, "contents");
+    /**
+     * The absolute path to the package.json file.
+     */
     __publicField(this, "filepath");
@@ -22,2 +33,5 @@ const usePathUtils = deps.get(inject, "pathUtils", () => pathUtils());
   }
+  /**
+   * Gets the contents of the implementation's package.json file.
+   */
   async get() {
@@ -32,2 +46,5 @@ if (this.contents)
   }
+  /**
+   * Synchronously gets the contents of the implementation's package.json file.
+   */
   getSync() {
@@ -39,2 +56,8 @@ if (this.contents)
   }
+  /**
+   * This is a helper that takes care of updating the property with the file contents, and
+   * if the deferred promise exists, resolve it and delete it.
+   *
+   * @param contents  The contents of the package.json file.
+   */
   updateContents(contents) {
@@ -41,0 +64,0 @@ this.contents = JSON.parse(contents);

dist/index.js

@@ -22,2 +22,6 @@ "use strict";
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
@@ -46,4 +50,15 @@ mod
   constructor({ inject = {} } = {}) {
+    /**
+     * A deferred promise that resolves when the package.json file is read. It will be
+     * `undefined` if the file hasn't been read yet, or the contents are already saved in
+     * the service.
+     */
     __publicField(this, "defer");
+    /**
+     * This property will store the contents of the file once it is read.
+     */
     __publicField(this, "contents");
+    /**
+     * The absolute path to the package.json file.
+     */
     __publicField(this, "filepath");
@@ -53,2 +68,5 @@ const usePathUtils = deps.get(inject, "pathUtils", () => (0, import_path_utils.pathUtils)());
   }
+  /**
+   * Gets the contents of the implementation's package.json file.
+   */
   async get() {
@@ -63,2 +81,5 @@ if (this.contents)
   }
+  /**
+   * Synchronously gets the contents of the implementation's package.json file.
+   */
   getSync() {
@@ -70,2 +91,8 @@ if (this.contents)
   }
+  /**
+   * This is a helper that takes care of updating the property with the file contents, and
+   * if the deferred promise exists, resolve it and delete it.
+   *
+   * @param contents  The contents of the package.json file.
+   */
   updateContents(contents) {
@@ -72,0 +99,0 @@ this.contents = JSON.parse(contents);

package.json

 {
   "name": "@homer0/package-info",
   "description": "Gets the content of the project's package.json",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "repository": {
@@ -26,12 +26,12 @@ "type": "git",
   "dependencies": {
-    "@homer0/deferred": "^2.0.1",
-    "@homer0/jimple": "^2.0.1",
-    "@homer0/path-utils": "^2.0.1"
+    "@homer0/deferred": "^2.0.2",
+    "@homer0/jimple": "^2.0.2",
+    "@homer0/path-utils": "^2.0.2"
   },
   "devDependencies": {
-    "jest": "^29.4.1",
+    "jest": "^29.4.3",
     "package-json-type": "^1.0.3",
     "ts-jest": "^29.0.5",
-    "tsup": "^6.5.0",
-    "typescript": "^4.9.4"
+    "tsup": "^6.6.3",
+    "typescript": "^4.9.5"
   },
@@ -52,3 +52,3 @@ "engine-strict": true,
   },
-  "gitHead": "59c0f6af6901b9f4edb8d2ec36abaf11f6b0780d"
+  "gitHead": "1ed6ea29e2035f10f0dff60203b6b1d54c601dc8"
 }

No alert changes

Improved metrics

Total package byte prevSize

30501

increased by11.43%

Lines of code

404

increased by23.55%

Dependency changes

• Updated@homer0/deferred@^2.0.2

• Updated@homer0/jimple@^2.0.2

• Updated@homer0/path-utils@^2.0.2