mirror of
https://gitcode.com/github-mirrors/react-native-update-cli.git
synced 2025-09-16 09:41:38 +08:00
inline latest version code
This commit is contained in:
sunnylqm
@@ -5,7 +5,7 @@ import pkg from '../../package.json';
|
||||
import AppInfoParser from './app-info-parser';
|
||||
import semverSatisfies from 'semver/functions/satisfies';
|
||||
import chalk from 'chalk';
|
||||
import latestVersion from '@badisi/latest-version';
|
||||
import latestVersion from '../utils/latest-version';
|
||||
import { checkPlugins } from './check-plugin';
|
||||
|
||||
import { read } from 'read';
|
||||
|
||||
443
src/utils/latest-version/cli.ts
Normal file
443
src/utils/latest-version/cli.ts
Normal file
@@ -0,0 +1,443 @@
|
||||
import {
|
||||
blue,
|
||||
bold,
|
||||
cyan,
|
||||
gray,
|
||||
green,
|
||||
italic,
|
||||
magenta,
|
||||
red,
|
||||
reset,
|
||||
strip,
|
||||
underline,
|
||||
yellow,
|
||||
} from '@colors/colors/safe';
|
||||
import { existsSync, readFileSync } from 'node:fs';
|
||||
import { dirname } from 'node:path';
|
||||
import latestVersion, {
|
||||
type Package,
|
||||
type PackageJson,
|
||||
type LatestVersionPackage,
|
||||
type LatestVersionOptions,
|
||||
} from '.';
|
||||
import semverMajor from 'semver/functions/major';
|
||||
import semverDiff from 'semver/functions/diff';
|
||||
|
||||
interface TableColumn {
|
||||
label: string;
|
||||
attrName: keyof TableRow;
|
||||
align: 'left' | 'center' | 'right';
|
||||
maxLength: number;
|
||||
items: string[];
|
||||
}
|
||||
|
||||
type TableRowGroup =
|
||||
| 'patch'
|
||||
| 'minor'
|
||||
| 'major'
|
||||
| 'majorVersionZero'
|
||||
| 'unknown';
|
||||
|
||||
interface TableRow {
|
||||
name: string;
|
||||
location: string;
|
||||
installed: string;
|
||||
tagOrRange: string;
|
||||
separator: string;
|
||||
wanted: string;
|
||||
latest: string;
|
||||
group: TableRowGroup;
|
||||
}
|
||||
|
||||
const colorizeDiff = (from: string, to: string): string => {
|
||||
const toParts = to.split('.');
|
||||
|
||||
const diffIndex = from.split('.').findIndex((part, i) => part !== toParts[i]);
|
||||
if (diffIndex !== -1) {
|
||||
let color = magenta;
|
||||
if (toParts[0] !== '0') {
|
||||
color = diffIndex === 0 ? red : diffIndex === 1 ? cyan : green;
|
||||
}
|
||||
const start = toParts.slice(0, diffIndex).join('.');
|
||||
const mid = diffIndex === 0 ? '' : '.';
|
||||
const end = color(toParts.slice(diffIndex).join('.'));
|
||||
return `${start}${mid}${end}`;
|
||||
}
|
||||
return to;
|
||||
};
|
||||
|
||||
const columnCellRenderer = (column: TableColumn, row: TableRow): string => {
|
||||
let text = row[column.attrName];
|
||||
const gap =
|
||||
text.length < column.maxLength
|
||||
? ' '.repeat(column.maxLength - text.length)
|
||||
: '';
|
||||
|
||||
switch (column.attrName) {
|
||||
case 'name':
|
||||
text = yellow(text);
|
||||
break;
|
||||
case 'installed':
|
||||
case 'separator':
|
||||
text = blue(text);
|
||||
break;
|
||||
case 'location':
|
||||
case 'tagOrRange':
|
||||
text = gray(text);
|
||||
break;
|
||||
case 'wanted':
|
||||
text = colorizeDiff(row.installed, text);
|
||||
break;
|
||||
case 'latest':
|
||||
if (text !== row.wanted) {
|
||||
text = colorizeDiff(row.installed, text);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
return column.align === 'right' ? `${gap}${text}` : `${text}${gap}`;
|
||||
};
|
||||
|
||||
const columnHeaderRenderer = (column: TableColumn): string => {
|
||||
const text = column.label;
|
||||
const gap =
|
||||
text.length < column.maxLength
|
||||
? ' '.repeat(column.maxLength - text.length)
|
||||
: '';
|
||||
return column.align === 'right'
|
||||
? `${gap}${underline(text)}`
|
||||
: `${underline(text)}${gap}`;
|
||||
};
|
||||
|
||||
const drawBox = (
|
||||
lines: string[],
|
||||
color = yellow,
|
||||
horizontalPadding = 3,
|
||||
): void => {
|
||||
const maxLineWidth = lines.reduce(
|
||||
(max, row) => Math.max(max, strip(row).length),
|
||||
0,
|
||||
);
|
||||
|
||||
console.log(color(`┌${'─'.repeat(maxLineWidth + horizontalPadding * 2)}┐`));
|
||||
lines.forEach((row) => {
|
||||
const padding = ' '.repeat(horizontalPadding);
|
||||
const fullRow = `${row}${' '.repeat(maxLineWidth - strip(row).length)}`;
|
||||
console.log(
|
||||
`${color('│')}${padding}${reset(fullRow)}${padding}${color('│')}`,
|
||||
);
|
||||
});
|
||||
console.log(color(`└${'─'.repeat(maxLineWidth + horizontalPadding * 2)}┘`));
|
||||
};
|
||||
|
||||
const getTableColumns = (rows: TableRow[]): TableColumn[] => {
|
||||
const columns: TableColumn[] = [
|
||||
{
|
||||
label: 'Package',
|
||||
attrName: 'name',
|
||||
align: 'left',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: 'Location',
|
||||
attrName: 'location',
|
||||
align: 'left',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: 'Installed',
|
||||
attrName: 'installed',
|
||||
align: 'right',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: '',
|
||||
attrName: 'separator',
|
||||
align: 'center',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: 'Range',
|
||||
attrName: 'tagOrRange',
|
||||
align: 'right',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: '',
|
||||
attrName: 'separator',
|
||||
align: 'center',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: 'Wanted',
|
||||
attrName: 'wanted',
|
||||
align: 'right',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
{
|
||||
label: 'Latest',
|
||||
attrName: 'latest',
|
||||
align: 'right',
|
||||
maxLength: 0,
|
||||
items: [],
|
||||
},
|
||||
];
|
||||
rows.forEach((row) => {
|
||||
columns.forEach((column) => {
|
||||
column.maxLength = Math.max(
|
||||
column.label.length,
|
||||
column.maxLength,
|
||||
row[column.attrName].length || 0,
|
||||
);
|
||||
});
|
||||
});
|
||||
return columns;
|
||||
};
|
||||
|
||||
const getTableRows = (updates: LatestVersionPackage[]): TableRow[] => {
|
||||
return updates.reduce<TableRow[]>((all, pkg) => {
|
||||
const {
|
||||
name,
|
||||
latest,
|
||||
local,
|
||||
globalNpm,
|
||||
globalYarn,
|
||||
wantedTagOrRange,
|
||||
updatesAvailable,
|
||||
} = pkg;
|
||||
const getGroup = (a?: string, b?: string): TableRowGroup => {
|
||||
if (b && semverMajor(b) === 0) {
|
||||
return 'majorVersionZero';
|
||||
} else if (a && b) {
|
||||
const releaseType = semverDiff(a, b) ?? '';
|
||||
if (['major', 'premajor', 'prerelease'].includes(releaseType)) {
|
||||
return 'major';
|
||||
} else if (['minor', 'preminor'].includes(releaseType)) {
|
||||
return 'minor';
|
||||
} else if (['patch', 'prepatch'].includes(releaseType)) {
|
||||
return 'patch';
|
||||
}
|
||||
}
|
||||
return 'unknown';
|
||||
};
|
||||
const add = (
|
||||
group: TableRowGroup,
|
||||
location: string,
|
||||
installed?: string,
|
||||
wanted?: string,
|
||||
) =>
|
||||
all.push({
|
||||
name: ' ' + name,
|
||||
location,
|
||||
installed: installed ?? 'unknown',
|
||||
latest: latest ?? 'unknown',
|
||||
tagOrRange: wantedTagOrRange ?? 'unknown',
|
||||
separator: '→',
|
||||
wanted: wanted ?? 'unknown',
|
||||
group,
|
||||
});
|
||||
if (updatesAvailable) {
|
||||
if (updatesAvailable.local) {
|
||||
add(
|
||||
getGroup(local, updatesAvailable.local),
|
||||
'local',
|
||||
local,
|
||||
updatesAvailable.local,
|
||||
);
|
||||
}
|
||||
if (updatesAvailable.globalNpm) {
|
||||
add(
|
||||
getGroup(globalNpm, updatesAvailable.globalNpm),
|
||||
'NPM global',
|
||||
globalNpm,
|
||||
updatesAvailable.globalNpm,
|
||||
);
|
||||
}
|
||||
if (updatesAvailable.globalYarn) {
|
||||
add(
|
||||
getGroup(globalYarn, updatesAvailable.globalYarn),
|
||||
'YARN global',
|
||||
globalYarn,
|
||||
updatesAvailable.globalYarn,
|
||||
);
|
||||
}
|
||||
} else {
|
||||
if (local && local !== latest) {
|
||||
add(getGroup(local, latest), 'local', local, pkg.wanted);
|
||||
}
|
||||
if (globalNpm && globalNpm !== latest) {
|
||||
add(getGroup(globalNpm, latest), 'NPM global', globalNpm, pkg.wanted);
|
||||
}
|
||||
if (globalYarn && globalYarn !== latest) {
|
||||
add(
|
||||
getGroup(globalYarn, latest),
|
||||
'YARN global',
|
||||
globalYarn,
|
||||
pkg.wanted,
|
||||
);
|
||||
}
|
||||
if (!local && !globalNpm && !globalYarn) {
|
||||
add('unknown', 'unknown', 'unknown', pkg.wanted);
|
||||
}
|
||||
}
|
||||
return all;
|
||||
}, []);
|
||||
};
|
||||
|
||||
const displayTable = (latestVersionPackages: LatestVersionPackage[]): void => {
|
||||
const updates = latestVersionPackages.filter((pkg) => pkg.updatesAvailable);
|
||||
if (updates.length) {
|
||||
const rows = getTableRows(updates);
|
||||
const hasUpdates = rows.some((row) => row.installed !== 'unknown');
|
||||
const columns = getTableColumns(rows);
|
||||
const columnGap = 2;
|
||||
|
||||
const getGroupLines = (
|
||||
groupType: TableRowGroup,
|
||||
color: (str: string) => string,
|
||||
title: string,
|
||||
description?: string,
|
||||
): string[] => {
|
||||
const items = rows
|
||||
.filter((row) => row.group === groupType)
|
||||
.sort((a, b) => (a.name > b.name ? 1 : -1));
|
||||
return !items.length
|
||||
? []
|
||||
: [
|
||||
'',
|
||||
color(`${bold(title)} ${italic(`(${description})`)}`),
|
||||
...items.map((row) =>
|
||||
columns
|
||||
.map((column) => columnCellRenderer(column, row))
|
||||
.join(' '.repeat(columnGap)),
|
||||
),
|
||||
];
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
|
||||
drawBox(
|
||||
[
|
||||
'',
|
||||
hasUpdates ? yellow('Important updates are available.') : undefined,
|
||||
hasUpdates ? '' : undefined,
|
||||
columns.map(columnHeaderRenderer).join(' '.repeat(columnGap)),
|
||||
...getGroupLines(
|
||||
'patch',
|
||||
green,
|
||||
'Patch',
|
||||
'backwards-compatible bug fixes',
|
||||
),
|
||||
...getGroupLines(
|
||||
'minor',
|
||||
cyan,
|
||||
'Minor',
|
||||
'backwards-compatible features',
|
||||
),
|
||||
...getGroupLines(
|
||||
'major',
|
||||
red,
|
||||
'Major',
|
||||
'potentially breaking API changes',
|
||||
),
|
||||
...getGroupLines(
|
||||
'majorVersionZero',
|
||||
magenta,
|
||||
'Major version zero',
|
||||
'not stable, anything may change',
|
||||
),
|
||||
...getGroupLines('unknown', blue, 'Missing', 'not installed'),
|
||||
'',
|
||||
].filter((line) => line !== undefined) as string[],
|
||||
);
|
||||
} else {
|
||||
console.log(green('🎉 Packages are up-to-date'));
|
||||
}
|
||||
};
|
||||
|
||||
const checkVersions = async (
|
||||
packages: Package | Package[] | PackageJson,
|
||||
skipMissing: boolean,
|
||||
options: LatestVersionOptions = { useCache: true },
|
||||
): Promise<void> => {
|
||||
const ora = (await import('ora')).default;
|
||||
const spinner = ora({ text: cyan('Checking versions...') });
|
||||
spinner.start();
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
||||
// @ts-ignore
|
||||
let latestVersionPackages: LatestVersionPackage[] = await latestVersion(
|
||||
packages,
|
||||
options,
|
||||
);
|
||||
if (skipMissing) {
|
||||
latestVersionPackages = latestVersionPackages.filter(
|
||||
(pkg) => pkg.local ?? pkg.globalNpm ?? pkg.globalYarn,
|
||||
);
|
||||
}
|
||||
spinner.stop();
|
||||
displayTable(latestVersionPackages);
|
||||
};
|
||||
|
||||
void (async () => {
|
||||
let args = process.argv.slice(2);
|
||||
|
||||
const skipMissing = args.includes('--skip-missing');
|
||||
|
||||
// Remove any options from the arguments
|
||||
args = args.filter((arg) => !arg.startsWith('-'));
|
||||
|
||||
// If argument is a package.json file
|
||||
if (args.length === 1 && args[0].endsWith('package.json')) {
|
||||
if (existsSync(args[0])) {
|
||||
process.chdir(dirname(args[0]));
|
||||
await checkVersions(
|
||||
JSON.parse(readFileSync(args[0]).toString()) as PackageJson,
|
||||
skipMissing,
|
||||
);
|
||||
} else {
|
||||
console.log(cyan('No package.json file were found'));
|
||||
}
|
||||
}
|
||||
// else..
|
||||
else {
|
||||
// Check if a local package.json file exists
|
||||
let localPkgJson: PackageJson | undefined;
|
||||
if (existsSync('package.json')) {
|
||||
localPkgJson = JSON.parse(readFileSync('package.json').toString());
|
||||
}
|
||||
|
||||
// Check given arguments
|
||||
if (args.length) {
|
||||
// Map arguments with any range that could be found in local package.json
|
||||
args = args.map((arg) => {
|
||||
if (localPkgJson?.dependencies?.[arg]) {
|
||||
return `${arg}@${localPkgJson.dependencies?.[arg]}`;
|
||||
}
|
||||
if (localPkgJson?.devDependencies?.[arg]) {
|
||||
return `${arg}@${localPkgJson.devDependencies?.[arg]}`;
|
||||
}
|
||||
if (localPkgJson?.peerDependencies?.[arg]) {
|
||||
return `${arg}@${localPkgJson.peerDependencies?.[arg]}`;
|
||||
}
|
||||
return arg;
|
||||
});
|
||||
await checkVersions(args, skipMissing);
|
||||
}
|
||||
// ...else check the local package.json if any
|
||||
else if (localPkgJson) {
|
||||
await checkVersions(localPkgJson, skipMissing);
|
||||
}
|
||||
// ...else do nothing
|
||||
else {
|
||||
console.log(cyan('No packages were found'));
|
||||
}
|
||||
}
|
||||
})();
|
||||
497
src/utils/latest-version/index.ts
Normal file
497
src/utils/latest-version/index.ts
Normal file
@@ -0,0 +1,497 @@
|
||||
import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
|
||||
import type {
|
||||
RequestOptions as HttpRequestOptions,
|
||||
Agent,
|
||||
IncomingMessage,
|
||||
} from 'node:http';
|
||||
import type { RequestOptions as HttpsRequestOptions } from 'node:https';
|
||||
import { join, dirname, resolve as pathResolve, parse } from 'node:path';
|
||||
import { npm, yarn } from 'global-dirs';
|
||||
import { homedir } from 'node:os';
|
||||
import { URL } from 'node:url';
|
||||
|
||||
import getRegistryUrl from 'registry-auth-token/registry-url';
|
||||
import registryAuthToken from 'registry-auth-token';
|
||||
import maxSatisfying from 'semver/ranges/max-satisfying';
|
||||
import gt from 'semver/functions/gt';
|
||||
|
||||
interface RegistryVersions {
|
||||
/**
|
||||
* The latest version of the package found on the registry (if found).
|
||||
*/
|
||||
latest?: string;
|
||||
/**
|
||||
* The next version of the package found on the registry (if found).
|
||||
*/
|
||||
next?: string;
|
||||
/**
|
||||
* The latest version of the package found on the registry and satisfied by the wanted tag or version range.
|
||||
*/
|
||||
wanted?: string;
|
||||
}
|
||||
|
||||
interface InstalledVersions {
|
||||
/**
|
||||
* The current local installed version of the package (if installed).
|
||||
*/
|
||||
local?: string;
|
||||
/**
|
||||
* The current npm global installed version of the package (if installed).
|
||||
*/
|
||||
globalNpm?: string;
|
||||
/**
|
||||
* The current yarn global installed version of the package (if installed).
|
||||
*/
|
||||
globalYarn?: string;
|
||||
}
|
||||
|
||||
interface LatestVersionPackage extends InstalledVersions, RegistryVersions {
|
||||
/**
|
||||
* The name of the package.
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* The tag or version range that was provided (if provided).
|
||||
* @default "latest"
|
||||
*/
|
||||
wantedTagOrRange?: string;
|
||||
/**
|
||||
* Whether the local or global installed versions (if any) could be upgraded or not, based on the wanted version.
|
||||
*/
|
||||
updatesAvailable:
|
||||
| {
|
||||
local: string | false;
|
||||
globalNpm: string | false;
|
||||
globalYarn: string | false;
|
||||
}
|
||||
| false;
|
||||
/**
|
||||
* Any error that might have occurred during the process.
|
||||
*/
|
||||
error?: Error;
|
||||
}
|
||||
|
||||
interface RequestOptions {
|
||||
readonly ca?: string | Buffer | Array<string | Buffer>;
|
||||
readonly rejectUnauthorized?: boolean;
|
||||
readonly agent?: Agent | boolean;
|
||||
readonly timeout?: number;
|
||||
}
|
||||
|
||||
interface LatestVersionOptions {
|
||||
/**
|
||||
* Awaiting the api to return might take time, depending on the network, and might impact your package loading performance.
|
||||
* You can use the cache mechanism to improve load performance and reduce unnecessary network requests.
|
||||
* If `useCache` is not supplied, the api will always check for updates and wait for every requests to return before returning itself.
|
||||
* If `useCache` is used, the api will always returned immediately, with either (for each provided packages):
|
||||
* 1) a latest/next version available if a cache was found
|
||||
* 2) no latest/next version available if no cache was found - in such case updates will be fetched in the background and a cache will
|
||||
* be created for each provided packages and made available for the next call to the api.
|
||||
* @default false
|
||||
*/
|
||||
readonly useCache?: boolean;
|
||||
|
||||
/**
|
||||
* How long the cache for the provided packages should be used before being refreshed (in milliseconds).
|
||||
* If `useCache` is not supplied, this option has no effect.
|
||||
* If `0` is used, this will force the cache to refresh immediately:
|
||||
* 1) The api will returned immediately (without any latest nor next version available for the provided packages)
|
||||
* 2) New updates will be fetched in the background
|
||||
* 3) The cache for each provided packages will be refreshed and made available for the next call to the api
|
||||
* @default ONE_DAY
|
||||
*/
|
||||
readonly cacheMaxAge?: number;
|
||||
|
||||
/**
|
||||
* A JavaScript package registry url that implements the CommonJS Package Registry specification.
|
||||
* @default "Looks at any registry urls in the .npmrc file or fallback to the default npm registry instead"
|
||||
* @example <caption>.npmrc</caption>
|
||||
* registry = 'https://custom-registry.com/'
|
||||
* @pkgscope:registry = 'https://custom-registry.com/'
|
||||
*/
|
||||
readonly registryUrl?: string;
|
||||
|
||||
/**
|
||||
* Set of options to be passed down to Node.js http/https request.
|
||||
* @example <caption>Behind a proxy with self-signed certificate</caption>
|
||||
* { ca: [ fs.readFileSync('proxy-cert.pem') ] }
|
||||
* @example <caption>Bypassing certificate validation</caption>
|
||||
* { rejectUnauthorized: false }
|
||||
*/
|
||||
readonly requestOptions?: RequestOptions;
|
||||
}
|
||||
|
||||
interface LatestVersion {
|
||||
/**
|
||||
* Get latest versions of packages from of a package json like object.
|
||||
* @param {PackageJson} item - A package json like object (with dependencies, devDependencies and peerDependencies attributes).
|
||||
* @example { dependencies: { 'npm': 'latest' }, devDependencies: { 'npm': '1.3.2' }, peerDependencies: { '@scope/name': '^5.0.2' } }
|
||||
* @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
|
||||
* If `useCache` is not supplied, the default of `false` is used.
|
||||
* If `cacheMaxAge` is not supplied, the default of `one day` is used.
|
||||
* If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the `npm registry url` instead.
|
||||
* @returns {Promise<LatestVersionPackage[]>}
|
||||
*/
|
||||
(item: PackageJson, options?: LatestVersionOptions): Promise<
|
||||
LatestVersionPackage[]
|
||||
>;
|
||||
|
||||
/**
|
||||
* Get latest version of a single package.
|
||||
* @param {Package} item - A single package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
|
||||
* @example 'npm', 'npm@1.3.2', '@scope/name@^5.0.2'
|
||||
* @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
|
||||
* If `useCache` is not supplied, the default of `false` is used.
|
||||
* If `cacheMaxAge` is not supplied, the default of `one day` is used.
|
||||
* If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
|
||||
* @returns {Promise<LatestVersionPackage>}
|
||||
*/
|
||||
(
|
||||
item: Package,
|
||||
options?: LatestVersionOptions,
|
||||
): Promise<LatestVersionPackage>;
|
||||
|
||||
/**
|
||||
* Get latest versions of a collection of packages.
|
||||
* @param {Package[]} items - A collection of package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
|
||||
* @example ['npm', 'npm@1.3.2', '@scope/name@^5.0.2']
|
||||
* @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
|
||||
* If `useCache` is not supplied, the default of `false` is used.
|
||||
* If `cacheMaxAge` is not supplied, the default of `one day` is used.
|
||||
* If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
|
||||
* @returns {Promise<LatestVersionPackage[]>}
|
||||
*/
|
||||
(items: Package[], options?: LatestVersionOptions): Promise<
|
||||
LatestVersionPackage[]
|
||||
>; // eslint-disable-line @typescript-eslint/unified-signatures
|
||||
}
|
||||
type PackageRange = `${'@' | ''}${string}@${string}`;
|
||||
type Package = PackageRange | string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
|
||||
type PackageJsonDependencies = Record<string, string>;
|
||||
type PackageJson = Record<string, any> &
|
||||
(
|
||||
| {
|
||||
dependencies: PackageJsonDependencies;
|
||||
}
|
||||
| {
|
||||
devDependencies: PackageJsonDependencies;
|
||||
}
|
||||
| {
|
||||
peerDependencies: PackageJsonDependencies;
|
||||
}
|
||||
);
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
interface PackageMetadata {
|
||||
name: string;
|
||||
lastUpdateDate: number;
|
||||
versions: string[];
|
||||
distTags: Record<string, string>;
|
||||
}
|
||||
|
||||
export const ONE_DAY = 1000 * 60 * 60 * 24; // eslint-disable-line @typescript-eslint/naming-convention
|
||||
|
||||
const isPackageJson = (obj: any): obj is PackageJson => {
|
||||
return (
|
||||
(obj as PackageJson).dependencies !== undefined ||
|
||||
(obj as PackageJson).devDependencies !== undefined ||
|
||||
(obj as PackageJson).peerDependencies !== undefined
|
||||
);
|
||||
};
|
||||
|
||||
const downloadMetadata = (
|
||||
pkgName: string,
|
||||
options?: LatestVersionOptions,
|
||||
): Promise<PackageMetadata> => {
|
||||
return new Promise((resolve, reject) => {
|
||||
const i = pkgName.indexOf('/');
|
||||
const pkgScope = i !== -1 ? pkgName.slice(0, i) : '';
|
||||
const registryUrl = options?.registryUrl ?? getRegistryUrl(pkgScope);
|
||||
const pkgUrl = new URL(
|
||||
encodeURIComponent(pkgName).replace(/^%40/, '@'),
|
||||
registryUrl,
|
||||
);
|
||||
|
||||
let requestOptions: HttpRequestOptions | HttpsRequestOptions = {
|
||||
headers: {
|
||||
accept:
|
||||
'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*',
|
||||
},
|
||||
host: pkgUrl.hostname,
|
||||
path: pkgUrl.pathname,
|
||||
port: pkgUrl.port,
|
||||
};
|
||||
const authInfo = registryAuthToken(pkgUrl.toString(), { recursive: true });
|
||||
if (authInfo && requestOptions.headers) {
|
||||
requestOptions.headers.authorization = `${authInfo.type} ${authInfo.token}`;
|
||||
}
|
||||
if (options?.requestOptions) {
|
||||
requestOptions = { ...requestOptions, ...options.requestOptions };
|
||||
}
|
||||
|
||||
const { get } = require(pkgUrl.protocol === 'https:' ? 'https' : 'http');
|
||||
const request = get(requestOptions, (res: IncomingMessage) => {
|
||||
if (res.statusCode === 200) {
|
||||
let rawData = '';
|
||||
res.setEncoding('utf8');
|
||||
res.on('data', (chunk: string) => (rawData += chunk));
|
||||
res.once('error', (err) => {
|
||||
res.removeAllListeners();
|
||||
reject(`Request error (${err.message}): ${pkgUrl}`);
|
||||
});
|
||||
res.once('end', () => {
|
||||
res.removeAllListeners();
|
||||
try {
|
||||
const pkgMetadata = JSON.parse(rawData);
|
||||
resolve({
|
||||
name: pkgName,
|
||||
lastUpdateDate: Date.now(),
|
||||
versions: Object.keys(pkgMetadata.versions as string[]),
|
||||
distTags: pkgMetadata['dist-tags'],
|
||||
});
|
||||
return;
|
||||
} catch (err) {
|
||||
reject(err);
|
||||
return;
|
||||
}
|
||||
});
|
||||
} else {
|
||||
res.removeAllListeners();
|
||||
res.resume(); // consume response data to free up memory
|
||||
reject(`Request error (${res.statusCode}): ${pkgUrl}`);
|
||||
return;
|
||||
}
|
||||
});
|
||||
const abort = (error: Error | string): void => {
|
||||
request.destroy();
|
||||
reject(error);
|
||||
};
|
||||
request.once('timeout', () => {
|
||||
abort(`Request timed out: ${pkgUrl}`);
|
||||
});
|
||||
request.once('error', (err: Error) => {
|
||||
abort(err);
|
||||
});
|
||||
request.on('close', () => {
|
||||
request.removeAllListeners();
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
const getCacheDir = (name = '@badisi/latest-version'): string => {
|
||||
const homeDir = homedir();
|
||||
switch (process.platform) {
|
||||
case 'darwin':
|
||||
return join(homeDir, 'Library', 'Caches', name);
|
||||
case 'win32':
|
||||
return join(
|
||||
process.env.LOCALAPPDATA ?? join(homeDir, 'AppData', 'Local'),
|
||||
name,
|
||||
'Cache',
|
||||
);
|
||||
default:
|
||||
return join(process.env.XDG_CACHE_HOME ?? join(homeDir, '.cache'), name);
|
||||
}
|
||||
};
|
||||
|
||||
const saveMetadataToCache = (pkg: PackageMetadata): void => {
|
||||
const filePath = join(getCacheDir(), `${pkg.name}.json`);
|
||||
if (!existsSync(dirname(filePath))) {
|
||||
mkdirSync(dirname(filePath), { recursive: true });
|
||||
}
|
||||
writeFileSync(filePath, JSON.stringify(pkg));
|
||||
};
|
||||
|
||||
const getMetadataFromCache = (
|
||||
pkgName: string,
|
||||
options?: LatestVersionOptions,
|
||||
): PackageMetadata | undefined => {
|
||||
const maxAge = options?.cacheMaxAge ?? ONE_DAY;
|
||||
if (maxAge !== 0) {
|
||||
const pkgCacheFilePath = join(getCacheDir(), `${pkgName}.json`);
|
||||
if (existsSync(pkgCacheFilePath)) {
|
||||
const pkg = JSON.parse(
|
||||
readFileSync(pkgCacheFilePath).toString(),
|
||||
) as PackageMetadata;
|
||||
if (Date.now() - pkg.lastUpdateDate < maxAge) {
|
||||
return pkg;
|
||||
}
|
||||
}
|
||||
}
|
||||
return undefined; // invalidates cache
|
||||
};
|
||||
|
||||
const getRegistryVersions = async (
|
||||
pkgName: string,
|
||||
tagOrRange?: string,
|
||||
options?: LatestVersionOptions,
|
||||
): Promise<RegistryVersions> => {
|
||||
let pkgMetadata: PackageMetadata | undefined;
|
||||
if (pkgName.length && options?.useCache) {
|
||||
pkgMetadata = getMetadataFromCache(pkgName, options);
|
||||
if (!pkgMetadata) {
|
||||
pkgMetadata = await downloadMetadata(pkgName, options);
|
||||
saveMetadataToCache(pkgMetadata);
|
||||
}
|
||||
} else if (pkgName.length) {
|
||||
pkgMetadata = await downloadMetadata(pkgName, options);
|
||||
}
|
||||
|
||||
const versions: RegistryVersions = {
|
||||
latest: pkgMetadata?.distTags.latest,
|
||||
next: pkgMetadata?.distTags.next,
|
||||
};
|
||||
if (tagOrRange && pkgMetadata?.distTags[tagOrRange]) {
|
||||
versions.wanted = pkgMetadata.distTags[tagOrRange];
|
||||
} else if (tagOrRange && pkgMetadata?.versions.length) {
|
||||
versions.wanted =
|
||||
maxSatisfying(pkgMetadata.versions, tagOrRange) ?? undefined;
|
||||
}
|
||||
return versions;
|
||||
};
|
||||
|
||||
const getInstalledVersion = (
|
||||
pkgName: string,
|
||||
location: keyof InstalledVersions = 'local',
|
||||
): string | undefined => {
|
||||
try {
|
||||
if (location === 'globalNpm') {
|
||||
return require(join(npm.packages, pkgName, 'package.json'))
|
||||
?.version as string;
|
||||
} else if (location === 'globalYarn') {
|
||||
// Make sure package is globally installed by Yarn
|
||||
const yarnGlobalPkg = require(pathResolve(
|
||||
yarn.packages,
|
||||
'..',
|
||||
'package.json',
|
||||
));
|
||||
if (!yarnGlobalPkg?.dependencies?.[pkgName]) {
|
||||
return undefined;
|
||||
}
|
||||
return require(join(yarn.packages, pkgName, 'package.json'))
|
||||
?.version as string;
|
||||
} else {
|
||||
/**
|
||||
* Compute the local paths manually as require.resolve() and require.resolve.paths()
|
||||
* cannot be trusted anymore.
|
||||
* @see https://github.com/nodejs/node/issues/33460
|
||||
* @see https://github.com/nodejs/loaders/issues/26
|
||||
*/
|
||||
const { root } = parse(process.cwd());
|
||||
let path = process.cwd();
|
||||
const localPaths = [join(path, 'node_modules')];
|
||||
while (path !== root) {
|
||||
path = dirname(path);
|
||||
localPaths.push(join(path, 'node_modules'));
|
||||
}
|
||||
for (const localPath of localPaths) {
|
||||
const pkgPath = join(localPath, pkgName, 'package.json');
|
||||
if (existsSync(pkgPath)) {
|
||||
return require(pkgPath)?.version as string;
|
||||
}
|
||||
}
|
||||
}
|
||||
return undefined;
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
};
|
||||
|
||||
const getInfo = async (
|
||||
pkg: Package,
|
||||
options?: LatestVersionOptions,
|
||||
): Promise<LatestVersionPackage> => {
|
||||
const i = pkg.lastIndexOf('@');
|
||||
let pkgInfo: LatestVersionPackage = {
|
||||
name: i > 1 ? pkg.slice(0, i) : pkg,
|
||||
wantedTagOrRange: i > 1 ? pkg.slice(i + 1) : 'latest',
|
||||
updatesAvailable: false,
|
||||
};
|
||||
|
||||
try {
|
||||
pkgInfo = {
|
||||
...pkgInfo,
|
||||
local: getInstalledVersion(pkgInfo.name, 'local'),
|
||||
globalNpm: getInstalledVersion(pkgInfo.name, 'globalNpm'),
|
||||
globalYarn: getInstalledVersion(pkgInfo.name, 'globalYarn'),
|
||||
...(await getRegistryVersions(
|
||||
pkgInfo.name,
|
||||
pkgInfo.wantedTagOrRange,
|
||||
options,
|
||||
)),
|
||||
};
|
||||
const local =
|
||||
pkgInfo.local && pkgInfo.wanted
|
||||
? gt(pkgInfo.wanted, pkgInfo.local)
|
||||
? pkgInfo.wanted
|
||||
: false
|
||||
: false;
|
||||
const globalNpm =
|
||||
pkgInfo.globalNpm && pkgInfo.wanted
|
||||
? gt(pkgInfo.wanted, pkgInfo.globalNpm)
|
||||
? pkgInfo.wanted
|
||||
: false
|
||||
: false;
|
||||
const globalYarn =
|
||||
pkgInfo.globalYarn && pkgInfo.wanted
|
||||
? gt(pkgInfo.wanted, pkgInfo.globalYarn)
|
||||
? pkgInfo.wanted
|
||||
: false
|
||||
: false;
|
||||
pkgInfo.updatesAvailable =
|
||||
local || globalNpm || globalYarn
|
||||
? { local, globalNpm, globalYarn }
|
||||
: false;
|
||||
} catch (err: any) {
|
||||
pkgInfo.error = err?.message ?? err;
|
||||
}
|
||||
|
||||
return pkgInfo;
|
||||
};
|
||||
|
||||
const latestVersion: LatestVersion = async (
|
||||
arg: Package | Package[] | PackageJson,
|
||||
options?: LatestVersionOptions,
|
||||
): Promise<any> => {
|
||||
const pkgs: Package[] = [];
|
||||
if (typeof arg === 'string') {
|
||||
pkgs.push(arg);
|
||||
} else if (Array.isArray(arg)) {
|
||||
pkgs.push(...arg);
|
||||
} else if (isPackageJson(arg)) {
|
||||
const addDeps = (deps?: PackageJsonDependencies): void => {
|
||||
if (deps) {
|
||||
pkgs.push(
|
||||
...Object.keys(deps).map((key: string) => `${key}@${deps[key]}`),
|
||||
);
|
||||
}
|
||||
};
|
||||
addDeps(arg.dependencies as PackageJsonDependencies | undefined);
|
||||
addDeps(arg.devDependencies as PackageJsonDependencies | undefined);
|
||||
addDeps(arg.peerDependencies as PackageJsonDependencies | undefined);
|
||||
}
|
||||
|
||||
const jobs = await Promise.allSettled(
|
||||
pkgs.map((pkg) => getInfo(pkg, options)),
|
||||
);
|
||||
const results = jobs.map(
|
||||
(jobResult: PromiseSettledResult<LatestVersionPackage>) =>
|
||||
(jobResult as PromiseFulfilledResult<LatestVersionPackage>).value,
|
||||
);
|
||||
return typeof arg === 'string' ? results[0] : results;
|
||||
};
|
||||
|
||||
export type {
|
||||
LatestVersion,
|
||||
Package,
|
||||
PackageRange,
|
||||
PackageJson,
|
||||
PackageJsonDependencies,
|
||||
RegistryVersions,
|
||||
LatestVersionPackage,
|
||||
RequestOptions,
|
||||
LatestVersionOptions,
|
||||
};
|
||||
export default latestVersion;
|
||||
Reference in New Issue
Block a user