Skip to content
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.

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

fix bugs #1

Open
wants to merge 2 commits into
base: pnpm
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
20 changes: 14 additions & 6 deletions source/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {asyncExitHook} from 'exit-hook';
import logSymbols from 'log-symbols';
import prerequisiteTasks from './prerequisite-tasks.js';
import gitTasks from './git-tasks.js';
import {getPackagePublishArguments} from './npm/publish.js';
import {getPackagePublishArguments as getAdditionalPackagePublishArguments} from './npm/publish.js';
import enable2fa, {getEnable2faArgs} from './npm/enable-2fa.js';
import releaseTaskHelper from './release-task-helper.js';
import * as util from './util.js';
Expand All @@ -32,7 +32,7 @@ const exec = (cmd, args, options) => {
*/
const np = async (input = 'patch', options, {pkg, rootDir}) => {
const pkgManager = getPackageManagerConfig(rootDir, pkg);
const publishCli = pkgManager.publishCli || pkgManager.cli;
const [publishCommand, publishArgsPrefix = []] = pkgManager.publishCli || [pkgManager.cli];

// TODO: Remove sometime far in the future
if (options.skipCleanup) {
Expand Down Expand Up @@ -96,6 +96,11 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
// To prevent the process from hanging due to watch mode (e.g. when running `vitest`)
const ciEnvOptions = {env: {CI: 'true'}};

function getPackagePublishArguments(options) {
const args = getAdditionalPackagePublishArguments(options);
return [...publishArgsPrefix, ...args];
}

const tasks = new Listr([
{
title: 'Prerequisite check',
Expand All @@ -117,7 +122,10 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
task: () => new Listr([
{
title: 'Running install command',
task: () => exec(...pkgManager.installCommand),
task() {
const installCommand = lockfile ? pkgManager.installCommand : pkgManager.installCommandNoLockfile;
return exec(...installCommand);
},
},
{
title: 'Checking working tree is still clean', // If lockfile was out of date and tracked by git, this will fail
Expand Down Expand Up @@ -159,19 +167,19 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
skip() {
if (options.preview) {
const args = getPackagePublishArguments(options);
return `[Preview] Command not executed: ${publishCli} ${args.join(' ')}.`;
return `[Preview] Command not executed: ${publishCommand} ${args.join(' ')}.`;
}
},
/** @type {(context, task) => Listr.ListrTaskResult<any>} */
task(context, task) {
let hasError = false;

return from(execa(publishCli, getPackagePublishArguments(options)))
return from(execa(publishCommand, getPackagePublishArguments(options)))
.pipe(
catchError(error => handleNpmError(error, task, otp => {
context.otp = otp;

return execa(publishCli, getPackagePublishArguments({...options, otp}));
return execa(publishCommand, getPackagePublishArguments({...options, otp}));
})),
)
.pipe(
Expand Down
22 changes: 11 additions & 11 deletions source/package-manager/configs.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,22 @@ export const npmConfig = {
cli: 'npm',
id: 'npm',
installCommand: ['npm', ['ci', '--engine-strict']],
installCommandNoLockfile: ['npm', ['install', '--no-package-lock', '--no-production', '--engine-strict']],
versionCommand: version => ['npm', ['version', version]],
getRegistryCommand: ['npm', ['config', 'get', 'registry']],
tagVersionPrefixCommand: ['npm', ['config', 'get', 'tag-version-prefix']],
lockfiles: ['package-lock.json', 'npm-shrinkwrap.json'],
};

/** @type {import('./types.d.ts').PackageManagerConfig} */
export const npmConfigNoLockfile = {
...npmConfig,
installCommand: ['npm', ['install', '--no-package-lock', '--no-production', '--engine-strict']],
};

/** @type {import('./types.d.ts').PackageManagerConfig} */
export const pnpmConfig = {
cli: 'pnpm',
id: 'pnpm',
installCommand: ['pnpm', ['install']],
installCommandNoLockfile: ['pnpm', ['install']],
versionCommand: version => ['pnpm', ['version', version]],
tagVersionPrefixCommand: ['pnpm', ['config', 'get', 'tag-version-prefix']],
publishCli: 'npm', // Pnpm does git cleanliness checks, which np already did, and which fail because when publishing package.json has been updated
publishCli: ['npm'], // Pnpm does git cleanliness checks, which np already did, and which fail because when publishing package.json has been updated
getRegistryCommand: ['pnpm', ['config', 'get', 'registry']],
lockfiles: ['pnpm-lock.yaml'],
};
Expand All @@ -31,7 +27,8 @@ export const pnpmConfig = {
export const yarnConfig = {
cli: 'yarn',
id: 'yarn',
installCommand: ['yarn', ['install', '--production=false']],
installCommand: ['yarn', ['install', '--frozen-lockfile', '--production=false']],
installCommandNoLockfile: ['yarn', ['install', '--production=false']],
getRegistryCommand: ['yarn', ['config', 'get', 'registry']],
tagVersionPrefixCommand: ['yarn', ['config', 'get', 'version-tag-prefix']],
versionCommand: version => ['yarn', ['version', '--new-version', version]],
Expand All @@ -42,10 +39,13 @@ export const yarnConfig = {
export const yarnBerryConfig = {
cli: 'yarn',
id: 'yarn-berry',
installCommand: ['yarn', ['install']],
versionCommand: version => ['yarn', ['version', '--new-version', version]],
installCommand: ['yarn', ['install', '--immutable']],
installCommandNoLockfile: ['yarn', ['install']],
// Yarn berry doesn't support git committing/tagging, so we use npm instead
versionCommand: version => ['npm', ['version', version]],
tagVersionPrefixCommand: ['yarn', ['config', 'get', 'version-tag-prefix']],
publishCli: 'npm', // Yarn berry doesn't support git committing/tagging, so use npm
// Yarn berry offloads publishing to npm, e.g. `yarn npm publish x.y.z`
publishCli: ['yarn', ['npm']],
getRegistryCommand: ['yarn', ['config', 'get', 'npmRegistryServer']],
throwOnExternalRegistry: true,
lockfiles: ['yarn.lock'],
Expand Down
9 changes: 2 additions & 7 deletions source/package-manager/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import fs from 'node:fs';
import path from 'node:path';
import semver from 'semver';
import {npmConfig, yarnBerryConfig, pnpmConfig, yarnConfig, npmConfigNoLockfile} from './configs.js';
import {npmConfig, yarnBerryConfig, pnpmConfig, yarnConfig} from './configs.js';

/**
@param {string} rootDir
Expand All @@ -18,12 +18,7 @@ export function findLockFile(rootDir, config) {
@param {import('read-pkg').NormalizedPackageJson} pkg
*/
export function getPackageManagerConfig(rootDir, pkg) {
let config = configFromPackageManagerField(pkg);

if (config === npmConfig && !findLockFile(rootDir, config)) {
config = npmConfigNoLockfile;
}

const config = configFromPackageManagerField(pkg);
return config || configFromLockfile(rootDir) || npmConfig;
}

Expand Down
13 changes: 9 additions & 4 deletions source/package-manager/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,24 @@ export type PackageManagerConfig = {
id: string;

/**
How to install packages, e.g. `["npm", ["install"]]`.
How to install packages (when there is a lockfile), e.g. `["npm", ["install"]]`.
*/
installCommand: Command;

/**
How to install packages (when there is no lockfile), e.g. `["npm", ["install"]]`.
*/
installCommandNoLockfile: Command;
mifi marked this conversation as resolved.
Show resolved Hide resolved

/**
Given a version string, return a version command e.g. `version => ["npm", ["version", version]]`.
*/
versionCommand: (version: string) => [cli: string, args: string[]];
versionCommand: (version: string) => [command: string, args: string[]];

/**
Use a different CLI to do the actual publish. Defaults to `cli`.
Use a different CLI (and prefix args) to do the actual publish. Defaults to [`cli`].
*/
publishCli?: string;
publishCli?: [command: string, prefixArgs?: string[]];

/**
CLI command which is expected to output the npm registry to use, e.g. `['npm', ['config', 'get', 'registry']]`.
Expand Down