update tsconfig
This commit is contained in:
parent
7a0de33b46
commit
5f87891de0
|
|
@ -9,12 +9,20 @@
|
|||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartversion",
|
||||
"description": "handle semver with ease",
|
||||
"description": "A library to handle semantic versioning with ease.",
|
||||
"npmPackagename": "@push.rocks/smartversion",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"semantic versioning",
|
||||
"semver",
|
||||
"version management",
|
||||
"npm package",
|
||||
"version comparison",
|
||||
"typescript"
|
||||
]
|
||||
}
|
||||
},
|
||||
"tsdocs": {
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis 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. \n\n**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.\n\n### Trademarks\n\nThis 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.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
|
||||
}
|
||||
}
|
||||
14
package.json
14
package.json
|
|
@ -2,7 +2,7 @@
|
|||
"name": "@push.rocks/smartversion",
|
||||
"version": "3.0.5",
|
||||
"private": false,
|
||||
"description": "handle semver with ease",
|
||||
"description": "A library to handle semantic versioning with ease.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
|
|
@ -46,5 +46,13 @@
|
|||
"bugs": {
|
||||
"url": "https://gitlab.com/push.rocks/smartversion/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/push.rocks/smartversion#readme"
|
||||
}
|
||||
"homepage": "https://gitlab.com/push.rocks/smartversion#readme",
|
||||
"keywords": [
|
||||
"semantic versioning",
|
||||
"semver",
|
||||
"version management",
|
||||
"npm package",
|
||||
"version comparison",
|
||||
"typescript"
|
||||
]
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
|
||||
144
readme.md
144
readme.md
|
|
@ -1,40 +1,132 @@
|
|||
# @push.rocks/smartversion
|
||||
handle semver with ease
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartversion)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartversion)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartversion)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartversion/)
|
||||
## Install
|
||||
|
||||
## Status for master
|
||||
To incorporate `@push.rocks/smartversion` into your project, run the following command using npm:
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
```bash
|
||||
npm install @push.rocks/smartversion --save
|
||||
```
|
||||
|
||||
Or if you prefer using Yarn:
|
||||
|
||||
```bash
|
||||
yarn add @push.rocks/smartversion
|
||||
```
|
||||
|
||||
This will add it to your project's dependencies.
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
`@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.
|
||||
|
||||
### Importing the module
|
||||
|
||||
## Contribution
|
||||
Begin by importing `SmartVersion` from the package:
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
```typescript
|
||||
import { SmartVersion } from '@push.rocks/smartversion';
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
### Creating a SmartVersion instance
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
You can instantiate `SmartVersion` with a semver string:
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
```typescript
|
||||
const version = new SmartVersion('1.0.0');
|
||||
console.log(version.versionString); // Outputs: '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`:
|
||||
|
||||
```typescript
|
||||
const fuzzyVersion = SmartVersion.fromFuzzyString('^1.0.0');
|
||||
console.log(fuzzyVersion.versionString); // Outputs the minimum version satisfying the fuzzy string
|
||||
```
|
||||
|
||||
### Accessing Parts of the Version
|
||||
|
||||
The major, minor, and patch components are accessible as properties:
|
||||
|
||||
```typescript
|
||||
console.log(version.major); // Outputs: 1
|
||||
console.log(version.minor); // Outputs: 0
|
||||
console.log(version.patch); // Outputs: 0
|
||||
```
|
||||
|
||||
### Comparing Versions
|
||||
|
||||
You can compare the instance to another `SmartVersion` instance or a semver string to determine if it's greater or lesser:
|
||||
|
||||
```typescript
|
||||
const version1 = new SmartVersion('1.2.3');
|
||||
const version2 = new SmartVersion('2.0.0');
|
||||
|
||||
console.log(version1.greaterThan(version2)); // Outputs: false
|
||||
console.log(version1.lessThan(version2)); // Outputs: true
|
||||
|
||||
console.log(version1.greaterThanString('1.2.2')); // Outputs: true
|
||||
console.log(version1.lessThanString('2.1.0')); // Outputs: true
|
||||
```
|
||||
|
||||
### Getting a Best Match
|
||||
|
||||
For an array of available versions, to find the best match for the given version or 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
|
||||
```
|
||||
|
||||
### Getting New Versions
|
||||
|
||||
You can also easily increment the version to get a new `SmartVersion` instance of the next major, minor, or patch version:
|
||||
|
||||
```typescript
|
||||
const newPatchVersion = version.getNewPatchVersion();
|
||||
console.log(newPatchVersion.versionString); // Outputs: '1.0.1'
|
||||
|
||||
const newMinorVersion = version.getNewMinorVersion();
|
||||
console.log(newMinorVersion.versionString); // Outputs: '1.1.0'
|
||||
|
||||
const newMajorVersion = version.getNewMajorVersion();
|
||||
console.log(newMajorVersion.versionString); // Outputs: '2.0.0'
|
||||
```
|
||||
|
||||
### Dynamic Version Updates
|
||||
|
||||
For dynamic updates or operations based on conditions:
|
||||
|
||||
```typescript
|
||||
const updateType = 'minor'; // Example condition
|
||||
const updatedVersion = version.getNewVersion(updateType);
|
||||
console.log(updatedVersion.versionString); // Outputs: '1.1.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.
|
||||
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
> 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.
|
||||
|
||||
## 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.
|
||||
|
||||
**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.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
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.
|
||||
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user