Skip to content

refactor: standardize method naming and clarify log messages #79

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
wants to merge 1 commit into
base: pranaygp/deduplicate-config-generation
Choose a base branch
from
+17 −23
Open

refactor: standardize method naming and clarify log messages #79

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
6 changes: 6 additions & 0 deletions .changeset/standardize-naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@workflow/builders": patch
"@workflow/cli": patch
---

Standardize method naming conventions
2 changes: 1 addition & 1 deletion packages/builders/src/base-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ export const POST = workflowEntrypoint(workflowCode);`;
await interimBundleCtx.dispose();
}

protected async buildClientLibrary(): Promise<void> {
protected async createClientLibrary(): Promise<void> {
if (!this.config.clientBundlePath) {
// Silently exit since no client bundle was requested
return;
Expand Down
14 changes: 4 additions & 10 deletions packages/builders/src/standalone.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export class StandaloneBuilder extends BaseBuilder {
await this.buildWorkflowsBundle(options);
await this.buildWebhookFunction();

await this.buildClientLibrary();
await this.createClientLibrary();
}

private async buildStepsBundle({
Expand All @@ -28,10 +28,7 @@ export class StandaloneBuilder extends BaseBuilder {
tsBaseUrl?: string;
tsPaths?: Record<string, string[]>;
}): Promise<void> {
console.log(
'Creating Vercel API steps bundle at',
this.config.stepsBundlePath
);
console.log('Creating steps bundle at', this.config.stepsBundlePath);

const stepsBundlePath = resolve(
this.config.workingDir,
Expand Down Expand Up @@ -59,7 +56,7 @@ export class StandaloneBuilder extends BaseBuilder {
tsPaths?: Record<string, string[]>;
}): Promise<void> {
console.log(
'Creating vercel API workflows bundle at',
'Creating workflows bundle at',
this.config.workflowsBundlePath
);

Expand All @@ -80,10 +77,7 @@ export class StandaloneBuilder extends BaseBuilder {
}

private async buildWebhookFunction(): Promise<void> {
console.log(
'Creating vercel API webhook bundle at',
this.config.webhookBundlePath
);
console.log('Creating webhook bundle at', this.config.webhookBundlePath);

const webhookBundlePath = resolve(
this.config.workingDir,
Expand Down
2 changes: 1 addition & 1 deletion packages/builders/src/vercel-build-output-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class VercelBuildOutputAPIBuilder extends BaseBuilder {
await this.buildWebhookFunction(options);
await this.createBuildOutputConfig(outputDir);

await this.buildClientLibrary();
await this.createClientLibrary();
}

private async buildStepsFunction({
Expand Down
14 changes: 4 additions & 10 deletions packages/cli/src/lib/builders/standalone.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export class StandaloneBuilder extends BaseBuilder {
await this.buildWorkflowsBundle(options);
await this.buildWebhookFunction();

await this.buildClientLibrary();
await this.createClientLibrary();
}

private async buildStepsBundle({
Expand All @@ -28,10 +28,7 @@ export class StandaloneBuilder extends BaseBuilder {
tsBaseUrl?: string;
tsPaths?: Record<string, string[]>;
}): Promise<void> {
console.log(
'Creating Vercel API steps bundle at',
this.config.stepsBundlePath
);
console.log('Creating steps bundle at', this.config.stepsBundlePath);

const stepsBundlePath = resolve(
this.config.workingDir,
Expand Down Expand Up @@ -59,7 +56,7 @@ export class StandaloneBuilder extends BaseBuilder {
tsPaths?: Record<string, string[]>;
}): Promise<void> {
console.log(
'Creating vercel API workflows bundle at',
'Creating workflows bundle at',
this.config.workflowsBundlePath
);

Expand All @@ -80,10 +77,7 @@ export class StandaloneBuilder extends BaseBuilder {
}

private async buildWebhookFunction(): Promise<void> {
console.log(
'Creating vercel API webhook bundle at',
this.config.webhookBundlePath
);
console.log('Creating webhook bundle at', this.config.webhookBundlePath);

const webhookBundlePath = resolve(
this.config.workingDir,
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/lib/builders/vercel-build-output-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class VercelBuildOutputAPIBuilder extends BaseBuilder {
await this.buildWebhookFunction(options);
await this.createBuildOutputConfig(outputDir);

await this.buildClientLibrary();
await this.createClientLibrary();
}

private async buildStepsFunction({
Expand Down
Loading