Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 80e50b7391 | |||
| 14967d6705 | |||
| 2344867da9 | |||
| 4d2349bae1 | |||
| b29dc35c20 | |||
| 37d69e201e | |||
| afa511550d | |||
| e0a9e9702a | |||
| 85f5985249 | |||
| e337241dd6 | |||
| a7a1343e3c | |||
| f54402aa1e | |||
| b7ecd5a6b7 | |||
| ba57be2fe5 | |||
| 2b308e8824 | |||
| 0b1b6deb98 | |||
| d5636aaf9a | |||
| 0276faa949 | |||
| c0d64926a0 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @gitzone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
138
.gitlab-ci.yml
138
.gitlab-ci.yml
@ -1,138 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -6,12 +6,25 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartnpm",
|
||||
"shortDescription": "interface with npm to retrieve package information",
|
||||
"npmPackagename": "@pushrocks/smartnpm",
|
||||
"license": "MIT"
|
||||
"description": "A library to interface with npm for retrieving package information and manipulation.",
|
||||
"npmPackagename": "@push.rocks/smartnpm",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"npm",
|
||||
"package",
|
||||
"information",
|
||||
"registry",
|
||||
"search",
|
||||
"metadata",
|
||||
"version",
|
||||
"dependencies"
|
||||
]
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
26250
package-lock.json
generated
26250
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
60
package.json
60
package.json
@ -1,35 +1,36 @@
|
||||
{
|
||||
"name": "@pushrocks/smartnpm",
|
||||
"version": "1.0.39",
|
||||
"name": "@push.rocks/smartnpm",
|
||||
"version": "2.0.4",
|
||||
"private": false,
|
||||
"description": "interface with npm to retrieve package information",
|
||||
"description": "A library to interface with npm for retrieving package information and manipulation.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web)"
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsrun": "^1.2.12",
|
||||
"@gitzone/tstest": "^1.0.54",
|
||||
"@pushrocks/tapbundle": "^3.2.14",
|
||||
"@types/node": "^15.0.2",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.12",
|
||||
"@types/node": "^20.4.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/consolecolor": "^2.0.1",
|
||||
"@pushrocks/levelcache": "^1.0.10",
|
||||
"@pushrocks/smartarchive": "^2.0.4",
|
||||
"@pushrocks/smartfile": "^8.0.10",
|
||||
"@pushrocks/smartpromise": "^3.1.5",
|
||||
"@pushrocks/smartrequest": "^1.1.51",
|
||||
"@pushrocks/smarttime": "^3.0.38",
|
||||
"@pushrocks/smartversion": "^2.0.7",
|
||||
"package-json": "^6.5.0"
|
||||
"@push.rocks/consolecolor": "^2.0.1",
|
||||
"@push.rocks/levelcache": "^3.0.6",
|
||||
"@push.rocks/smartarchive": "^3.0.6",
|
||||
"@push.rocks/smartfile": "^10.0.28",
|
||||
"@push.rocks/smartpath": "^5.0.11",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrequest": "^2.0.18",
|
||||
"@push.rocks/smarttime": "^4.0.4",
|
||||
"@push.rocks/smartversion": "^3.0.2",
|
||||
"package-json": "^8.1.1"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -45,5 +46,20 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
],
|
||||
"keywords": [
|
||||
"npm",
|
||||
"package",
|
||||
"information",
|
||||
"registry",
|
||||
"search",
|
||||
"metadata",
|
||||
"version",
|
||||
"dependencies"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartnpm",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartnpm.git"
|
||||
}
|
||||
}
|
||||
5228
pnpm-lock.yaml
generated
Normal file
5228
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
128
readme.md
128
readme.md
@ -1,39 +1,109 @@
|
||||
# @pushrocks/smartnpm
|
||||
# @push.rocks/smartnpm
|
||||
interface with npm to retrieve package information
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartnpm)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartnpm)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartnpm)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartnpm/)
|
||||
|
||||
## Status for master
|
||||
|
||||
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)
|
||||
## Install
|
||||
To install `@push.rocks/smartnpm`, open your terminal and run the following command:
|
||||
```sh
|
||||
npm install @push.rocks/smartnpm --save
|
||||
```
|
||||
This will add `@push.rocks/smartnpm` as a dependency to your project and you're ready to start using it.
|
||||
|
||||
## Usage
|
||||
To use `@push.rocks/smartnpm` in your project, you first need to import it in your TypeScript files. `@push.rocks/smartnpm` provides a powerful interface to interact with npm to retrieve package information, handle package downloads, and more. Below are examples showcasing how to leverage some of its features in real-world scenarios.
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
### Initialize the NpmRegistry
|
||||
Before you can retrieve any package information or perform actions such as downloading packages, you need to create an instance of `NpmRegistry`. This acts as your starting point.
|
||||
|
||||
## Contribution
|
||||
```typescript
|
||||
import { NpmRegistry } from '@push.rocks/smartnpm';
|
||||
|
||||
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). :)
|
||||
const npmRegistry = new NpmRegistry();
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
Optionally, you can provide a custom npm registry URL if you're not using the default npm registry:
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
```typescript
|
||||
const customRegistry = new NpmRegistry({
|
||||
npmRegistryUrl: 'https://custom.registry.url'
|
||||
});
|
||||
```
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
### Retrieve Package Information
|
||||
`@push.rocks/smartnpm` allows you to easily get detailed information about a package, including its versions, dist tags, and metadata. Here's how you can get information about a specific package:
|
||||
|
||||
```typescript
|
||||
async function getPackageInfo() {
|
||||
const packageName = 'your-package-name';
|
||||
const packageInfo = await npmRegistry.getPackageInfo(packageName);
|
||||
console.log(packageInfo);
|
||||
}
|
||||
|
||||
getPackageInfo();
|
||||
```
|
||||
|
||||
### Search for Packages
|
||||
You can search for packages using a variety of filters such as keywords, author, maintainer, etc. Here's an example of searching for packages with specific criteria:
|
||||
|
||||
```typescript
|
||||
async function searchPackages() {
|
||||
const searchResults = await npmRegistry.searchOnNpm({
|
||||
keywords: ['webpack-plugin'],
|
||||
author: 'webpack'
|
||||
});
|
||||
console.log(searchResults);
|
||||
}
|
||||
|
||||
searchPackages();
|
||||
```
|
||||
|
||||
### Downloading Packages
|
||||
`@push.rocks/smartnpm` provides an easy way to download npm packages and extract them to a specific directory. This could be useful for creating tools that need to programmatically handle packages.
|
||||
|
||||
```typescript
|
||||
async function downloadPackage() {
|
||||
const packageName = 'some-package';
|
||||
const targetDirectory = './path/to/targetDir';
|
||||
|
||||
await npmRegistry.savePackageToDisk(packageName, targetDirectory);
|
||||
console.log(`${packageName} has been downloaded to ${targetDirectory}`);
|
||||
}
|
||||
|
||||
downloadPackage();
|
||||
```
|
||||
|
||||
### Working with Package Versions and Dist Tags
|
||||
You can easily retrieve detailed information about specific package versions or distribution tags. This is particularly useful for automation scripts that need to work with specific versions of a package.
|
||||
|
||||
```typescript
|
||||
async function getPackageVersionDetails() {
|
||||
const packageName = 'some-package';
|
||||
const version = '1.0.0'; // You can also use dist tags like 'latest'
|
||||
|
||||
const packageInfo = await npmRegistry.getPackageInfo(packageName);
|
||||
const versionInfo = packageInfo.allVersions.find(v => v.version === version);
|
||||
console.log(versionInfo);
|
||||
}
|
||||
|
||||
getPackageVersionDetails();
|
||||
```
|
||||
|
||||
These examples only scratch the surface of what you can achieve with `@push.rocks/smartnpm`. By integrating this library, you have a powerful tool at your disposal for interacting with npm in a programmatic way, enabling a wide range of possibilities for automation, CI/CD, and tooling around npm packages.
|
||||
|
||||
## 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.
|
||||
|
||||
29
test/test.ts
29
test/test.ts
@ -1,6 +1,6 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartnpm from '../ts/index';
|
||||
import { NpmRegistry } from '../ts/index';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartnpm from '../ts/index.js';
|
||||
import { NpmRegistry } from '../ts/index.js';
|
||||
|
||||
let npmRegistry: smartnpm.NpmRegistry;
|
||||
let verdaccioRegistry: smartnpm.NpmRegistry;
|
||||
@ -9,46 +9,43 @@ let testPackage: smartnpm.NpmPackage;
|
||||
// lets test things with the standard npm registry
|
||||
tap.test('should create valid instances', async () => {
|
||||
npmRegistry = new smartnpm.NpmRegistry();
|
||||
expect(npmRegistry).to.be.instanceof(smartnpm.NpmRegistry);
|
||||
expect(npmRegistry).toBeInstanceOf(smartnpm.NpmRegistry);
|
||||
|
||||
testPackage = new smartnpm.NpmPackage(npmRegistry);
|
||||
expect(testPackage).to.be.instanceof(smartnpm.NpmPackage);
|
||||
expect(testPackage).toBeInstanceOf(smartnpm.NpmPackage);
|
||||
});
|
||||
|
||||
tap.test('should produce a valid search string and this return npmts', async () => {
|
||||
const packages = await npmRegistry.searchOnNpm({
|
||||
name: '@pushrocks/smartupdate',
|
||||
});
|
||||
expect(packages[0].name).to.equal('@pushrocks/smartupdate');
|
||||
expect(packages[0].name).toEqual('@pushrocks/smartupdate');
|
||||
});
|
||||
|
||||
// lets test things with the verdaccio registry
|
||||
tap.test('should create a verdaccio registry', async () => {
|
||||
verdaccioRegistry = new NpmRegistry({
|
||||
npmRegistryUrl: 'https://verdaccio.lossless.one',
|
||||
npmRegistryUrl: 'https://verdaccio.lossless.digital',
|
||||
});
|
||||
expect(verdaccioRegistry).to.be.instanceOf(smartnpm.NpmRegistry);
|
||||
expect(verdaccioRegistry).toBeInstanceOf(smartnpm.NpmRegistry);
|
||||
});
|
||||
|
||||
tap.test('should get package from verdaccio', async () => {
|
||||
const npmPackage = await verdaccioRegistry.getPackageInfo('@pushrocks/smartupdate');
|
||||
expect(npmPackage.license).to.equal('MIT');
|
||||
expect(npmPackage.license).toEqual('MIT');
|
||||
});
|
||||
|
||||
tap.test('should get a specific file from a package', async () => {
|
||||
const wantedFile = await verdaccioRegistry.getFileFromPackage(
|
||||
'@pushrocks/websetup',
|
||||
'ts/index.ts'
|
||||
'./ts/index.ts'
|
||||
);
|
||||
console.log(wantedFile.contentBuffer.toString());
|
||||
});
|
||||
|
||||
tap.test('should get a specific file from a package', async () => {
|
||||
const wantedFiles = await verdaccioRegistry.getFilesFromPackage(
|
||||
'@pushrocks/websetup',
|
||||
'ts/'
|
||||
);
|
||||
for(const file of wantedFiles) {
|
||||
const wantedFiles = await verdaccioRegistry.getFilesFromPackage('@pushrocks/websetup', 'ts/');
|
||||
for (const file of wantedFiles) {
|
||||
console.log(file.path);
|
||||
}
|
||||
});
|
||||
@ -58,7 +55,7 @@ tap.test('should not get a nonexisting file from a package', async () => {
|
||||
'@pushrocks/websetup',
|
||||
'ts/notthere'
|
||||
);
|
||||
expect(wantedFileNotThere).to.be.null
|
||||
expect(wantedFileNotThere).toBeNull();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartnpm',
|
||||
version: '2.0.4',
|
||||
description: 'interface with npm to retrieve package information'
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
|
||||
export * from './smartnpm.classes.npmregistry';
|
||||
export * from './smartnpm.classes.npmpackage';
|
||||
export * from './smartnpm.classes.npmregistry.js';
|
||||
export * from './smartnpm.classes.npmpackage.js';
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import { NpmRegistry } from './smartnpm.classes.npmregistry';
|
||||
import { PackageDisttag } from './smartnpm.classes.packagedisttag';
|
||||
import { PackageVersion, IVersionData } from './smartnpm.classes.packageversion';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
import { NpmRegistry } from './smartnpm.classes.npmregistry.js';
|
||||
import { PackageDisttag } from './smartnpm.classes.packagedisttag.js';
|
||||
import { PackageVersion, type IVersionData } from './smartnpm.classes.packageversion.js';
|
||||
|
||||
export class NpmPackage {
|
||||
public static async createFromFullMetadataAndVersionData(
|
||||
@ -139,7 +139,7 @@ export class NpmPackage {
|
||||
// lets resolve with the wanted file
|
||||
done.resolve([fileArg]);
|
||||
subscription.unsubscribe();
|
||||
} else if(!returnOnFirstArg && fileArg.path.startsWith(wantedFilePath)) {
|
||||
} else if (!returnOnFirstArg && fileArg.path.startsWith(wantedFilePath)) {
|
||||
allMatchingFiles.push(fileArg);
|
||||
}
|
||||
},
|
||||
@ -157,7 +157,7 @@ export class NpmPackage {
|
||||
/**
|
||||
* get files from package
|
||||
*/
|
||||
public async getFileFromPackage(
|
||||
public async getFileFromPackage(
|
||||
filePath: string,
|
||||
optionsArg?: {
|
||||
distTag?: string;
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import * as paths from './smartnpm.paths';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
import * as paths from './smartnpm.paths.js';
|
||||
|
||||
// interfaces
|
||||
import { ISearchObject } from './smartnpm.interfaces';
|
||||
import { type ISearchObject } from './smartnpm.interfaces.js';
|
||||
|
||||
// classes
|
||||
import { NpmPackage } from './smartnpm.classes.npmpackage';
|
||||
import { ICacheDescriptor, RegistryCache } from './smartnpm.classes.registrycache';
|
||||
import { NpmPackage } from './smartnpm.classes.npmpackage.js';
|
||||
import { type ICacheDescriptor, RegistryCache } from './smartnpm.classes.registrycache.js';
|
||||
|
||||
export interface INpmRegistryConstructorOptions {
|
||||
npmRegistryUrl?: string;
|
||||
@ -33,18 +33,24 @@ export class NpmRegistry {
|
||||
* @param packageName
|
||||
*/
|
||||
public async getPackageInfo(packageName: string): Promise<NpmPackage> {
|
||||
const fullMetadata = await plugins.packageJson(packageName, {
|
||||
const fullMetadata = await plugins
|
||||
.packageJson.default(packageName, {
|
||||
registryUrl: this.options.npmRegistryUrl,
|
||||
fullMetadata: true,
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err);
|
||||
return null;
|
||||
});
|
||||
const versionData = await plugins.packageJson.default(packageName, {
|
||||
registryUrl: this.options.npmRegistryUrl,
|
||||
fullMetadata: true,
|
||||
}).catch(err => {
|
||||
console.log(err);
|
||||
return null;
|
||||
allVersions: true,
|
||||
});
|
||||
const versionData = await plugins.packageJson(packageName, {
|
||||
registryUrl: this.options.npmRegistryUrl,
|
||||
allVersions: true
|
||||
});
|
||||
const npmPackage = await NpmPackage.createFromFullMetadataAndVersionData(this, fullMetadata, versionData as any);
|
||||
const npmPackage = await NpmPackage.createFromFullMetadataAndVersionData(
|
||||
this,
|
||||
fullMetadata,
|
||||
versionData as any
|
||||
);
|
||||
return npmPackage;
|
||||
}
|
||||
|
||||
@ -62,30 +68,38 @@ export class NpmRegistry {
|
||||
/**
|
||||
* gets a file from a package as Smartfile
|
||||
*/
|
||||
public async getFileFromPackage(packageNameArg: string, filePathArg: string, optionsArg?: {
|
||||
distTag?: string;
|
||||
version?: string;
|
||||
}): Promise<plugins.smartfile.Smartfile> {
|
||||
public async getFileFromPackage(
|
||||
packageNameArg: string,
|
||||
filePathArg: string,
|
||||
optionsArg?: {
|
||||
distTag?: string;
|
||||
version?: string;
|
||||
}
|
||||
): Promise<plugins.smartfile.Smartfile> {
|
||||
// lets create a cache descriptor
|
||||
const cacheDescriptor: ICacheDescriptor = {
|
||||
registryUrl: this.options.npmRegistryUrl,
|
||||
packageName: packageNameArg,
|
||||
filePath: filePathArg,
|
||||
distTag: optionsArg?.distTag,
|
||||
version: optionsArg?.version
|
||||
version: optionsArg?.version,
|
||||
};
|
||||
|
||||
// lets see if we have something cached
|
||||
const cachedFile: plugins.smartfile.Smartfile = await this.registryCache.getCachedFile(cacheDescriptor);
|
||||
|
||||
const cachedFile: plugins.smartfile.Smartfile = await this.registryCache.getCachedFile(
|
||||
cacheDescriptor
|
||||
);
|
||||
|
||||
// lets handle both occasions
|
||||
if (!cachedFile) {
|
||||
const npmPackage = await this.getPackageInfo(packageNameArg);
|
||||
if (!optionsArg?.version && !optionsArg?.distTag) {
|
||||
const latestAvailable = npmPackage.allDistTags.find(packageArg => packageArg.name === 'latest');
|
||||
const latestAvailable = npmPackage.allDistTags.find(
|
||||
(packageArg) => packageArg.name === 'latest'
|
||||
);
|
||||
if (!latestAvailable) {
|
||||
optionsArg = {
|
||||
version: npmPackage.getBestMatchingVersion('*')
|
||||
version: npmPackage.getBestMatchingVersion('*'),
|
||||
};
|
||||
}
|
||||
}
|
||||
@ -99,23 +113,31 @@ export class NpmRegistry {
|
||||
}
|
||||
}
|
||||
|
||||
public async getFilesFromPackage(packageNameArg: string, filePath: string, optionsArg?: {
|
||||
distTag?: string;
|
||||
version?: string;
|
||||
}): Promise<plugins.smartfile.Smartfile[]> {
|
||||
public async getFilesFromPackage(
|
||||
packageNameArg: string,
|
||||
filePath: string,
|
||||
optionsArg?: {
|
||||
distTag?: string;
|
||||
version?: string;
|
||||
}
|
||||
): Promise<plugins.smartfile.Smartfile[]> {
|
||||
const npmPackage = await this.getPackageInfo(packageNameArg);
|
||||
if (!optionsArg?.version && !optionsArg?.distTag) {
|
||||
const latestAvailable = npmPackage.allDistTags.find(packageDistTagArg => packageDistTagArg.name === 'latest');
|
||||
const latestAvailable = npmPackage.allDistTags.find(
|
||||
(packageDistTagArg) => packageDistTagArg.name === 'latest'
|
||||
);
|
||||
if (!latestAvailable) {
|
||||
optionsArg = {
|
||||
version: npmPackage.getBestMatchingVersion('*')
|
||||
version: npmPackage.getBestMatchingVersion('*'),
|
||||
};
|
||||
}
|
||||
}
|
||||
return npmPackage.getFilesFromPackage(filePath, optionsArg);
|
||||
}
|
||||
|
||||
public async getPackageAsSmartfileVirtualDir(packageNameArg: string): Promise<plugins.smartfile.VirtualDirectory> {
|
||||
public async getPackageAsSmartfileVirtualDir(
|
||||
packageNameArg: string
|
||||
): Promise<plugins.smartfile.VirtualDirectory> {
|
||||
/**
|
||||
* TODO: rewrite as memory only
|
||||
*/
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
|
||||
export class PackageDisttag {
|
||||
name: string;
|
||||
@ -8,4 +8,4 @@ export class PackageDisttag {
|
||||
this.name = nameArg;
|
||||
this.targetVersion = targetVersionArg;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
|
||||
export interface IVersionData {
|
||||
name: string;
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
import { NpmRegistry } from './smartnpm.classes.npmregistry';
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
|
||||
import { NpmRegistry } from './smartnpm.classes.npmregistry.js';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
|
||||
export interface ICacheDescriptor {
|
||||
registryUrl: string;
|
||||
@ -18,33 +17,47 @@ export class RegistryCache {
|
||||
this.npmregistryRef = npmRegistryRefArg;
|
||||
this.levelCache = new plugins.levelcache.LevelCache({
|
||||
cacheId: encodeURIComponent(this.npmregistryRef.options.npmRegistryUrl),
|
||||
|
||||
});
|
||||
}
|
||||
|
||||
public async getCachedFile (cacheDescriptorArg: ICacheDescriptor): Promise<plugins.smartfile.Smartfile> {
|
||||
const cacheEntry = await this.levelCache.retrieveCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg));
|
||||
public async getCachedFile(
|
||||
cacheDescriptorArg: ICacheDescriptor
|
||||
): Promise<plugins.smartfile.Smartfile> {
|
||||
const cacheEntry = await this.levelCache.retrieveCacheEntryByKey(
|
||||
this.getCacheDescriptorAsString(cacheDescriptorArg)
|
||||
);
|
||||
if (cacheEntry) {
|
||||
return plugins.smartfile.Smartfile.fromFoldedJson(cacheEntry.contents.toString());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
public async cacheSmartFile (cacheDescriptorArg: ICacheDescriptor, smartfileArg: plugins.smartfile.Smartfile) {
|
||||
public async cacheSmartFile(
|
||||
cacheDescriptorArg: ICacheDescriptor,
|
||||
smartfileArg: plugins.smartfile.Smartfile
|
||||
) {
|
||||
if (smartfileArg && cacheDescriptorArg.version) {
|
||||
await this.levelCache.storeCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg), new plugins.levelcache.CacheEntry({
|
||||
contents: Buffer.from(smartfileArg.foldToJson()),
|
||||
ttl: plugins.smarttime.getMilliSecondsFromUnits({hours: 1})
|
||||
}));
|
||||
await this.levelCache.storeCacheEntryByKey(
|
||||
this.getCacheDescriptorAsString(cacheDescriptorArg),
|
||||
new plugins.levelcache.CacheEntry({
|
||||
contents: Buffer.from(smartfileArg.foldToJson()),
|
||||
ttl: plugins.smarttime.getMilliSecondsFromUnits({ hours: 1 }),
|
||||
})
|
||||
);
|
||||
} else {
|
||||
await this.levelCache.storeCacheEntryByKey(this.getCacheDescriptorAsString(cacheDescriptorArg), new plugins.levelcache.CacheEntry({
|
||||
contents: Buffer.from(smartfileArg.foldToJson()),
|
||||
ttl: plugins.smarttime.getMilliSecondsFromUnits({minutes: 1})
|
||||
}));
|
||||
await this.levelCache.storeCacheEntryByKey(
|
||||
this.getCacheDescriptorAsString(cacheDescriptorArg),
|
||||
new plugins.levelcache.CacheEntry({
|
||||
contents: Buffer.from(smartfileArg.foldToJson()),
|
||||
ttl: plugins.smarttime.getMilliSecondsFromUnits({ minutes: 1 }),
|
||||
})
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public getCacheDescriptorAsString(cacheDescriptorArg?: ICacheDescriptor) {
|
||||
return `${cacheDescriptorArg.registryUrl}//+//${cacheDescriptorArg.packageName}//+//${cacheDescriptorArg.filePath}//+//${cacheDescriptorArg.distTag || cacheDescriptorArg.version}`;
|
||||
return `${cacheDescriptorArg.registryUrl}//+//${cacheDescriptorArg.packageName}//+//${
|
||||
cacheDescriptorArg.filePath
|
||||
}//+//${cacheDescriptorArg.distTag || cacheDescriptorArg.version}`;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
import * as plugins from './smartnpm.plugins';
|
||||
import * as plugins from './smartnpm.plugins.js';
|
||||
|
||||
export const packageDir = plugins.path.join(__dirname, '../');
|
||||
export const packageDir = plugins.path.join(
|
||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
'../'
|
||||
);
|
||||
export const nogitDir = plugins.path.join(packageDir, '.nogit/');
|
||||
|
||||
@ -4,18 +4,29 @@ import * as path from 'path';
|
||||
export { path };
|
||||
|
||||
// @pushrocks scope
|
||||
import * as consolecolor from '@pushrocks/consolecolor';
|
||||
import * as levelcache from '@pushrocks/levelcache';
|
||||
import * as smartarchive from '@pushrocks/smartarchive';
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartrequest from '@pushrocks/smartrequest';
|
||||
import * as smartversion from '@pushrocks/smartversion';
|
||||
import * as smarttime from '@pushrocks/smarttime';
|
||||
import * as consolecolor from '@push.rocks/consolecolor';
|
||||
import * as levelcache from '@push.rocks/levelcache';
|
||||
import * as smartarchive from '@push.rocks/smartarchive';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartrequest from '@push.rocks/smartrequest';
|
||||
import * as smartversion from '@push.rocks/smartversion';
|
||||
import * as smarttime from '@push.rocks/smarttime';
|
||||
|
||||
export { consolecolor, levelcache, smartarchive, smartfile, smartpromise, smartrequest, smartversion, smarttime };
|
||||
export {
|
||||
consolecolor,
|
||||
levelcache,
|
||||
smartarchive,
|
||||
smartfile,
|
||||
smartpath,
|
||||
smartpromise,
|
||||
smartrequest,
|
||||
smartversion,
|
||||
smarttime,
|
||||
};
|
||||
|
||||
// third party scope
|
||||
import packageJson from 'package-json';
|
||||
import * as packageJson from 'package-json';
|
||||
|
||||
export { packageJson };
|
||||
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Reference in New Issue
Block a user