Skip to content

@W-21768097 Block sf package convert calls outside of sfdx project directory #1160

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
iowillhoit merged 3 commits into from
Apr 9, 2026
Merged

@W-21768097 Block sf package convert calls outside of sfdx project directory #1160

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17fce00
feat: fail fast logic for convert commands not run in project dir
ravipanguluri Mar 30, 2026
83ccd8d
chore: remove uneeded type assertion
ravipanguluri Mar 30, 2026
e0a31ea
test: remove uneeded test
ravipanguluri Apr 9, 2026
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
13 changes: 4 additions & 9 deletions src/commands/package/convert.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
import { Lifecycle, Messages, SfError, SfProject } from '@salesforce/core';
import { Lifecycle, Messages, SfError } from '@salesforce/core';
import {
INSTALL_URL_BASE,
Package,
Expand All @@ -37,6 +37,7 @@ export class PackageConvert extends SfCommand<PackageVersionCreateRequestResult>
public static readonly examples = messages.getMessages('examples');
public static readonly deprecateAliases = true;
public static readonly aliases = ['force:package:convert'];
public static readonly requiresProject = true;

@luop90 luop90 Apr 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this boolean actually doing anything? I don't see it referenced in your PR besides the unit test

@ravipanguluri ravipanguluri Apr 9, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's used within logic that's in the sf-plugins-core. When the parameter is true, then during the command initialization we attempt to resolve an sf project directory from the current working directory. If it doesn't exist then an error is thrown. This does bring up that the point that the unit test is not particularly useful.

public static readonly flags = {
loglevel,
'target-dev-hub': requiredHubFlag,
Expand Down Expand Up @@ -128,13 +129,7 @@ export class PackageConvert extends SfCommand<PackageVersionCreateRequestResult>
} else {
this.spinner.start('Converting Package', 'Initializing');
}
// initialize the project instance if in a project
let project: SfProject | undefined;
try {
project = await SfProject.resolve();
} catch (err) {
// ignore project is optional
}

const result = await Package.convert(
flags.package,
flags['target-dev-hub'].getConnection(flags['api-version']),
Expand All @@ -148,7 +143,7 @@ export class PackageConvert extends SfCommand<PackageVersionCreateRequestResult>
patchversion: flags['patch-version'] as string,
codecoverage: flags['code-coverage'] as boolean,
},
project
this.project
);

switch (result.Status) {
Expand Down
4 changes: 4 additions & 0 deletions test/commands/package/packageConvert.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ describe('package:convert', () => {
$$.restore();
});

it('should require an sfdx project', () => {
expect(PackageConvert.requiresProject).to.be.true;
});

it('returns error for missing installationkey or installationkeybypass flag', async () => {
const expectedErrorMsg =
'Exactly one of the following must be provided: --installation-key, --installation-key-bypass';
Expand Down
Loading