@clerc/plugin-update-notifier 0.0.1 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,11 @@
 # @clerc/plugin-update-notifier
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+[![NPM version](https://img.shields.io/npm/v/@clerc/plugin-update-notifier?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/plugin-update-notifier)
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Documenation
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+Read the [documentation](https://clerc.so1ve.dev/official-plugins/plugin-update-notifier.html) for more details.
 
-## Purpose
+## 📝 License
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@clerc/plugin-update-notifier`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+[MIT](../../LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+import { Plugin } from "@clerc/core";
+import { NotifyOptions, Settings, UpdateNotifier } from "update-notifier";
+import { PartialRequired } from "@clerc/utils";
+
+//#region src/types.d.ts
+type CustomMessage = string | ((notifier: UpdateNotifier) => string);
+type EnhancedNotifierSettings = PartialRequired<Settings, "pkg">;
+type EnhancedNotifyOptions = Omit<NotifyOptions, "message"> & {
+  message?: CustomMessage;
+};
+//#endregion
+//#region src/index.d.ts
+interface UpdateNotifierPluginOptions extends EnhancedNotifierSettings {
+  notify?: EnhancedNotifyOptions;
+}
+declare module "@clerc/core" {
+  interface ContextStore {
+    /**
+    * The update-notifier instance, available if plugin-update-notifier is
+    * used.
+    */
+    updateNotifier?: UpdateNotifier;
+  }
+}
+/**
+* Plugin to check for CLI updates using update-notifier.
+*
+* @example
+*
+* ```ts
+* import { Clerc } from "@clerc/core";
+* import { updateNotifierPlugin } from "@clerc/plugin-update-notifier";
+* import pkg from "./package.json";
+*
+* Clerc.create().use(updateNotifierPlugin({ pkg })).parse();
+* ```
+*/
+declare const updateNotifierPlugin: ({
+  notify: notifySettings,
+  ...notifierSettings
+}: UpdateNotifierPluginOptions) => Plugin;
+//#endregion
+export { UpdateNotifierPluginOptions, updateNotifierPlugin };

package/dist/index.mjs

@@ -0,0 +1,41 @@
+import { definePlugin } from "@clerc/core";
+import updateNotifier from "update-notifier";
+
+//#region src/index.ts
+/**
+* Plugin to check for CLI updates using update-notifier.
+*
+* @example
+*
+* ```ts
+* import { Clerc } from "@clerc/core";
+* import { updateNotifierPlugin } from "@clerc/plugin-update-notifier";
+* import pkg from "./package.json";
+*
+* Clerc.create().use(updateNotifierPlugin({ pkg })).parse();
+* ```
+*/
+const updateNotifierPlugin = ({ notify: notifySettings, ...notifierSettings }) => definePlugin({ setup: (cli) => {
+	const notifier = updateNotifier(notifierSettings);
+	cli.store.updateNotifier = notifier;
+	cli.interceptor({
+		enforce: "pre",
+		handler: async (ctx, next) => {
+			showNotification(notifier, notifySettings);
+			await next();
+		}
+	});
+} });
+function showNotification(notifier, notifySettings) {
+	if (notifier.update) {
+		if (typeof notifySettings?.message === "function") notifySettings.message = notifySettings.message(notifier);
+		notifier.notify({
+			defer: false,
+			...notifySettings,
+			message: notifySettings?.message
+		});
+	}
+}
+
+//#endregion
+export { updateNotifierPlugin };

package/package.json

@@ -1,10 +1,52 @@
 {
   "name": "@clerc/plugin-update-notifier",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @clerc/plugin-update-notifier",
+  "version": "1.1.0",
+  "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
+  "type": "module",
+  "description": "Clerc plugin for checking CLI updates",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "args",
+    "arguments",
+    "argv",
+    "clerc",
+    "clerc-plugin",
+    "cli",
+    "terminal",
+    "update",
+    "notifier"
+  ],
+  "homepage": "https://github.com/clercjs/clerc/tree/main/packages/plugin-update-notifier#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clercjs/clerc.git",
+    "directory": "/"
+  },
+  "bugs": {
+    "url": "https://github.com/clercjs/clerc/issues"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "update-notifier": "^7.3.1"
+  },
+  "devDependencies": {
+    "@types/update-notifier": "^6.0.8",
+    "@clerc/core": "1.1.0"
+  },
+  "peerDependencies": {
+    "@clerc/core": "*"
+  }
+}