push.rocks/smartversion
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(tooling): migrate project config and test tooling while hardening fuzzy version parsing

Browse Source
This commit is contained in:
Jürgen Kunz
2026-04-07 16:13:35 +00:00
parent d152a5d684
commit 028bb19a10
9 changed files with 7249 additions and 4812 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
readme.md
View File

@@ -1,132 +1,167 @@
# @push.rocks/smartversion
handle semver with ease
A TypeScript library for handling semantic versioning with ease — parse, compare, match, and bump semver strings through a single ergonomic `SmartVersion` class.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
To incorporate `@push.rocks/smartversion` into your project, run the following command using npm:
Install via your favourite package manager:
```bash
pnpm add @push.rocks/smartversion
# or
npm install @push.rocks/smartversion --save
```
Or if you prefer using Yarn:
The package ships as an **ESM-only** module with TypeScript typings included. It targets modern Node.js and browser runtimes (bundled via esbuild/rollup/etc.).
```bash
yarn add @push.rocks/smartversion
```
## Why SmartVersion?
This will add it to your project's dependencies.
Under the hood `@push.rocks/smartversion` wraps the battle-tested [`semver`](https://www.npmjs.com/package/semver) package, but hides the verbose functional API behind a friendly object-oriented surface. Instead of remembering `semver.gt`, `semver.lt`, `semver.satisfies`, `semver.minVersion`, and manually juggling SemVer instances, you get one class with expressive, strongly typed methods.
## Usage
`@push.rocks/smartversion` offers a comprehensive suite of functionalities to easily manipulate and compare semantic versions (semver). The following documentation assumes that you are familiar with TypeScript and semantic versioning concepts.
All examples are written in TypeScript.
### Importing the module
Begin by importing `SmartVersion` from the package:
### Importing
```typescript
import { SmartVersion } from '@push.rocks/smartversion';
```
### Creating a SmartVersion instance
### Creating a SmartVersion
You can instantiate `SmartVersion` with a semver string:
From a concrete version string:
```typescript
const version = new SmartVersion('1.0.0');
console.log(version.versionString); // Outputs: '1.0.0'
console.log(version.versionString); // '1.0.0'
```
Alternatively, if you have a fuzzy version string (e.g., `"^1.0.0"`, `"~1.2"`), you can use the static method `fromFuzzyString`:
From a fuzzy version string (ranges, carets, tildes, partials):
```typescript
const fuzzyVersion = SmartVersion.fromFuzzyString('^1.0.0');
console.log(fuzzyVersion.versionString); // Outputs the minimum version satisfying the fuzzy string
const fuzzy = SmartVersion.fromFuzzyString('^1.2.0');
console.log(fuzzy.versionString); // '1.2.0' — the minimum version that satisfies the range
```
### Accessing Parts of the Version
`fromFuzzyString` preserves the original range, so `getBestMatch` (below) can use it later to pick from a list of candidates. If the fuzzy string cannot be resolved to a minimum version, `fromFuzzyString` throws with a descriptive error.
The major, minor, and patch components are accessible as properties:
### Reading the parts
```typescript
console.log(version.major); // Outputs: 1
console.log(version.minor); // Outputs: 0
console.log(version.patch); // Outputs: 0
const version = new SmartVersion('2.5.9');
version.major; // 2
version.minor; // 5
version.patch; // 9
version.versionString; // '2.5.9'
```
### Comparing Versions
### Comparing versions
You can compare the instance to another `SmartVersion` instance or a semver string to determine if it's greater or lesser:
Compare against another `SmartVersion` instance or a raw version string:
```typescript
const version1 = new SmartVersion('1.2.3');
const version2 = new SmartVersion('2.0.0');
const a = new SmartVersion('1.2.3');
const b = new SmartVersion('2.0.0');
console.log(version1.greaterThan(version2)); // Outputs: false
console.log(version1.lessThan(version2)); // Outputs: true
a.greaterThan(b); // false
a.lessThan(b); // true
console.log(version1.greaterThanString('1.2.2')); // Outputs: true
console.log(version1.lessThanString('2.1.0')); // Outputs: true
a.greaterThanString('1.2.2'); // true
a.lessThanString('v2.1.0'); // true — leading 'v' is tolerated
```
### Getting a Best Match
### Picking the best match from a list
For an array of available versions, to find the best match for the given version or range:
Given a fuzzy range and a list of available versions, get the highest version that still satisfies the range:
```typescript
const availableVersions = ['1.0.0', '1.2.0', '1.2.3', '2.0.0'];
console.log(version.getBestMatch(availableVersions)); // Outputs the best matching version
const range = SmartVersion.fromFuzzyString('4.x');
const available = ['4.0.1', '4.7.5', '4.3.0', '5.0.0'];
range.getBestMatch(available); // '4.7.5'
```
### Getting New Versions
`getBestMatch` returns `undefined` if nothing in the list satisfies the range — handy for dependency resolution logic.
You can also easily increment the version to get a new `SmartVersion` instance of the next major, minor, or patch version:
### Bumping versions
Every bump returns a fresh `SmartVersion` instance (the original is never mutated):
```typescript
const newPatchVersion = version.getNewPatchVersion();
console.log(newPatchVersion.versionString); // Outputs: '1.0.1'
const current = new SmartVersion('1.2.3');
const newMinorVersion = version.getNewMinorVersion();
console.log(newMinorVersion.versionString); // Outputs: '1.1.0'
const newMajorVersion = version.getNewMajorVersion();
console.log(newMajorVersion.versionString); // Outputs: '2.0.0'
current.getNewPatchVersion().versionString; // '1.2.4'
current.getNewMinorVersion().versionString; // '1.3.0'
current.getNewMajorVersion().versionString; // '2.0.0'
```
### Dynamic Version Updates
### Dynamic bumps
For dynamic updates or operations based on conditions:
When the bump type is only known at runtime (e.g. driven by commit-lint output or a CI flag):
```typescript
const updateType = 'minor'; // Example condition
const updatedVersion = version.getNewVersion(updateType);
console.log(updatedVersion.versionString); // Outputs: '1.1.0'
type BumpKind = 'patch' | 'minor' | 'major';
function bump(version: SmartVersion, kind: BumpKind): SmartVersion {
return version.getNewVersion(kind);
}
bump(new SmartVersion('0.9.5'), 'minor').versionString; // '0.10.0'
```
The `SmartVersion` class and its methods offer a robust solution for managing versions in your projects, enabling you to parse, compare, and manipulate semantic versions programmatically with ease.
`getNewVersion` throws if given an unknown bump type, so you get a loud failure instead of silently producing the wrong version.
This tool is ideal for automated version management in continuous integration / continuous deployment (CI/CD) workflows, package publishing, or anywhere precise version control is needed.
## API reference
For any updates, contributions, or issues, please visit the [GitHub repository](https://github.com/pushrocks/smartversion) or the [npm package page](https://www.npmjs.com/package/@push.rocks/smartversion).
| Member | Kind | Description |
| ----------------------------------------- | --------------- | --------------------------------------------------------------------------- |
| `new SmartVersion(semverString, original?)` | constructor | Create an instance from a concrete version string. |
| `SmartVersion.fromFuzzyString(fuzzy)` | static | Build an instance from a range/fuzzy string. Preserves the range. |
| `version.versionString` | getter | The resolved version string (e.g. `'1.2.3'`). |
| `version.major` / `minor` / `patch` | getter | Individual semver segments as numbers. |
| `version.semver` | property | The underlying `semver.SemVer` instance for escape-hatch use cases. |
| `version.originalVersionString` | property | The original fuzzy string, if `fromFuzzyString` was used. |
| `greaterThan(other)` / `lessThan(other)` | method | Compare to another `SmartVersion`. |
| `greaterThanString(str)` / `lessThanString(str)` | method | Compare to a raw version string. |
| `getBestMatch(candidates)` | method | Pick the highest candidate that satisfies the preserved range. |
| `getNewPatchVersion()` | method | Returns a bumped patch version as a new instance. |
| `getNewMinorVersion()` | method | Returns a bumped minor version as a new instance. |
| `getNewMajorVersion()` | method | Returns a bumped major version as a new instance. |
| `getNewVersion('patch' \| 'minor' \| 'major')` | method | Bump dynamically by type. |
> Note: This documentation aims to provide comprehensive examples and usage scenarios for `@push.rocks/smartversion`. However, the actual use cases might vary depending on the project context or development environment. It is always recommended to test and validate the functionality within your project setup.
## Use cases
`@push.rocks/smartversion` shines whenever you need to reason about versions programmatically:
- **Release automation** — pick the next patch/minor/major in CI pipelines
- **Package management** — resolve a fuzzy dependency range against a real registry list
- **Update checks** — compare the currently installed version to the latest upstream
- **Compatibility gates** — guard features behind `greaterThan` / `lessThan` checks
- **Monorepo tooling** — bulk-bump versions across workspaces based on commit metadata
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
For any legal inquiries or further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.