Skip to content

fix(list-templates): treat --spfx-version as output filter instead of branch selector #259

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

Open
vystartasv wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix(list-templates): treat --spfx-version as output filter instead of branch selector #259

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a97e38
fix(list-templates): treat --spfx-version as output filter instead of…
vystartasv Jul 10, 2026
ab63fb9
fix: normalize version matching in --spfx-version filter
vystartasv Jul 11, 2026
e3b63a3
fix: change SPFxTemplateCollection from type-only to value import
vystartasv Jul 13, 2026
769d322
chore: add change file for --spfx-version filter
vystartasv Jul 13, 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
25 changes: 22 additions & 3 deletions apps/spfx-cli/src/cli/actions/ListTemplatesAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ export class ListTemplatesAction extends SPFxActionBase {
summary: 'Lists available SPFx templates from configured sources',
documentation:
'This command lists all available templates from the default GitHub source ' +
'and any additional sources specified with --local-source or --remote-source.'
'and any additional sources specified with --local-source or --remote-source. ' +
'Use --spfx-version to filter templates by version (e.g., "--spfx-version 1.22").'
Comment on lines 16 to +18
},
terminal
);
Expand All @@ -37,8 +38,26 @@ export class ListTemplatesAction extends SPFxActionBase {

const templates: SPFxTemplateCollection = await this._fetchTemplatesAsync(manager);

const formattedTable: string = await templates.toFormattedStringAsync();
terminal.writeLine(formattedTable);
// Apply --spfx-version filter if provided (user expects filter, not just branch selection)
const spfxVersion: string | undefined = this._spfxVersionParameter.value?.trim();
if (spfxVersion) {
const filteredTemplates = [...templates.values()].filter(
(t) => t.spfxVersion && t.spfxVersion.startsWith(spfxVersion)
);
Comment on lines +42 to +52
if (filteredTemplates.length === 0) {
terminal.writeLine(
`No templates found for SPFx version "${spfxVersion}". ` +
`Use "spfx list-templates" (without --spfx-version) to see all available versions.`
);
return;
Comment on lines +41 to +58
Comment on lines +41 to +58
}
const displayCollection: SPFxTemplateCollection = new SPFxTemplateCollection(filteredTemplates);
const formattedTable: string = await displayCollection.toFormattedStringAsync();
terminal.writeLine(formattedTable);
Comment on lines +47 to +62
} else {
const formattedTable: string = await templates.toFormattedStringAsync();
terminal.writeLine(formattedTable);
}
} catch (error: unknown) {
const message: string = error instanceof Error ? error.message : String(error);
terminal.writeErrorLine(`Error listing templates: ${message}`);
Expand Down