Update src to use 125 max line long for easier GitHub reviews (#880)

* auto format

* comments

* semi-manual

* cspell

* cspell again

Author: vhvb1989

cli/azd/.golangci.yaml

@@ -2,8 +2,12 @@ linters:
   enable:
     - errorlint
     - gofmt
+    - lll
 linters-settings:
   errorlint:
     errorf: true
     asserts: true
-    comparison: true
+    comparison: true
+  lll:
+    # GitHub recommended for code review
+    line-length: 125

cli/azd/cmd/deploy.go

@@ -29,6 +29,7 @@ func deployCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command {
 		"deploy",
 		"Deploy the application's code to Azure.",
 		&commands.BuildOptions{
+			//nolint:lll
 			Long: `Deploy the application's code to Azure.
 
 When no ` + output.WithBackticks("--service") + ` value is specified, all services in the ` + output.WithBackticks("azure.yaml") + ` file (found in the root of your project) are deployed.
@@ -62,7 +63,13 @@ func (d *deployAction) SetupFlags(
 	persis *pflag.FlagSet,
 	local *pflag.FlagSet,
 ) {
-	local.StringVar(&d.serviceName, "service", "", "Deploys a specific service (when the string is unspecified, all services that are listed in the "+azdcontext.ProjectFileName+" file are deployed).")
+	local.StringVar(
+		&d.serviceName,
+		"service",
+		"",
+		"Deploys a specific service (when the string is unspecified, "+
+			"all services that are listed in the "+azdcontext.ProjectFileName+" file are deployed).",
+	)
 }
 
 func (d *deployAction) Run(ctx context.Context, cmd *cobra.Command, args []string, azdCtx *azdcontext.AzdContext) error {
@@ -185,7 +192,12 @@ func (d *deployAction) Run(ctx context.Context, cmd *cobra.Command, args []strin
 	return nil
 }
 
-func reportServiceDeploymentResultInteractive(ctx context.Context, console input.Console, svc *project.Service, sdr *project.ServiceDeploymentResult) {
+func reportServiceDeploymentResultInteractive(
+	ctx context.Context,
+	console input.Console,
+	svc *project.Service,
+	sdr *project.ServiceDeploymentResult,
+) {
 	var builder strings.Builder
 
 	builder.WriteString(fmt.Sprintf("Deployed service %s\n", output.WithHighLightFormat(svc.Config.Name)))

cli/azd/cmd/env.go

@@ -26,6 +26,7 @@ func envCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command {
 	root := &cobra.Command{
 		Use:   "env",
 		Short: "Manage environments.",
+		//nolint:lll
 		Long: `Manage environments.
 
 With this command group, you can create a new environment or get, set, and list your application environments. An application can have multiple environments (for example, dev, test, prod), each with a different configuration (that is, connectivity information) for accessing Azure resources. 
@@ -70,7 +71,12 @@ func envSetCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command {
 		}
 
 		//lint:ignore SA4006 // We want ctx overridden here for future changes
-		env, ctx, err := loadOrInitEnvironment(ctx, &rootOptions.EnvironmentName, azdCtx, console) //nolint:ineffassign,staticcheck
+		env, ctx, err := loadOrInitEnvironment( //nolint:ineffassign,staticcheck
+			ctx,
+			&rootOptions.EnvironmentName,
+			azdCtx,
+			console,
+		)
 		if err != nil {
 			return fmt.Errorf("loading environment: %w", err)
 		}
@@ -190,7 +196,12 @@ type envNewAction struct {
 }
 
 func (en *envNewAction) SetupFlags(persis *pflag.FlagSet, local *pflag.FlagSet) {
-	local.StringVar(&en.subscription, "subscription", "", "Name or ID of an Azure subscription to use for the new environment")
+	local.StringVar(
+		&en.subscription,
+		"subscription",
+		"",
+		"Name or ID of an Azure subscription to use for the new environment",
+	)
 	local.StringVarP(&en.location, "location", "l", "", "Azure location for the new environment")
 }
 
@@ -306,7 +317,12 @@ func envGetValuesCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command
 			writer := output.GetWriter(ctx)
 
 			//lint:ignore SA4006 // We want ctx overridden here for future changes
-			env, ctx, err := loadOrInitEnvironment(ctx, &rootOptions.EnvironmentName, azdCtx, console) //nolint:ineffassign,staticcheck
+			env, ctx, err := loadOrInitEnvironment( //nolint:ineffassign,staticcheck
+				ctx,
+				&rootOptions.EnvironmentName,
+				azdCtx,
+				console,
+			)
 			if err != nil {
 				return err
 			}

cli/azd/cmd/infra_create.go

@@ -47,7 +47,12 @@ func (ica *infraCreateAction) SetupFlags(persis, local *pflag.FlagSet) {
 	local.BoolVar(&ica.noProgress, "no-progress", false, "Suppresses progress information.")
 }
 
-func (ica *infraCreateAction) Run(ctx context.Context, cmd *cobra.Command, args []string, azdCtx *azdcontext.AzdContext) error {
+func (ica *infraCreateAction) Run(
+	ctx context.Context,
+	cmd *cobra.Command,
+	args []string,
+	azdCtx *azdcontext.AzdContext,
+) error {
 	azCli := azcli.GetAzCli(ctx)
 	console := input.GetConsole(ctx)
 
@@ -100,19 +105,28 @@ func (ica *infraCreateAction) Run(ctx context.Context, cmd *cobra.Command, args
 		if formatter.Kind() == output.JsonFormat {
 			stateResult, err := infraManager.State(ctx, provisioningScope)
 			if err != nil {
-				return fmt.Errorf("deployment failed and the deployment result is unavailable: %w", multierr.Combine(err, err))
+				return fmt.Errorf(
+					"deployment failed and the deployment result is unavailable: %w",
+					multierr.Combine(err, err),
+				)
 			}
 
-			if err := formatter.Format(contracts.NewEnvRefreshResultFromProvisioningState(stateResult.State), writer, nil); err != nil {
-				return fmt.Errorf("deployment failed and the deployment result could not be displayed: %w", multierr.Combine(err, err))
+			if err := formatter.Format(
+				contracts.NewEnvRefreshResultFromProvisioningState(stateResult.State), writer, nil); err != nil {
+				return fmt.Errorf(
+					"deployment failed and the deployment result could not be displayed: %w",
+					multierr.Combine(err, err),
+				)
 			}
 		}
 
 		return fmt.Errorf("deployment failed: %w", err)
 	}
 
 	for _, svc := range prj.Services {
-		if err := svc.RaiseEvent(ctx, project.Deployed, map[string]any{"bicepOutput": deployResult.Deployment.Outputs}); err != nil {
+		if err := svc.RaiseEvent(
+			ctx, project.Deployed,
+			map[string]any{"bicepOutput": deployResult.Deployment.Outputs}); err != nil {
 			return err
 		}
 	}
@@ -125,7 +139,12 @@ func (ica *infraCreateAction) Run(ctx context.Context, cmd *cobra.Command, args
 	return nil
 }
 
-func (ica *infraCreateAction) displayResourceGroupCreatedMessage(ctx context.Context, console input.Console, subscriptionId string, resourceGroup string) {
+func (ica *infraCreateAction) displayResourceGroupCreatedMessage(
+	ctx context.Context,
+	console input.Console,
+	subscriptionId string,
+	resourceGroup string,
+) {
 	resourceGroupCreatedMessage := resourceGroupCreatedMessage(ctx, subscriptionId, resourceGroup)
 	if ica.finalOutputRedirect != nil {
 		*ica.finalOutputRedirect = append(*ica.finalOutputRedirect, resourceGroupCreatedMessage)

cli/azd/cmd/infra_delete.go

@@ -39,10 +39,21 @@ func (a *infraDeleteAction) SetupFlags(
 	local *pflag.FlagSet,
 ) {
 	local.BoolVar(&a.forceDelete, "force", false, "Does not require confirmation before it deletes resources.")
-	local.BoolVar(&a.purgeDelete, "purge", false, "Does not require confirmation before it permanently deletes resources that are soft-deleted by default (for example, key vaults).")
+	local.BoolVar(
+		&a.purgeDelete,
+		"purge",
+		false,
+		"Does not require confirmation before it permanently deletes resources that are"+
+			" soft-deleted by default (for example, key vaults).",
+	)
 }
 
-func (a *infraDeleteAction) Run(ctx context.Context, cmd *cobra.Command, args []string, azdCtx *azdcontext.AzdContext) error {
+func (a *infraDeleteAction) Run(
+	ctx context.Context,
+	cmd *cobra.Command,
+	args []string,
+	azdCtx *azdcontext.AzdContext,
+) error {
 	azCli := azcli.GetAzCli(ctx)
 	console := input.GetConsole(ctx)
 

cli/azd/cmd/init.go

@@ -41,6 +41,7 @@ func initCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command {
 		"init",
 		"Initialize a new application.",
 		&commands.BuildOptions{
+			//nolint:lll
 			Long: `Initialize a new application.
 
 When no template is supplied, you can optionally select an Azure Developer CLI template for cloning. Otherwise, ` + output.WithBackticks("azd init") + ` initializes the current directory and creates resources so that your project is compatible with Azure Developer CLI.
@@ -62,9 +63,21 @@ func (i *initAction) SetupFlags(
 	persis *pflag.FlagSet,
 	local *pflag.FlagSet,
 ) {
-	local.StringVarP(&i.template.Name, "template", "t", "", "The template to use when you initialize the project. You can use Full URI, <owner>/<repository>, or <repository> if it's part of the azure-samples organization.")
+	local.StringVarP(
+		&i.template.Name,
+		"template",
+		"t",
+		"",
+		"The template to use when you initialize the project. "+
+			"You can use Full URI, <owner>/<repository>, or <repository> if it's part of the azure-samples organization.",
+	)
 	local.StringVarP(&i.templateBranch, "branch", "b", "", "The template branch to initialize from.")
-	local.StringVar(&i.subscription, "subscription", "", "Name or ID of an Azure subscription to use for the new environment")
+	local.StringVar(
+		&i.subscription,
+		"subscription",
+		"",
+		"Name or ID of an Azure subscription to use for the new environment",
+	)
 	local.StringVarP(&i.location, "location", "l", "", "Azure location for the new environment")
 }
 
@@ -155,7 +168,11 @@ func (i *initAction) Run(ctx context.Context, cmd *cobra.Command, args []string,
 			return fmt.Errorf("fetching template: %w", err)
 		}
 
-		log.Printf("template init, checking for duplicates. source: %s target: %s", templateStagingDir, azdCtx.ProjectDirectory())
+		log.Printf(
+			"template init, checking for duplicates. source: %s target: %s",
+			templateStagingDir,
+			azdCtx.ProjectDirectory(),
+		)
 
 		// If there are any existing files in the destination that would be overwritten by files from the
 		// template, have the user confirm they would like to overwrite these files. This is a more relaxed
@@ -234,13 +251,20 @@ func (i *initAction) Run(ctx context.Context, cmd *cobra.Command, args []string,
 	}
 
 	//create .azure when running azd init
-	err = os.MkdirAll(filepath.Join(azdCtx.ProjectDirectory(), azdcontext.EnvironmentDirectoryName), osutil.PermissionDirectory)
+	err = os.MkdirAll(
+		filepath.Join(azdCtx.ProjectDirectory(), azdcontext.EnvironmentDirectoryName),
+		osutil.PermissionDirectory,
+	)
 	if err != nil {
 		return fmt.Errorf("failed to create a directory: %w", err)
 	}
 
 	//create .gitignore or open existing .gitignore file, and contains .azure
-	gitignoreFile, err := os.OpenFile(filepath.Join(azdCtx.ProjectDirectory(), ".gitignore"), os.O_APPEND|os.O_RDWR|os.O_CREATE, osutil.PermissionFile)
+	gitignoreFile, err := os.OpenFile(
+		filepath.Join(azdCtx.ProjectDirectory(), ".gitignore"),
+		os.O_APPEND|os.O_RDWR|os.O_CREATE,
+		osutil.PermissionFile,
+	)
 	if err != nil {
 		return fmt.Errorf("fail to create or open .gitignore: %w", err)
 	}

cli/azd/cmd/login.go

@@ -63,7 +63,8 @@ func (la *loginAction) Run(ctx context.Context, cmd *cobra.Command, args []strin
 
 	var res contracts.LoginResult
 
-	if token, err := azCli.GetAccessToken(ctx); errors.Is(err, azcli.ErrAzCliNotLoggedIn) || errors.Is(err, azcli.ErrAzCliRefreshTokenExpired) {
+	if token, err := azCli.GetAccessToken(ctx); errors.Is(err, azcli.ErrAzCliNotLoggedIn) ||
+		errors.Is(err, azcli.ErrAzCliRefreshTokenExpired) {
 		res.Status = contracts.LoginStatusUnauthenticated
 	} else if err != nil {
 		return fmt.Errorf("checking auth status: %w", err)
@@ -87,7 +88,12 @@ func (la *loginAction) Run(ctx context.Context, cmd *cobra.Command, args []strin
 
 func (la *loginAction) SetupFlags(persistent *pflag.FlagSet, local *pflag.FlagSet) {
 	local.BoolVar(&la.onlyCheckStatus, "check-status", false, "Checks the log-in status instead of logging in.")
-	local.BoolVar(&la.useDeviceCode, "use-device-code", false, "When true, log in by using a device code instead of a browser.")
+	local.BoolVar(
+		&la.useDeviceCode,
+		"use-device-code",
+		false,
+		"When true, log in by using a device code instead of a browser.",
+	)
 }
 
 // ensureLoggedIn checks to see if the user is currently logged in. If not, the equivalent of `az login` is run.
@@ -119,7 +125,8 @@ func runLogin(ctx context.Context, forceDeviceCode bool) error {
 	)
 
 	azCli := azcli.GetAzCli(ctx)
-	useDeviceCode := forceDeviceCode || os.Getenv(CodespacesEnvVarName) == "true" || os.Getenv(RemoteContainersEnvVarName) == "true"
+	useDeviceCode := forceDeviceCode || os.Getenv(CodespacesEnvVarName) == "true" ||
+		os.Getenv(RemoteContainersEnvVarName) == "true"
 
 	return azCli.Login(ctx, useDeviceCode, os.Stdout)
 }

cli/azd/cmd/monitor.go

@@ -53,7 +53,12 @@ func (m *monitorAction) SetupFlags(
 	persis *pflag.FlagSet,
 	local *pflag.FlagSet,
 ) {
-	persis.BoolVar(&m.monitorLive, "live", false, "Open a browser to Application Insights Live Metrics. Live Metrics is currently not supported for Python applications.")
+	persis.BoolVar(
+		&m.monitorLive,
+		"live",
+		false,
+		"Open a browser to Application Insights Live Metrics. Live Metrics is currently not supported for Python applications.",
+	)
 	persis.BoolVar(&m.monitorLogs, "logs", false, "Open a browser to Application Insights Logs.")
 	persis.BoolVar(&m.monitorOverview, "overview", false, "Open a browser to Application Insights Overview Dashboard.")
 }

cli/azd/cmd/pipeline.go

@@ -21,6 +21,7 @@ func pipelineCmd(rootOptions *internal.GlobalCommandOptions) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "pipeline",
 		Short: "Manage GitHub Actions pipelines.",
+		//nolint:lll
 		Long: `Manage GitHub Actions pipelines.
 
 The Azure Developer CLI template includes a GitHub Actions pipeline configuration file (in the *.github/workflows* folder) that deploys your application whenever code is pushed to the main branch.
@@ -65,9 +66,24 @@ func (p *pipelineConfigAction) SetupFlags(
 	persis *pflag.FlagSet,
 	local *pflag.FlagSet,
 ) {
-	local.StringVar(&p.manager.PipelineServicePrincipalName, "principal-name", "", "The name of the service principal to use to grant access to Azure resources as part of the pipeline.")
-	local.StringVar(&p.manager.PipelineRemoteName, "remote-name", "origin", "The name of the git remote to configure the pipeline to run on.")
-	local.StringVar(&p.manager.PipelineRoleName, "principal-role", "Contributor", "The role to assign to the service principal.")
+	local.StringVar(
+		&p.manager.PipelineServicePrincipalName,
+		"principal-name",
+		"",
+		"The name of the service principal to use to grant access to Azure resources as part of the pipeline.",
+	)
+	local.StringVar(
+		&p.manager.PipelineRemoteName,
+		"remote-name",
+		"origin",
+		"The name of the git remote to configure the pipeline to run on.",
+	)
+	local.StringVar(
+		&p.manager.PipelineRoleName,
+		"principal-role",
+		"Contributor",
+		"The role to assign to the service principal.",
+	)
 	local.StringVar(&p.manager.PipelineProvider, "provider", "", "The pipeline provider to use (GitHub and Azdo supported).")
 }
 

cli/azd/cmd/pipeline_test.go

@@ -42,7 +42,11 @@ func TestSetupFlags(t *testing.T) {
 	principalNameFlag := command.LocalFlags().Lookup(flagName)
 	assert.NotEqual(t, (*pflag.Flag)(nil), principalNameFlag)
 	assert.Equal(t, "", principalNameFlag.Value.String())
-	assert.Equal(t, "The name of the service principal to use to grant access to Azure resources as part of the pipeline.", principalNameFlag.Usage)
+	assert.Equal(
+		t,
+		"The name of the service principal to use to grant access to Azure resources as part of the pipeline.",
+		principalNameFlag.Usage,
+	)
 	principalNameFlag = command.PersistentFlags().Lookup(flagName)
 	assert.Equal(t, (*pflag.Flag)(nil), principalNameFlag)