feat: add compareVersions, update registerMenuCommand

Author: PipecraftNet

.github/workflows/npm-publish.yml

@@ -2,7 +2,7 @@ name: NPM Publish
 on:
   push:
     tags:
-      - '*.*.*'
+      - "*.*.*"
 jobs:
   publish:
     runs-on: ubuntu-latest

lib/index.d.ts

@@ -142,11 +142,19 @@ export function isUrl(text: string | undefined): boolean
 export function throttle(func: Function, interval: number): Function
 
 export type MenuCallback = (event?: MouseEvent | KeyboardEvent) => void
+export type RegisterMenuCommandOptions = {
+  id?: string
+  title?: string
+  autoClose?: boolean
+  // O - Tampermonkey
+  // X - Violentmonkey
+  accessKey?: string
+}
 export function registerMenuCommand(
   name: string,
   callback: MenuCallback,
-  accessKey?: string
-): void
+  options?: RegisterMenuCommandOptions
+): string | undefined
 
 export function extendHistoryApi(): void
 
@@ -195,3 +203,5 @@ export function parseInt10(
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export function createHTML(html: string): string
+
+export function compareVersions(v1: string, v2: string): number

lib/index.js

@@ -499,3 +499,50 @@ const escapeHTMLPolicy =
 export const createHTML = (html) => {
   return escapeHTMLPolicy ? escapeHTMLPolicy.createHTML(html) : html
 }
+
+/**
+ * Compare two semantic version strings
+ * @param {string} v1 - First version string (e.g., "1.2.0")
+ * @param {string} v2 - Second version string (e.g., "1.1.5")
+ * @returns {number} - Returns 1 if v1 > v2, -1 if v1 < v2, 0 if equal
+ * @throws {Error} - Throws error for invalid version strings
+ */
+export function compareVersions(v1, v2) {
+  // Input validation
+  if (typeof v1 !== "string" || typeof v2 !== "string") {
+    throw new TypeError("Version strings must be of type string")
+  }
+
+  if (!v1.trim() || !v2.trim()) {
+    throw new Error("Version strings cannot be empty")
+  }
+
+  // Validate version format (basic semantic versioning)
+  const versionRegex = /^\d+(\.\d+)*$/
+  if (!versionRegex.test(v1) || !versionRegex.test(v2)) {
+    throw new Error(
+      "Invalid version format. Use semantic versioning (e.g., '1.2.3')"
+    )
+  }
+
+  const v1Parts = v1.split(".").map(Number)
+  const v2Parts = v2.split(".").map(Number)
+  const maxLength = Math.max(v1Parts.length, v2Parts.length)
+
+  for (let i = 0; i < maxLength; i++) {
+    const num1 = v1Parts[i] || 0 // Use logical OR for cleaner default assignment
+    const num2 = v2Parts[i] || 0
+
+    if (num1 !== num2) {
+      return num1 > num2 ? 1 : -1 // Simplified comparison
+    }
+  }
+
+  return 0 // Versions are equal
+}
+
+// Usage:
+// console.log(compareVersions("1.2.0", "1.1.5")); // Output: 1
+// console.log(compareVersions("1.0", "1.0.0"));   // Output: 0
+// console.log(compareVersions("2.0", "1.5.10"));  // Output: 1
+// console.log(compareVersions("1.0.0", "1.0.0.1")); // Output: -1

lib/userscript.js

@@ -71,7 +71,7 @@ export const addStyle = (styleText) =>
   addElement(null, "style", { textContent: styleText })
 
 // Only register menu on top frame
-export const registerMenuCommand = (name, callback, accessKey) => {
+export const registerMenuCommand = (name, callback, options) => {
   if (globalThis !== top) {
     return
   }
@@ -81,6 +81,6 @@ export const registerMenuCommand = (name, callback, accessKey) => {
     return
   }
 
-  GM.registerMenuCommand(name, callback, accessKey)
+  return GM.registerMenuCommand(name, callback, options)
 }
 /* eslint-enable new-cap, camelcase */