Skip to content

fix: remove get-package-info and resolve dependencies #1906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MarshallOfSound merged 1 commit into from
Apr 22, 2026
Merged

fix: remove get-package-info and resolve dependencies #1906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ feature. Known modules include:
* `electron-notarize*`
* `electron-osx-sign`
* `electron-packager` (always use this one before filing an issue)
* `get-package-info`

We use the [`debug`](https://www.npmjs.com/package/debug#usage) module for this functionality. It
has examples on how to set environment variables if you don't know how.
Expand Down
3 changes: 0 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,11 @@
"extract-zip": "^2.0.1",
"filenamify": "^6.0.0",
"galactus": "^2.0.2",
"get-package-info": "^1.0.0",
"graceful-fs": "^4.2.11",
"junk": "^4.0.1",
"parse-author": "^2.0.0",
"plist": "^3.1.0",
"resedit": "^2.0.3",
"resolve": "^1.22.10",
"semver": "^7.7.2",
"yargs-parser": "^22.0.0"
},
Expand All @@ -64,7 +62,6 @@
"@types/node": "~22.10.7",
"@types/parse-author": "^2.0.2",
"@types/plist": "^3.0.5",
"@types/resolve": "^1.20.6",
"@types/semver": "^7.7.0",
"@types/yargs-parser": "^21.0.3",
"husky": "^9.1.7",
Expand Down
32 changes: 0 additions & 32 deletions src/ambient.d.ts
View file
Open in desktop

This file was deleted.

254 changes: 112 additions & 142 deletions src/infer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,176 +1,146 @@
import getPackageInfo, {
GetPackageInfoError,
GetPackageInfoResult,
GetPackageInfoResultSourceItem,
} from 'get-package-info';
import parseAuthor from 'parse-author';
import path from 'node:path';
import resolve, { AsyncOpts } from 'resolve';
import { createRequire } from 'node:module';
import { promisifiedGracefulFs } from './util.js';
import { debug } from './common.js';
import { OfficialPlatform, Options, ProcessedOptions } from './types.js';

function isMissingRequiredProperty(props: string[]) {
return props.some((prop) => prop === 'productName' || prop === 'dependencies.electron');
}

