From 3d759b0d56c8975ea881b89fead2c1f3045536ff Mon Sep 17 00:00:00 2001 From: Jake Runzer Date: Mon, 3 Feb 2025 22:28:15 -0800 Subject: [PATCH] update names --- cli/build.go | 2 +- cli/common.go | 2 +- cli/info.go | 2 +- cli/plan.go | 2 +- docs/src/content/docs/reference/cli.md | 18 +++++++++++++----- 5 files changed, 17 insertions(+), 9 deletions(-) diff --git a/cli/build.go b/cli/build.go index 71a71d0..1d25d55 100644 --- a/cli/build.go +++ b/cli/build.go @@ -38,7 +38,7 @@ var BuildCommand = &cli.Command{ Usage: "Show the build plan before building. This is useful for development and debugging.", Value: false, }, - }, commonFlags()...), + }, commonPlanFlags()...), Action: func(ctx context.Context, cmd *cli.Command) error { buildResult, app, env, err := GenerateBuildResultForCommand(cmd) if err != nil { diff --git a/cli/common.go b/cli/common.go index 98d3154..3379f31 100644 --- a/cli/common.go +++ b/cli/common.go @@ -10,7 +10,7 @@ import ( "github.com/urfave/cli/v3" ) -func commonFlags() []cli.Flag { +func commonPlanFlags() []cli.Flag { return []cli.Flag{ &cli.StringSliceFlag{ Name: "env", diff --git a/cli/info.go b/cli/info.go index fddff00..06f0283 100644 --- a/cli/info.go +++ b/cli/info.go @@ -27,7 +27,7 @@ var InfoCommand = &cli.Command{ Name: "out", Usage: "output file name", }, - }, commonFlags()...), + }, commonPlanFlags()...), Action: func(ctx context.Context, cmd *cli.Command) error { buildResult, _, _, err := GenerateBuildResultForCommand(cmd) if err != nil { diff --git a/cli/plan.go b/cli/plan.go index 6500637..13b06bf 100644 --- a/cli/plan.go +++ b/cli/plan.go @@ -22,7 +22,7 @@ var PlanCommand = &cli.Command{ Aliases: []string{"o"}, Usage: "output file name", }, - }, commonFlags()...), + }, commonPlanFlags()...), Action: func(ctx context.Context, cmd *cli.Command) error { buildResult, _, _, err := GenerateBuildResultForCommand(cmd) if err != nil { diff --git a/docs/src/content/docs/reference/cli.md b/docs/src/content/docs/reference/cli.md index ede61bd..f09ad16 100644 --- a/docs/src/content/docs/reference/cli.md +++ b/docs/src/content/docs/reference/cli.md @@ -20,7 +20,8 @@ The following options are available across multiple commands: ### build -Build a project using Railpack. This command takes a directory as input and builds a container image using BuildKit. +Build a project using Railpack. This command takes a directory as input and +builds a container image using BuildKit. **Usage:** @@ -39,7 +40,8 @@ railpack build [options] DIRECTORY ### plan -Generate and view build plans for a project. This command analyzes a directory and outputs the build plan that would be used. +Generate and view build plans for a project. This command analyzes a directory +and outputs the build plan that would be used. **Usage:** @@ -55,7 +57,9 @@ railpack plan [options] DIRECTORY ### info -View detailed information about a project. This command analyzes a directory and provides information about the detected configuration, dependencies, and build requirements. +View detailed information about a project. This command analyzes a directory and +provides information about the detected configuration, dependencies, and build +requirements. **Usage:** @@ -72,7 +76,10 @@ railpack info [options] DIRECTORY ### schema -Output the JSON schema for the Railpack configuration file. This command outputs the schema that defines the structure of valid Railpack configuration files. The schema can be used by IDEs and other tools for providing autocompletion and validation. +Output the JSON schema for the Railpack configuration file. This command outputs +the schema that defines the structure of valid Railpack configuration files. The +schema can be used by IDEs and other tools for providing autocompletion and +validation. **Usage:** @@ -82,7 +89,8 @@ railpack schema ### frontend -Start the BuildKit GRPC frontend server. This command is typically used internally by the build system. +Start the BuildKit GRPC frontend server. This command is typically used +internally by the build system. **Usage:**