@code-pushup/js-packages-plugin 0.35.0 → 0.39.0

package/README.md

@@ -22,7 +22,21 @@ It supports the following package managers:
 
 1. If you haven't already, install [@code-pushup/cli](../cli/README.md) and create a configuration file.
 
-2. Insert plugin configuration with your package manager. By default, both `audit` and `outdated` checks will be run. The result should look as follows:
+2. Install as a dev dependency with your package manager:
+
+   ```sh
+   npm install --save-dev @code-pushup/js-packages-plugin
+   ```
+
+   ```sh
+   yarn add --dev @code-pushup/js-packages-plugin
+   ```
+
+   ```sh
+   pnpm add --save-dev @code-pushup/js-packages-plugin
+   ```
+
+3. Insert plugin configuration with your package manager. By default, both `audit` and `outdated` checks will be run. The result should look as follows:
 
    ```js
    import jsPackagesPlugin from '@code-pushup/js-packages-plugin';
@@ -50,7 +64,7 @@ It supports the following package managers:
    };
    ```
 
-3. (Optional) Reference individual audits or the provided plugin groups which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
+4. (Optional) Reference individual audits or the provided plugin groups which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
 
    💡 Assign weights based on what influence each command should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
 
@@ -88,7 +102,7 @@ It supports the following package managers:
    };
    ```
 
-4. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
+5. Run the CLI with `npx code-pushup collect` and view or upload report (refer to [CLI docs](../cli/README.md)).
 
 ## Plugin architecture
 

package/bin.js

@@ -578,10 +578,14 @@ function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
     { description }
   );
 }
-var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableMetaSchema = z14.object({
+  slug: slugSchema,
+  title: titleSchema,
+  docsUrl: docsUrlSchema
+});
 var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
   z14.object({
-    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+    plugin: pluginMetaSchema.pick({ slug: true, title: true, docsUrl: true }).describe("Plugin which defines it")
   })
 );
 var scorableDiffSchema = scorableMetaSchema.merge(
@@ -725,7 +729,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    ui().logger.error(error.message);
+    ui().logger.info(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -1377,8 +1381,8 @@ function outdatedResultToAuditOutput(result, packageManager, depGroup) {
   const relevantDependencies = result.filter(
     (dep) => dep.type === dependencyGroupToLong[depGroup]
   );
-  const outdatedDependencies = relevantDependencies.filter(
-    (dep) => dep.current !== dep.latest
+  const outdatedDependencies = relevantDependencies.filter((dep) => dep.current !== dep.latest).filter(
+    (dep) => dep.current.split("-")[0]?.toString() !== dep.latest.split("-")[0]?.toString()
   );
   const outdatedStats = outdatedDependencies.reduce(
     (acc, dep) => {
@@ -1444,7 +1448,8 @@ function getOutdatedLevel(currentFullVersion, latestFullVersion) {
   throw new Error("Package is not outdated.");
 }
 function splitPackageVersion(fullVersion) {
-  const [major, minor, patch] = fullVersion.split(".").map(Number);
+  const semanticVersion = String(fullVersion.split("-")[0]);
+  const [major, minor, patch] = semanticVersion.split(".").map(Number);
   if (major == null || minor == null || patch == null) {
     throw new Error(`Invalid version description ${fullVersion}`);
   }

package/index.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 
 // packages/plugin-js-packages/package.json
 var name = "@code-pushup/js-packages-plugin";
-var version = "0.35.0";
+var version = "0.39.0";
 
 // packages/plugin-js-packages/src/lib/config.ts
 import { z as z15 } from "zod";
@@ -585,10 +585,14 @@ function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
     { description }
   );
 }
-var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableMetaSchema = z14.object({
+  slug: slugSchema,
+  title: titleSchema,
+  docsUrl: docsUrlSchema
+});
 var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
   z14.object({
-    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+    plugin: pluginMetaSchema.pick({ slug: true, title: true, docsUrl: true }).describe("Plugin which defines it")
   })
 );
 var scorableDiffSchema = scorableMetaSchema.merge(
@@ -798,7 +802,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    ui().logger.error(error.message);
+    ui().logger.info(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@code-pushup/js-packages-plugin",
-  "version": "0.35.0",
+  "version": "0.39.0",
   "dependencies": {
-    "@code-pushup/models": "0.35.0",
-    "@code-pushup/utils": "0.35.0",
+    "@code-pushup/models": "0.39.0",
+    "@code-pushup/utils": "0.39.0",
     "zod": "^3.22.4"
   },
   "license": "MIT",