pkg-json-to-md 1.0.0

package/README.md

@@ -0,0 +1,32 @@
+# pkg-json-to-md
+
+Do `npx pkgtbl` inside a folder with `package.json`, get Markdown table.
+
+Example:
+
+**prodDependencies table:**
+| name                      | current version | available version |
+| ------------------------- | --------------- | ----------------- |
+| 🔴 @redis/client          | 1.6.0           | 5.0.1             |
+| 🟡 dotenv                 | 16.4.5          | 16.5.0            |
+| 🔴 express                | 4.21.2          | 5.1.0             |
+| 🟢 imdb-watchlist-scraper | 2.0.4           | 2.0.4             |
+| 🟢 knex                   | 3.1.0           | 3.1.0             |
+| 🟡 mysql2                 | 3.11.3          | 3.14.1            |
+| 🟢 nouislider             | 15.8.1          | 15.8.1            |
+| 🟢 object-hash            | 3.0.0           | 3.0.0             |
+
+**prodDependencies summary:**
+| total | major | minor/patch |
+| ----- | ----- | ----------- |
+| 4     | 2     | 2           |
+
+**devDependencies table:**
+| name           | current version | available version |
+| -------------- | --------------- | ----------------- |
+| 🟡 @types/node | 22.7.4          | 22.15.15          |
+
+**devDependencies summary:**
+| total | major | minor/patch |
+| ----- | ----- | ----------- |
+| 1     | 1     | 0           |

package/index.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+
+import { markdownTable } from "markdown-table";
+import { exec } from "child_process";
+import { promisify } from "util";
+import { cwd } from "process";
+const execAsync = promisify(exec);
+
+const baseTable = [["name", "current version", "available version"]];
+
+async function getDependencies() {
+  const { stdout } = await execAsync(`npm pkg get --json=true`);
+  const deps = JSON.parse(stdout);
+  const prodDependencies = deps.dependencies;
+  const devDependencies = deps.devDependencies;
+
+  const currentDependencies = await getCurrentVersions();
+
+  for (const [key, value] of Object.entries(currentDependencies)) {
+    prodDependencies[key]
+      ? (prodDependencies[key] = value.version)
+      : (devDependencies[key] = value.version);
+  }
+
+  return { prodDependencies, devDependencies };
+}
+
+async function getLatestVersion(pkgName) {
+  const { stdout } = await execAsync(`npm view ${pkgName} version`);
+
+  return stdout.trim();
+}
+
+async function buildTable(dependencies) {
+  const table = [...baseTable];
+
+  let info = { majorDep: 0, minorDep: 0 };
+
+  for (const [name, version] of Object.entries(dependencies)) {
+    const currentVersion = version;
+    const latestVersion = await getLatestVersion(name);
+
+    if (currentVersion == latestVersion) {
+      table.push(["🟢 " + name, currentVersion, latestVersion]);
+      continue;
+    }
+
+    const currentMajorVer = currentVersion.split(".")[0];
+    const latestMajorVer = latestVersion.split(".")[0];
+
+    const isMajorDiff = currentMajorVer == latestMajorVer;
+    isMajorDiff ? info.majorDep++ : info.minorDep++;
+    const symbol = isMajorDiff ? "🟡 " : "🔴 ";
+
+    table.push([symbol + name, currentVersion, latestVersion]);
+  }
+
+  const totalMissing = info.majorDep + info.minorDep;
+  if (totalMissing) {
+    info = markdownTable([
+      ["total", "major", "minor/patch"],
+      [totalMissing, info.majorDep, info.minorDep],
+    ]);
+  } else {
+    info = null;
+  }
+
+  return { table: markdownTable(table), info };
+}
+
+async function getCurrentVersions() {
+  const { stdout } = await execAsync(`npm list --depth=0 --json`);
+
+  return JSON.parse(stdout).dependencies;
+}
+
+async function main() {
+  const { prodDependencies, devDependencies } = await getDependencies();
+
+  const [prodDependenciesTable, devDependenciesTable] = await Promise.all([
+    buildTable(prodDependencies),
+    buildTable(devDependencies),
+  ]);
+
+  console.log(`**prodDependencies table:**\n${prodDependenciesTable.table}\n`);
+  console.log(
+    `**prodDependencies summary:**\n${
+      prodDependenciesTable.info
+        ? prodDependenciesTable.info
+        : "\n✅ All dependencies up to date!"
+    }\n`
+  );
+  console.log(`**devDependencies table:**\n${devDependenciesTable.table}\n`);
+  console.log(
+    `**devDependencies summary:**\n${
+      devDependenciesTable.info
+        ? devDependenciesTable.info
+        : "\n✅ All dependencies up to date!"
+    }\n`
+  );
+}
+
+main();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "pkg-json-to-md",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "pkgtbl": "./index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RasmusKard/pkg-json-to-md.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/RasmusKard/pkg-json-to-md/issues"
+  },
+  "homepage": "https://github.com/RasmusKard/pkg-json-to-md#readme",
+  "dependencies": {
+    "markdown-table": "^3.0.4"
+  }
+}