@cluerise/tools 4.2.1 → 5.0.0

package/dist/scripts/update-node-versions/main.js

@@ -9,19 +9,19 @@ class GitProvider {
   static #origins = gitProviderOrigins;
   static #names = Object.keys(this.#origins);
   /**
-   * Checks if the provided name is a valid Git provider name.
+   * Check if the provided name is a valid Git provider name.
    *
-   * @param name - The name of the Git provider to validate.
-   * @returns True if the name is valid, false otherwise.
+   * @param name The name to check.
+   * @returns True if the name is valid, otherwise false.
    */
   static isValidName(name) {
     return this.#names.includes(name);
   }
   /**
-   * Returns a Git provider origin.
+   * Get the origin URL for the given Git provider name.
    *
-   * @param name - The name of the Git provider.
-   * @returns The origin URL of the Git provider.
+   * @param name The Git provider name.
+   * @returns The origin URL.
    */
   static getOrigin(name) {
     return this.#origins[name];
@@ -48,6 +48,13 @@ class PackageJson {
   constructor(data) {
     this.#data = data;
   }
+  /**
+   * Load and parse the `package.json` file, returning a `PackageJson` instance.
+   *
+   * Throws an error if the file is invalid or cannot be parsed.
+   *
+   * @returns A new `PackageJson` instance with parsed data.
+   */
   static async init() {
     const content = await FileSystem.readFile("package.json", { encoding: "utf8" });
     const data = JsonUtils.parse(content);
@@ -60,21 +67,41 @@ class PackageJson {
     return new PackageJson(data);
   }
   /**
-   * Returns the required engines.
+   * Get the package name from `package.json`.
+   *
+   * @returns The package name.
+   */
+  get name() {
+    return this.#data.name;
+  }
+  /**
+   * Get the package version from `package.json`.
+   *
+   * @returns The package version.
+   */
+  get version() {
+    return this.#data.version;
+  }
+  /**
+   * Get the engines field from `package.json`, if present.
+   *
+   * @returns The engines object or undefined.
    */
   get engines() {
     return this.#data.engines;
   }
   /**
-   * Sets the required engines.
+   * Set the engines field in `package.json`.
    *
-   * @param engines - The engines to set.
+   * @param engines The engines object to set.
    */
   set engines(engines) {
     this.#data.engines = engines;
   }
   /**
-   * Returns the repository information.
+   * Get the repository field from `package.json`, if present.
+   *
+   * @returns The repository object or string, or undefined.
    */
   get repository() {
     return this.#data.repository;
@@ -111,9 +138,11 @@ class PackageJson {
     throw new Error("Unsupported repository URL");
   }
   /**
-   * Parses the repository information from package.json.
+   * Parse the repository information from `package.json` and return a `GitRepository` object or null.
+   *
+   * Returns null if no repository is defined or if parsing fails.
    *
-   * @returns The parsed GitRepository or null if no repository is defined.
+   * @returns The parsed `GitRepository`, or null if not available.
    */
   parseGitRepository() {
     if (!this.repository) {
@@ -125,7 +154,7 @@ class PackageJson {
     return this.#parseGitRepository(this.repository.url);
   }
   /**
-   * Saves the package.json file with the current data.
+   * Save the current `package.json` data to disk, formatting it as prettified JSON.
    */
   async save() {
     const content = JsonUtils.prettify(this.#data) + "\n";
@@ -176,7 +205,7 @@ const nodeJsReleaseSchema = z.object({
 class NodeJs {
   static #releasesUrl = "https://nodejs.org/dist/index.json";
   /**
-   * Fetches all Node.js releases.
+   * Fetch all Node.js releases.
    *
    * @returns A promise that resolves to an array of NodeJsRelease objects.
    */
@@ -186,7 +215,7 @@ class NodeJs {
     return z.array(nodeJsReleaseSchema).parse(data);
   }
   /**
-   * Fetches the latest Node.js release.
+   * Fetch the latest Node.js release.
    *
    * @returns A promise that resolves to the latest NodeJsRelease object or null if no releases are found.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cluerise/tools",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "description": "Tools for maintaining TypeScript projects.",
   "author": "Branislav Holý <brano@holy.am>",
   "repository": "github:cluerise/tools",
@@ -31,9 +31,9 @@
     "conventional-changelog-conventionalcommits": "9.0.0",
     "eslint": "9.29.0",
     "eslint-config-prettier": "10.1.5",
-    "eslint-import-resolver-typescript": "4.4.3",
+    "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-prettier": "5.5.0",
+    "eslint-plugin-prettier": "5.5.1",
     "eslint-plugin-simple-import-sort": "12.1.1",
     "eslint-plugin-unicorn": "59.0.1",
     "eslint-plugin-yml": "1.18.0",
@@ -41,7 +41,7 @@
     "globals": "16.2.0",
     "lint-staged": "16.1.2",
     "prettier": "3.6.1",
-    "prettier-plugin-sh": "0.17.4",
+    "prettier-plugin-sh": "0.18.0",
     "semantic-release": "24.2.5",
     "semver": "7.7.2",
     "smol-toml": "1.3.4",