push.rocks/smartupdate
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tsconfig

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 18:30:39 +02:00
parent 586db93aa3
commit f56c9bc371
4 changed files with 112 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
npmextra.json
View File

@ -9,12 +9,24 @@
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartupdate",
"description": "update your tools in a smart way",
"description": "A library designed to facilitate smarter update notifications and checking for Node.js projects.",
"npmPackagename": "@push.rocks/smartupdate",
"license": "MIT"
"license": "MIT",
"keywords": [
"update notifications",
"version checking",
"npm package updates",
"version comparison",
"CLI tool updates",
"dependency management",
"npm registry",
"typescript utilities",
"software maintenance",
"open-source contribution"
]
}
},
"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"
}
}

16
package.json
View File

@ -2,7 +2,7 @@
"name": "@push.rocks/smartupdate",
"version": "2.0.6",
"private": false,
"description": "update your tools in a smart way",
"description": "A library designed to facilitate smarter update notifications and checking for Node.js projects.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
@ -42,5 +42,17 @@
],
"browserslist": [
"last 1 chrome versions"
],
"keywords": [
"update notifications",
"version checking",
"npm package updates",
"version comparison",
"CLI tool updates",
"dependency management",
"npm registry",
"typescript utilities",
"software maintenance",
"open-source contribution"
]
}
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

116
readme.md
View File

@ -1,51 +1,99 @@
# @push.rocks/smartupdate
update your tools in a smart way
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartupdate)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartupdate)
* [github.com (source mirror)](https://github.com/push.rocks/smartupdate)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartupdate/)
## Install
To get started with `@push.rocks/smartupdate`, you need to install it via npm. Run the following command in your terminal:
## Status for master
```bash
npm install @push.rocks/smartupdate --save
```
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartupdate/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartupdate/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartupdate)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartupdate)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartupdate)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartupdate)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartupdate)](https://lossless.cloud)
This will add `@push.rocks/smartupdate` as a dependency to your project and download it to your `node_modules` folder.
## Usage
Use TypeScript for best in class instellisense.
The `@push.rocks/smartupdate` module offers a smart way to notify users of your CLI tools or libraries about new versions available on npm. Let's take a closer look at how you can utilize it in your project using TypeScript.
smartupdate makes it really easy to notify your tool users about new versions:
### Importing and Instantiating `SmartUpdate`
First, you need to import the `SmartUpdate` class from the `@push.rocks/smartupdate` package and create an instance of it. You can optionally pass settings to the constructor to customize its behavior:
```typescript
import * as smartupdate from 'smartupdate';
import { SmartUpdate } from '@push.rocks/smartupdate';
// the following command will check npm for a version newer than the specified one.
// It will open the specified URL if a newer version is actually found.
await smartupdate.standardHandler.check(
'lodash',
'1.0.5',
'http://gitzone.gitlab.io/npmts/changelog.html'
);
const smartUpdate = new SmartUpdate();
```
## Contribution
### Checking for Updates
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). :)
To check for an update for a specific npm package, you can use the `check` method. This method requires the npm package name, the current local version of the package you are checking against, and optionally, a URL to the changelog. If a newer version is found, it will log a message to the console and, if a changelog URL is provided and not running in a CI environment, attempt to open the changelog in the default web browser.
For further information read the linked docs at the top of this readme.
Here’s an example:
## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
// Async function to demonstrate usage
async function checkForUpdates() {
const npmPackageName = 'some-npm-package';
const currentVersion = '1.0.0';
const changelogUrl = 'https://example.com/changelog';
// Check for an update for 'some-npm-package'
const hasNewerVersion = await smartUpdate.check(npmPackageName, currentVersion, changelogUrl);
if (hasNewerVersion) {
console.log('A newer version is available. Please consider updating.');
} else {
console.log('You are using the latest version.');
}
}
// Execute the function
checkForUpdates().catch(console.error);
```
### Checking for CLI Updates
For CLI applications, `@push.rocks/smartupdate` offers a more tailored method called `checkForCli`. This method works similarly to `check` but is optimized for CLI tools, taking into account factors like avoiding frequent checks (e.g., not more than once per hour).
Example usage:
```typescript
// Async function to demonstrate CLI update checks
async function checkCliUpdates() {
const cliPackageName = 'your-cli-tool';
const currentCliVersion = '0.1.0';
const changelogUrl = 'https://example.com/cli-changelog';
const needsUpdate = await smartUpdate.checkForCli(cliPackageName, currentCliVersion, changelogUrl);
if (needsUpdate) {
console.log(`A newer version of ${cliPackageName} is available. Visit ${changelogUrl} for more information.`);
} else {
console.log(`You are using the latest version of ${cliPackageName}.`);
}
}
// Run the CLI update check
checkCliUpdates().catch(console.error);
```
By integrating `@push.rocks/smartupdate` into your project, you ensure users are always informed about the latest updates, encouraging them to keep their installations current and benefiting from new features, performance improvements, and bug fixes.
## 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.