@zityhub/check-updates 0.0.4 → 1.0.0

package/README.md

@@ -0,0 +1,72 @@
+# check-updates
+
+[![npm version](https://img.shields.io/npm/v/@zityhub/check-updates)](https://www.npmjs.com/package/@zityhub/check-updates)
+[![CI](https://github.com/zityhub/check-updates/actions/workflows/ci.yml/badge.svg)](https://github.com/zityhub/check-updates/actions/workflows/ci.yml)
+
+## Installation
+
+Install it as a development dependency:
+
+```sh
+npm install -D @zityhub/check-updates
+```
+
+Or run it directly using [npx](https://docs.npmjs.com/cli/v7/commands/npx): 
+
+```sh
+npx @zityhub/check-updates
+```
+
+## Usage
+
+Check if any of your project's dependencies have a major version update:
+
+```sh
+check-updates
+
+2024-10-08T18:32:05.485Z ERROR Job check-updates finished failed
+{
+  "type": {
+    "name": "job",
+    "data": {
+      "jobName": "check-updates",
+      "message": "Major update available for: awilix,jsonpath-plus,stripe"
+    }
+  }
+}
+```
+
+The command will return an error if there are any packages that need a major version update.
+
+## Exclude Packages
+
+You can ignore specific dependencies to ensure the check returns an exit code 0:
+
+```sh
+check-updates --exclude=awilix --exclude=jsonpath-plus --exclude=stripe
+
+2024-10-08T18:34:51.341Z INFO Job check-updates finished success
+{
+  "type": {
+    "name": "job",
+    "data": {
+      "jobName": "check-updates",
+      "message": "Major update available for: awilix,jsonpath-plus,stripe"
+    }
+  }
+}
+```
+
+## Add it as a Script in your Package
+
+It is recommended to add it as a script in your package.json for easier usage:
+
+```json
+{
+  "scripts": {
+    "check-updates": "check-updates"
+  }
+}
+```
+
+

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,94 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const npm_check_updates_1 = require("npm-check-updates");
+const process = __importStar(require("node:process"));
+const info = (title, message) => {
+    process.stdout.write(`${new Date().toISOString()} \x1b[102mINFO\x1b[0m \x1b[34m${title}\x1b[0m\n${JSON.stringify(message, null, 2)}\n`);
+};
+const error = (title, message) => {
+    process.stderr.write(`${new Date().toISOString()} \x1b[41mERROR\x1b[0m \x1b[34m${title}\x1b[0m\n${JSON.stringify(message, null, 2)}\n`);
+};
+const parseArguments = (args) => {
+    const exclude = [];
+    args.forEach((arg) => {
+        const [key, value] = arg.split('=');
+        if (key.startsWith('--exclude') && value)
+            exclude.push(value);
+    });
+    return exclude;
+};
+const hasVersion = (version) => {
+    return version !== undefined && version !== null;
+};
+const packagesToUpdate = () => __awaiter(void 0, void 0, void 0, function* () {
+    const upgraded = (yield (0, npm_check_updates_1.run)({
+        filterResults: (packageName, { currentVersionSemver, upgradedVersionSemver }) => {
+            var _a;
+            const currentMajor = parseInt((_a = currentVersionSemver[0]) === null || _a === void 0 ? void 0 : _a.major, 10);
+            const upgradedMajor = parseInt(upgradedVersionSemver === null || upgradedVersionSemver === void 0 ? void 0 : upgradedVersionSemver.major, 10);
+            if (hasVersion(currentMajor) && hasVersion(upgradedMajor))
+                return currentMajor !== upgradedMajor;
+            return true;
+        }
+    }));
+    return Object.keys(upgraded);
+});
+const main = (exclude) => __awaiter(void 0, void 0, void 0, function* () {
+    const packages = yield packagesToUpdate();
+    const toUpdate = packages.filter((packageName) => !exclude.includes(packageName));
+    const message = `Major update available for: ${packages.join(',')}`;
+    if (toUpdate.length)
+        return Promise.reject(message);
+    return Promise.resolve(packages.length ? message : undefined);
+});
+main(parseArguments(process.argv.slice(2)))
+    .then((message) => {
+    info('Job check-updates finished success', {
+        type: {
+            name: 'job',
+            data: Object.assign({ jobName: 'check-updates' }, (message && { message }))
+        }
+    });
+    process.exit(0);
+})
+    .catch((err) => {
+    error('Job check-updates finished failed', {
+        type: {
+            name: 'job',
+            data: { jobName: 'check-updates', message: err }
+        }
+    });
+    process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zityhub/check-updates",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "author": "Zityhub",
   "license": "MIT",
   "description": "Project that checks if your project has any dependencies that have been updated with a major version.",