pulumi/sdk/go/common/tools/gen.go

91 lines
3.0 KiB
Go
Raw Normal View History

2018-05-22 19:43:36 +00:00
// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package tools
import (
"bufio"
"bytes"
"fmt"
"os"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
)
// GenWriter adds some convenient helpers atop a buffered writer.
type GenWriter struct {
tool string // the name of the code-generator.
f *os.File // the file being written to.
buff *bytes.Buffer // the buffer (if there is no file).
w *bufio.Writer // the buffered writer used to emit code.
}
func NewGenWriter(tool string, file string) (*GenWriter, error) {
// If the file is non-empty, open up a writer and overwrite whatever file contents already exist.
if file != "" {
all: Reformat with gofumpt Per team discussion, switching to gofumpt. [gofumpt][1] is an alternative, stricter alternative to gofmt. It addresses other stylistic concerns that gofmt doesn't yet cover. [1]: https://github.com/mvdan/gofumpt See the full list of [Added rules][2], but it includes: - Dropping empty lines around function bodies - Dropping unnecessary variable grouping when there's only one variable - Ensuring an empty line between multi-line functions - simplification (`-s` in gofmt) is always enabled - Ensuring multi-line function signatures end with `) {` on a separate line. [2]: https://github.com/mvdan/gofumpt#Added-rules gofumpt is stricter, but there's no lock-in. All gofumpt output is valid gofmt output, so if we decide we don't like it, it's easy to switch back without any code changes. gofumpt support is built into the tooling we use for development so this won't change development workflows. - golangci-lint includes a gofumpt check (enabled in this PR) - gopls, the LSP for Go, includes a gofumpt option (see [installation instrutions][3]) [3]: https://github.com/mvdan/gofumpt#installation This change was generated by running: ```bash gofumpt -w $(rg --files -g '*.go' | rg -v testdata | rg -v compilation_error) ``` The following files were manually tweaked afterwards: - pkg/cmd/pulumi/stack_change_secrets_provider.go: one of the lines overflowed and had comments in an inconvenient place - pkg/cmd/pulumi/destroy.go: `var x T = y` where `T` wasn't necessary - pkg/cmd/pulumi/policy_new.go: long line because of error message - pkg/backend/snapshot_test.go: long line trying to assign three variables in the same assignment I have included mention of gofumpt in the CONTRIBUTING.md.
2023-03-03 16:36:39 +00:00
f, err := os.OpenFile(file, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o600)
if err != nil {
return nil, err
}
return &GenWriter{tool: tool, f: f, w: bufio.NewWriter(f)}, nil
}
// Otherwise, we are emitting into an in-memory buffer.
var buff bytes.Buffer
return &GenWriter{tool: tool, buff: &buff, w: bufio.NewWriter(&buff)}, nil
}
// Flush explicitly flushes the writer's pending writes.
func (g *GenWriter) Flush() error {
return g.w.Flush()
}
// Close flushes and closes the underlying writer.
func (g *GenWriter) Close() error {
err := g.w.Flush()
contract.IgnoreError(err)
if g.f != nil {
return g.f.Close()
}
return nil
}
// WriteString writes the provided string to the underlying buffer _without_ formatting it.
func (g *GenWriter) WriteString(msg string) {
_, err := g.w.WriteString(msg)
contract.IgnoreError(err)
}
// Writefmt wraps the bufio.Writer.WriteString function, but also performs fmt.Sprintf-style formatting.
func (g *GenWriter) Writefmt(msg string, args ...interface{}) {
g.WriteString(fmt.Sprintf(msg, args...))
}
// Writefmtln wraps the bufio.Writer.WriteString function, performing fmt.Sprintf-style formatting and appending \n.
func (g *GenWriter) Writefmtln(msg string, args ...interface{}) {
g.Writefmt(msg+"\n", args...)
}
// EmitHeaderWarning emits the standard "WARNING" into a generated file, prefixed by commentChars.
func (g *GenWriter) EmitHeaderWarning(commentChars string) {
g.Writefmtln("%s *** WARNING: this file was generated by %v. ***", commentChars, g.tool)
g.Writefmtln("%s *** Do not edit by hand unless you're certain you know what you are doing! ***", commentChars)
g.Writefmtln("")
}
// Buffer returns whatever has been written to the in-memory buffer (in non-file cases).
func (g *GenWriter) Buffer() string {
return g.buff.String()
}