function errorMessageForProperty(prop: string) {
let hash, propDescription;
switch (prop) {
case 'productName':
hash = 'name';
propDescription = 'application name';
break;
case 'dependencies.electron':
hash = 'electronversion';
propDescription = 'Electron version';
break;
case 'version':
hash = 'appversion';
propDescription = 'application version';
break;
/* istanbul ignore next */
default:
hash = '';
propDescription = `[Unknown Property (${prop})]`;
type PackageJSON = {
name?: string;
productName?: string;
version?: string;
author?: string | { name?: string };
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
};

const ELECTRON_PACKAGES = ['electron', 'electron-nightly'] as const;

async function* walkPackageJSONs(dir: string): AsyncGenerator<{ src: string; pkg: PackageJSON }> {
let prev: string | undefined;
let cur = path.resolve(dir);
while (cur !== prev) {
const src = path.join(cur, 'package.json');
try {
const contents = await promisifiedGracefulFs.readFile(src, 'utf8');
yield { src, pkg: JSON.parse(contents.replace(/^\uFEFF/, '')) };
} catch (err) {
if ((err as NodeJS.ErrnoException).code !== 'ENOENT') throw err;
}
prev = cur;
cur = path.dirname(cur);
}
}

function errorMessageForProperty(propDescription: string, hash: string) {
return (
`Unable to determine ${propDescription}. Please specify an ${propDescription}\n\n` +
'For more information, please see\n' +
`https://electron.github.io/packager/main/interfaces/Options.html#${hash}\n`
);
}

function resolvePromise(id: string, options: AsyncOpts) {
return new Promise<[string | undefined, { version: string }]>(
// eslint-disable-next-line promise/param-names
(accept, reject) => {
resolve(id, options, (err, mainPath, pkg) => {
if (err) {
/* istanbul ignore next */
reject(err);
} else {
accept([mainPath as string | undefined, pkg as { version: string }]);
}
});
},
);
}

async function getVersion(electronProp: GetPackageInfoResultSourceItem) {
const [, packageName] = electronProp.prop.split('.');
const src = electronProp.src;

const pkg = (await resolvePromise(packageName, { basedir: path.dirname(src) }))[1];
debug(`Inferring target Electron version from ${packageName} in ${src}`);
async function resolveElectronVersion(packageName: string, fromSrc: string) {
const pkgJsonPath = createRequire(fromSrc).resolve(`${packageName}/package.json`);
const pkg = JSON.parse(await promisifiedGracefulFs.readFile(pkgJsonPath, 'utf8'));
debug(`Inferring target Electron version from ${packageName} in ${fromSrc}`);
return pkg.version;
}

async function handleMetadata(
opts: Options,
result: GetPackageInfoResult,
): Promise<Partial<ProcessedOptions>> {
const processedValues: Partial<ProcessedOptions> = {};

if (typeof result.values.productName === 'string') {
debug(
`Inferring application name from ${result.source.productName.prop} in ${result.source.productName.src}`,
);
processedValues.name = result.values.productName;
}

if (typeof result.values.version === 'string') {
debug(`Inferring appVersion from version in ${result.source.version.src}`);
processedValues.appVersion = result.values.version;
}

if (result.values.author) {
const author = result.values.author as string | { name: string };
const win32metadata = opts.win32metadata || {};

debug(`Inferring win32metadata.CompanyName from author in ${result.source.author.src}`);
if (typeof author === 'string') {
win32metadata.CompanyName = parseAuthor(author).name;
} else if (author.name) {
win32metadata.CompanyName = author.name;
} else {
debug('Cannot infer win32metadata.CompanyName from author, no name found');
}
processedValues.win32metadata = win32metadata;
}

if (Object.prototype.hasOwnProperty.call(result.values, 'dependencies.electron')) {
processedValues.electronVersion = await getVersion(result.source['dependencies.electron']);
}

return processedValues;
}

function handleMissingProperties(
opts: Options,
err: GetPackageInfoError,
): Promise<Partial<ProcessedOptions>> {
const missingProps = err.missingProps.map((prop) => {
return Array.isArray(prop) ? prop[0] : prop;
});

if (isMissingRequiredProperty(missingProps)) {
const messages = missingProps.map(errorMessageForProperty);

debug(err.message);
err.message = messages.join('\n') + '\n';
throw err;
} else {
// Missing props not required, can continue w/ partial result
return handleMetadata(opts, err.result);
}
}

export async function getMetadataFromPackageJSON(
platforms: OfficialPlatform[],
opts: Options,
dir: string,
): Promise<Partial<ProcessedOptions>> {
const props: Array<string | string[]> = [];
const result: Partial<ProcessedOptions> = {};

if (!opts.name) {
props.push(['productName', 'name']);
}
let needName = !opts.name;
let needVersion = !opts.appVersion;
let needElectron = !opts.electronVersion;
let needAuthor = platforms.includes('win32') && !opts.win32metadata?.CompanyName;

if (!opts.appVersion) {
props.push('version');
if (needAuthor) {
debug('Requiring author in package.json, as CompanyName was not specified for win32metadata');
}

if (!opts.electronVersion) {
props.push([
'dependencies.electron',
'devDependencies.electron',
'dependencies.electron-nightly',
'devDependencies.electron-nightly',
]);
}
const initiallyNeeded = [
needName && 'productName',
needVersion && 'version',
needElectron && 'dependencies.electron',
needAuthor && 'author',
].filter(Boolean) as string[];

if (!initiallyNeeded.length) return result;

for await (const { src, pkg } of walkPackageJSONs(dir)) {
if (needName) {
const name = pkg.productName ?? pkg.name;
if (name !== undefined) {
const field = pkg.productName !== undefined ? 'productName' : 'name';
debug(`Inferring application name from ${field} in ${src}`);
result.name = name;
needName = false;
}
}

if (platforms.includes('win32') && !(opts.win32metadata && opts.win32metadata.CompanyName)) {
debug('Requiring author in package.json, as CompanyName was not specified for win32metadata');
props.push('author');
}
if (needVersion && pkg.version !== undefined) {
debug(`Inferring appVersion from version in ${src}`);
result.appVersion = pkg.version;
needVersion = false;
}

// Search package.json files to infer name and version from
try {
const packageInfo = await getPackageInfo(props, dir);
return handleMetadata(opts, packageInfo);
} catch (e) {
const err = e as GetPackageInfoError;

if (err.missingProps) {
if (err.missingProps.length === props.length) {
debug(err.message);
err.message = `Could not locate a package.json file in "${path.resolve(opts.dir)}" or its parent directories for an Electron app with the following fields: ${err.missingProps.join(', ')}`;
if (needAuthor && pkg.author !== undefined) {
debug(`Inferring win32metadata.CompanyName from author in ${src}`);
const win32metadata = opts.win32metadata || {};
if (typeof pkg.author === 'string') {
win32metadata.CompanyName = parseAuthor(pkg.author).name;
} else if (pkg.author.name) {
win32metadata.CompanyName = pkg.author.name;
} else {
return handleMissingProperties(opts, err);
debug('Cannot infer win32metadata.CompanyName from author, no name found');
}
result.win32metadata = win32metadata;
needAuthor = false;
}

if (needElectron) {
for (const packageName of ELECTRON_PACKAGES) {
if (
pkg.dependencies?.[packageName] !== undefined ||
pkg.devDependencies?.[packageName] !== undefined
) {
result.electronVersion = await resolveElectronVersion(packageName, src);
needElectron = false;
break;
}
}
}

throw err;
if (!needName && !needVersion && !needElectron && !needAuthor) break;
}

const stillMissing = [
needName && 'productName',
needVersion && 'version',
needElectron && 'dependencies.electron',
needAuthor && 'author',
].filter(Boolean) as string[];

if (stillMissing.length) {
if (stillMissing.length === initiallyNeeded.length) {
throw new Error(
`Could not locate a package.json file in "${path.resolve(opts.dir)}" or its parent directories for an Electron app with the following fields: ${initiallyNeeded.join(', ')}`,
);
}
if (needName || needElectron) {
const messages: string[] = [];
if (needName) messages.push(errorMessageForProperty('application name', 'name'));
if (needVersion) messages.push(errorMessageForProperty('application version', 'appversion'));
if (needElectron)
messages.push(errorMessageForProperty('Electron version', 'electronversion'));
throw new Error(messages.join('\n') + '\n');
}
}

return result;
}
Loading
Loading