9b395f5cc3
E2E Headed Chrome / e2e-headed (macos-15) (push) Has been cancelled
E2E Headed Chrome / e2e-headed (ubuntu-latest) (push) Has been cancelled
E2E Headed Chrome / e2e-headed (windows-latest) (push) Has been cancelled
CI / build (macos-latest) (push) Has been cancelled
CI / build (ubuntu-latest) (push) Has been cancelled
CI / build (windows-latest) (push) Has been cancelled
CI / unit-test (push) Has been cancelled
CI / bun-test (push) Has been cancelled
CI / adapter-test (push) Has been cancelled
CI / smoke-test (macos-latest) (push) Has been cancelled
CI / smoke-test (ubuntu-latest) (push) Has been cancelled
Security Audit / audit (push) Has been cancelled
Build Chrome Extension / build (push) Has been cancelled
Trigger Website Rebuild (Docs Updated) / dispatch (push) Has been cancelled
50 lines
2.4 KiB
JavaScript
50 lines
2.4 KiB
JavaScript
// npm search — search the public npm registry by free-text query.
|
|
//
|
|
// Hits `https://registry.npmjs.org/-/v1/search?text=…`. Returns enough per-row
|
|
// to feed back into `npm package` / `npm downloads`: name (round-trips as id),
|
|
// description, version, weekly downloads, dependents count, license, links.
|
|
import { cli, Strategy } from '@jackwener/opencli/registry';
|
|
import { EmptyResultError } from '@jackwener/opencli/errors';
|
|
import { NPM_REGISTRY, npmFetch, requireBoundedInt, requireString } from './utils.js';
|
|
|
|
cli({
|
|
site: 'npm',
|
|
name: 'search',
|
|
access: 'read',
|
|
description: 'Search the public npm registry by keyword',
|
|
domain: 'registry.npmjs.org',
|
|
strategy: Strategy.PUBLIC,
|
|
browser: false,
|
|
args: [
|
|
{ name: 'query', positional: true, required: true, help: 'Search keyword (e.g. "react", "graphql client")' },
|
|
{ name: 'limit', type: 'int', default: 20, help: 'Max results (1-250)' },
|
|
],
|
|
columns: ['rank', 'name', 'version', 'description', 'weeklyDownloads', 'dependents', 'license', 'publisher', 'updated', 'url'],
|
|
func: async (args) => {
|
|
const query = requireString(args.query, 'query');
|
|
const limit = requireBoundedInt(args.limit, 20, 250);
|
|
const url = `${NPM_REGISTRY}/-/v1/search?text=${encodeURIComponent(query)}&size=${limit}`;
|
|
const body = await npmFetch(url, 'npm search');
|
|
const objects = Array.isArray(body?.objects) ? body.objects : [];
|
|
if (!objects.length) {
|
|
throw new EmptyResultError('npm search', `No npm packages matched "${query}".`);
|
|
}
|
|
return objects.slice(0, limit).map((obj, i) => {
|
|
const pkg = obj?.package ?? {};
|
|
const dl = obj?.downloads ?? {};
|
|
return {
|
|
rank: i + 1,
|
|
name: String(pkg.name ?? ''),
|
|
version: String(pkg.version ?? ''),
|
|
description: String(pkg.description ?? ''),
|
|
weeklyDownloads: dl.weekly != null ? Number(dl.weekly) : null,
|
|
dependents: obj.dependents != null ? Number(obj.dependents) : null,
|
|
license: String(pkg.license ?? ''),
|
|
publisher: String(pkg.publisher?.username ?? ''),
|
|
updated: String(obj.updated ?? '').slice(0, 10),
|
|
url: pkg.links?.npm ? String(pkg.links.npm) : (pkg.name ? `https://www.npmjs.com/package/${pkg.name}` : ''),
|
|
};
|
|
});
|
|
},
|
|
});
|