@helpers4/version 2.0.0-alpha.1 → 2.0.0-alpha.10

package/meta/examples.json

@@ -0,0 +1,90 @@
+{
+  "category": "version",
+  "functions": [
+    {
+      "name": "compare",
+      "examples": [
+        {
+          "title": "Compare two semver versions",
+          "description": "Returns -1, 0, or 1 based on SemVer ordering.",
+          "code": "compare('1.0.0', '2.0.0') // => -1\ncompare('1.0.0', '1.0.0') // => 0\ncompare('2.0.0', '1.0.0') // => 1"
+        },
+        {
+          "title": "Prerelease is lower than release",
+          "description": "A prerelease version is always less than the release.",
+          "code": "compare('1.0.0-alpha', '1.0.0')\n// => -1"
+        }
+      ]
+    },
+    {
+      "name": "increment",
+      "examples": [
+        {
+          "title": "Increment the patch version",
+          "description": "Bumps the patch number while keeping major and minor.",
+          "code": "increment('1.2.3', 'patch')\n// => '1.2.4'"
+        },
+        {
+          "title": "Increment the minor version",
+          "description": "Bumps the minor number and resets patch to 0.",
+          "code": "increment('1.2.3', 'minor')\n// => '1.3.0'"
+        },
+        {
+          "title": "Preserve the v prefix",
+          "description": "The v prefix is preserved if present in the input.",
+          "code": "increment('v1.0.0', 'major')\n// => 'v2.0.0'"
+        }
+      ]
+    },
+    {
+      "name": "parse",
+      "examples": [
+        {
+          "title": "Parse a semver string",
+          "description": "Breaks a semantic version string into its components.",
+          "code": "parse('1.2.3')\n// => { major: 1, minor: 2, patch: 3, prerelease: [], build: [] }"
+        },
+        {
+          "title": "Parse a prerelease version",
+          "description": "Handles prerelease identifiers and optional v prefix.",
+          "code": "parse('v2.0.0-alpha.1')\n// => { major: 2, minor: 0, patch: 0, prerelease: ['alpha', '1'], build: [] }"
+        }
+      ]
+    },
+    {
+      "name": "satisfiesRange",
+      "examples": [
+        {
+          "title": "Check caret range",
+          "description": "Caret (^) allows patch and minor updates within the same major.",
+          "code": "satisfiesRange('1.2.3', '^1.0.0')\n// => true"
+        },
+        {
+          "title": "Check greater-than-or-equal range",
+          "description": "The >= operator checks if the version is at least the specified value.",
+          "code": "satisfiesRange('2.0.0', '>=1.5.0')\n// => true"
+        },
+        {
+          "title": "Out of range",
+          "description": "Returns false when the version does not satisfy the range.",
+          "code": "satisfiesRange('0.9.0', '>=1.0.0')\n// => false"
+        }
+      ]
+    },
+    {
+      "name": "stripV",
+      "examples": [
+        {
+          "title": "Remove v prefix from a version string",
+          "description": "Strips the leading \"v\" from a git tag-style version string.",
+          "code": "stripV('v1.2.3')\n// => '1.2.3'"
+        },
+        {
+          "title": "No-op when there is no v prefix",
+          "description": "Returns the string unchanged when it does not start with \"v\".",
+          "code": "stripV('1.2.3')\n// => '1.2.3'"
+        }
+      ]
+    }
+  ]
+}

package/meta/licenses.json

@@ -0,0 +1,4 @@
+{
+  "category": "version",
+  "dependencies": []
+}

package/package.json

@@ -1,36 +1,47 @@
 {
   "name": "@helpers4/version",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.10",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for version.",
   "author": "baxyz <baxy@etik.com>",
-  "license": "AGPL-3.0",
+  "license": "LGPL-3.0",
+  "homepage": "https://helpers4.dev/typescript/categories/version/",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/helpers4/helpers4.git"
+    "url": "git+https://github.com/helpers4/typescript.git"
   },
   "type": "module",
+  "sideEffects": false,
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
       "import": "./lib/index.js"
-    }
+    },
+    "./meta/api.json": "./meta/api.json",
+    "./meta/examples.json": "./meta/examples.json",
+    "./meta/licenses.json": "./meta/licenses.json",
+    "./package.json": "./package.json"
   },
   "keywords": [
     "helpers",
     "version",
     "compare",
-    "stripV",
+    "increment",
+    "parse",
     "satisfiesRange",
-    "increment"
+    "stripV"
   ],
   "files": [
     "lib/index.js",
     "lib/index.d.ts",
     "lib/index.js.map",
+    "meta/",
     "LICENSE.md",
     "package.json",
     "README.md"
-  ]
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  }
 }