Skip to content

fix(flags): normalize short flag consistency across cli-cm-regex-validate, tsgen, migration, and apps-cli #261

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
cs-raj merged 10 commits into from
Jul 3, 2026
Merged

fix(flags): normalize short flag consistency across cli-cm-regex-validate, tsgen, migration, and apps-cli #261

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d840c17
fix(flags): normalize short flag consistency across cli-cm-regex-vali…
cs-raj Jun 30, 2026
1fcb265
updated short flags of external commands
cs-raj Jul 1, 2026
ebefac5
updated unit test workflow
cs-raj Jul 1, 2026
956306e
updated unit test workflow
cs-raj Jul 1, 2026
2136d28
updated unit test workflow and added parallel execution
cs-raj Jul 1, 2026
c03672c
fixed test case and removed parallel test execution
cs-raj Jul 1, 2026
000ca75
fixed seed tests
cs-raj Jul 1, 2026
c57bef9
Removed character flag from the command and removed seed test from wo…
cs-raj Jul 1, 2026
afb8915
Merge branch 'v2-dev' into fix/DX-9363
netrajpatel Jul 3, 2026
5410870
Merge branch 'v2-dev' into fix/DX-9363
netrajpatel Jul 3, 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
1 change: 0 additions & 1 deletion packages/contentstack-apps-cli/src/commands/app/create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ export default class Create extends BaseCommand<typeof Create> {

static flags: FlagInput = {
name: flags.string({
char: "n",
description: appCreate.NAME_DESCRIPTION,
}),
"app-type": flags.string({
Expand Down
1 change: 1 addition & 0 deletions packages/contentstack-apps-cli/src/commands/app/install.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export default class Install extends AppCLIBaseCommand {
description: commonMsg.APP_UID,
}),
"stack-api-key": flags.string({
char: "k",
description: commonMsg.STACK_API_KEY,
}),
...AppCLIBaseCommand.baseFlags,
Expand Down
1 change: 1 addition & 0 deletions packages/contentstack-apps-cli/src/commands/app/reinstall.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export default class Reinstall extends AppCLIBaseCommand {
description: commonMsg.APP_UID,
}),
"stack-api-key": flags.string({
char: "k",
description: commonMsg.STACK_API_KEY,
}),
...AppCLIBaseCommand.baseFlags,
Expand Down
13 changes: 5 additions & 8 deletions packages/contentstack-cli-cm-regex-validate/src/commands/cm/stacks/validate-regex.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,24 @@ export default class ValidateRegex extends Command {
static examples = [
'$ csdx cm:stacks:validate-regex',
'$ csdx cm:stacks:validate-regex -a <management_token_alias>',
'$ csdx cm:stacks:validate-regex -c',
'$ csdx cm:stacks:validate-regex -g',
'$ csdx cm:stacks:validate-regex -f <path/to/the/directory>',
'$ csdx cm:stacks:validate-regex -a <management_token_alias> -c -g',
'$ csdx cm:stacks:validate-regex -a <management_token_alias> -c -g -f <path/to/the/directory>',
'$ csdx cm:stacks:validate-regex --contentType',
'$ csdx cm:stacks:validate-regex --globalField',
'$ csdx cm:stacks:validate-regex --filePath <path/to/the/directory>',
'$ csdx cm:stacks:validate-regex -a <management_token_alias> --contentType --globalField',
'$ csdx cm:stacks:validate-regex -a <management_token_alias> --contentType --globalField --filePath <path/to/the/directory>',
]
static flags: any = {
alias: flags.string({
char: 'a',
description: regexMessages.command.alias,
}),
contentType: flags.boolean({
char: 'c',
description: regexMessages.command.contentTypes,
}),
filePath: flags.string({
char: 'f',
description: regexMessages.command.filePath,
}),
globalField: flags.boolean({
char: 'g',
description: regexMessages.command.globalFields,
}),
}
Expand Down
19 changes: 8 additions & 11 deletions packages/contentstack-cli-tsgen/src/commands/tsgen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
static description = "Generate TypeScript typings from a Stack";

static examples = [
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"',
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"',
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc',
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --include-referenced-entry',
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql',
'$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL" ',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts"',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --prefix "I"',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --no-doc',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --include-referenced-entry',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --api-type graphql',
'$ csdx tsgen -a "delivery token alias" --output "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL" ',
];

// Check if a region is a default Contentstack region
Expand All @@ -46,7 +46,7 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
}

static flags: FlagInput = {
"token-alias": flags.string({
alias: flags.string({
char: "a",
description: "delivery token alias",
hidden: false,
Expand All @@ -55,15 +55,13 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
}),
Comment thread
cs-raj marked this conversation as resolved.

output: flags.string({
char: "o",
description: "full path to output",
hidden: false,
multiple: false,
required: true,
}),

prefix: flags.string({
char: "p",
description: 'interface prefix, e.g. "I"',
hidden: false,
multiple: false,
Expand All @@ -72,7 +70,6 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
}),

doc: flags.boolean({
char: "d",
description: "include documentation comments",
default: true,
allowNo: true,
Expand Down Expand Up @@ -118,7 +115,7 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
try {
const { flags } = await this.parse(TypeScriptCodeGeneratorCommand);

const token = this.getToken(flags["token-alias"]);
const token = this.getToken(flags["alias"]);
const prefix = flags.prefix;
const includeDocumentation = flags.doc;
const filePath = flags.output;
Expand Down
18 changes: 9 additions & 9 deletions packages/contentstack-cli-tsgen/tests/integration/tsgen.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ describe("Integration Test for tsgen command", () => {
// Test case 1: Generate TypeScript types with default flags
it("should generate TypeScript types with the default flags", () => {
const cmd = "csdx";
const args = ["tsgen", "-a", tokenAlias!, "-o", outputFilePath];
const args = ["tsgen", "-a", tokenAlias!, "--output", outputFilePath];
Comment thread
cs-raj marked this conversation as resolved.

const result = spawnSync(cmd, args, { encoding: "utf-8" });

Expand All @@ -44,9 +44,9 @@ describe("Integration Test for tsgen command", () => {
"tsgen",
"-a",
tokenAlias!,
"-o",
"--output",
outputFilePath,
"-p",
"--prefix",
prefix,
];

Expand All @@ -72,7 +72,7 @@ describe("Integration Test for tsgen command", () => {
// Test case 3: Generate TypeScript types without documentation comments
it("should generate TypeScript types without documentation", () => {
const cmd = "csdx";
const args = ["tsgen", "-a", tokenAlias!, "-o", outputFilePath, "--no-doc"];
const args = ["tsgen", "-a", tokenAlias!, "--output", outputFilePath, "--no-doc"];

const result = spawnSync(cmd, args, { encoding: "utf-8" });

Expand All @@ -90,7 +90,7 @@ describe("Integration Test for tsgen command", () => {
"tsgen",
"-a",
tokenAlias!,
"-o",
"--output",
outputFilePath,
"--include-system-fields",
];
Expand All @@ -108,7 +108,7 @@ describe("Integration Test for tsgen command", () => {
// Test case 5: Handling of invalid token alias
it("should fail with an invalid token alias", () => {
const cmd = "csdx";
const args = ["tsgen", "-a", "invalid_alias", "-o", outputFilePath];
const args = ["tsgen", "-a", "invalid_alias", "--output", outputFilePath];

const result = spawnSync(cmd, args, { encoding: "utf-8" });

Expand All @@ -124,7 +124,7 @@ describe("Integration Test for tsgen command", () => {
"tsgen",
"-a",
tokenAlias!,
"-o",
"--output",
outputFilePath,
"--api-type",
"graphql",
Expand All @@ -147,7 +147,7 @@ describe("Integration Test for tsgen command", () => {
"tsgen",
"-a",
tokenAlias!,
"-o",
"--output",
outputFilePath,
"--api-type",
"graphql",
Expand All @@ -171,7 +171,7 @@ describe("Integration Test for tsgen command", () => {
"tsgen",
"-a",
"invalid_alias",
"-o",
"--output",
outputFilePath,
"--api-type",
"graphql",
Expand Down
1 change: 0 additions & 1 deletion packages/contentstack-external-migrate/src/commands/migrate/convert.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export default class MigrateConvert extends Command {
description: 'Destination master locale code',
}),
affix: flags.string({
char: 'a',
description: 'Content-type UID prefix',
default: '',
}),
Comment thread
cs-raj marked this conversation as resolved.
Expand Down
1 change: 0 additions & 1 deletion packages/contentstack-migration/src/commands/cm/stacks/migration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ export default class MigrationCommand extends Command {

// To be deprecated
'api-key': flags.string({
char: 'k',
description: 'With this flag add the API key of your stack.',
// dependsOn: ['authtoken'],
exclusive: ['alias'],
Expand Down
Loading