chore: fix typo and format imports and simplify code

Signed-off-by: Zhizhen He <hezhizhen.yi@gmail.com>

cmd/envd-ssh/main.go

@@ -23,7 +23,7 @@ import (
 	"github.com/cockroachdb/errors"
 	rawssh "github.com/gliderlabs/ssh"
 	"github.com/sirupsen/logrus"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/config"
 	"github.com/tensorchord/envd/pkg/remote/sshd"
@@ -54,8 +54,8 @@ func main() {
 		},
 		&cli.StringFlag{
 			Name:    flagAuthKey,
-			Usage:   "path to authorized keys file, defaults to " + config.ContainerauthorizedKeysPath,
-			Value:   config.ContainerauthorizedKeysPath,
+			Usage:   "path to authorized keys file, defaults to " + config.ContainerAuthorizedKeysPath,
+			Value:   config.ContainerAuthorizedKeysPath,
 			Aliases: []string{"a"},
 		},
 		&cli.BoolFlag{

cmd/envd/main.go

@@ -20,7 +20,7 @@ import (
 
 	"github.com/cockroachdb/errors"
 	"github.com/spf13/viper"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 	"go.starlark.net/starlark"
 	"go.starlark.net/syntax"
 

envd/api/config/__init__.py

@@ -46,7 +46,7 @@ def jupyter(password: str, port: int):
     Configure jupyter notebook configuration
 
     Args:
-        password (str): Password for access authenticatioin
+        password (str): Password for access authentication
         port (int): Port to serve jupyter notebook
     """
     pass

examples/mnist/README.md

@@ -10,7 +10,6 @@ By default, `envd up` will use the `build.envd`
 
 Then you can open jupyter notebook at [`http://localhost:8888`](http://localhost:8888), or open vscode remote to attach to the container.
 
-
 ## Quick start (GPU)
 
 ```bash
@@ -19,4 +18,4 @@ $ envd up -f build_gpu.envd
 
 Also you can use `-f` option to specify the file to build
 
-Then you can open jupyter notebook at [`http://localhost:8888`](http://localhost:8888), or open vscode remote to attach to the container.
+Then you can open jupyter notebook at [`http://localhost:8888`](http://localhost:8888), or open vscode remote to attach to the container.

pkg/app/app.go

@@ -21,7 +21,7 @@ import (
 	_ "github.com/moby/buildkit/client/connhelper/podmancontainer"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/flag"
 	"github.com/tensorchord/envd/pkg/home"

pkg/app/bootstrap.go

@@ -11,6 +11,7 @@
 // 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 app
 
 import (
@@ -21,13 +22,12 @@ import (
 	"github.com/cockroachdb/errors"
 	"github.com/docker/docker/pkg/namesgenerator"
 	"github.com/sirupsen/logrus"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	ac "github.com/tensorchord/envd/pkg/autocomplete"
 	"github.com/tensorchord/envd/pkg/buildkitd"
-	"github.com/tensorchord/envd/pkg/util/fileutil"
-
 	sshconfig "github.com/tensorchord/envd/pkg/ssh/config"
+	"github.com/tensorchord/envd/pkg/util/fileutil"
 )
 
 var CommandBootstrap = &cli.Command{
@@ -65,8 +65,8 @@ func bootstrap(clicontext *cli.Context) error {
 	sshKeyPair := clicontext.StringSlice("ssh-keypair")
 	if len(sshKeyPair) != 0 && len(sshKeyPair) != 2 {
 		return errors.Errorf("Invliad ssh-keypair flag")
-	} else if len(sshKeyPair) == 0 {
-
+	}
+	if len(sshKeyPair) == 0 {
 		keyExists, err := sshconfig.DefaultKeyExists()
 		if err != nil {
 			return errors.Wrap(err, "Cannot get default key status")
@@ -90,7 +90,6 @@ func bootstrap(clicontext *cli.Context) error {
 			for ok := true; ok; ok = exists {
 				newPrivateKeyName = filepath.Join(filepath.Dir(sshconfig.GetPrivateKey()), fmt.Sprintf("%s.pk", namesgenerator.GetRandomName(0)))
 				exists, err = fileutil.FileExists(newPrivateKeyName)
-
 				if err != nil {
 					return err
 				}
@@ -124,7 +123,6 @@ func bootstrap(clicontext *cli.Context) error {
 	}
 
 	autocomplete := clicontext.Bool("with-autocomplete")
-
 	if autocomplete {
 		// Because this requires sudo, it should warn and not fail the rest of it.
 		err := ac.InsertBashCompleteEntry()

pkg/app/build.go

@@ -20,7 +20,7 @@ import (
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/builder"
 	"github.com/tensorchord/envd/pkg/flag"

pkg/app/destroy.go

@@ -19,7 +19,7 @@ import (
 
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/docker"
 	sshconfig "github.com/tensorchord/envd/pkg/ssh/config"

pkg/app/get_env.go

@@ -22,7 +22,7 @@ import (
 
 	"github.com/docker/docker/pkg/stringid"
 	"github.com/olekukonko/tablewriter"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/envd"
 	"github.com/tensorchord/envd/pkg/types"

pkg/app/get_env_dep.go

@@ -20,10 +20,11 @@ import (
 
 	"github.com/cockroachdb/errors"
 	"github.com/olekukonko/tablewriter"
+	"github.com/urfave/cli/v2"
+
 	"github.com/tensorchord/envd/pkg/envd"
 	sshconfig "github.com/tensorchord/envd/pkg/ssh/config"
 	"github.com/tensorchord/envd/pkg/types"
-	cli "github.com/urfave/cli/v2"
 )
 
 var CommandGetEnvironmentDependency = &cli.Command{

pkg/app/get_image.go

@@ -23,7 +23,7 @@ import (
 	"github.com/docker/docker/pkg/stringid"
 	"github.com/docker/go-units"
 	"github.com/olekukonko/tablewriter"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/envd"
 	"github.com/tensorchord/envd/pkg/types"

pkg/app/get_image_dep.go

@@ -18,8 +18,9 @@ import (
 	"os"
 
 	"github.com/cockroachdb/errors"
+	"github.com/urfave/cli/v2"
+
 	"github.com/tensorchord/envd/pkg/envd"
-	cli "github.com/urfave/cli/v2"
 )
 
 var CommandGetImageDependency = &cli.Command{

pkg/app/pause.go

@@ -17,8 +17,9 @@ package app
 import (
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
-	"github.com/tensorchord/envd/pkg/envd"
 	"github.com/urfave/cli/v2"
+
+	"github.com/tensorchord/envd/pkg/envd"
 )
 
 var CommandPause = &cli.Command{
@@ -45,9 +46,11 @@ func pause(clicontext *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "failed to create envd engine")
 	}
-	if name, err := envdEngine.PauseEnvironment(clicontext.Context, env); err != nil {
+	name, err := envdEngine.PauseEnvironment(clicontext.Context, env)
+	if err != nil {
 		return errors.Wrap(err, "failed to pause the environment")
-	} else if name != "" {
+	}
+	if name != "" {
 		logrus.Infof("%s is paused", name)
 	}
 	return nil

pkg/app/prune.go

@@ -16,9 +16,10 @@ package app
 
 import (
 	"github.com/cockroachdb/errors"
+	"github.com/urfave/cli/v2"
+
 	"github.com/tensorchord/envd/pkg/buildkitd"
 	"github.com/tensorchord/envd/pkg/home"
-	"github.com/urfave/cli/v2"
 )
 
 var CommandPrune = &cli.Command{

pkg/app/resume.go

@@ -17,8 +17,9 @@ package app
 import (
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
-	"github.com/tensorchord/envd/pkg/envd"
 	"github.com/urfave/cli/v2"
+
+	"github.com/tensorchord/envd/pkg/envd"
 )
 
 var CommandResume = &cli.Command{
@@ -45,9 +46,11 @@ func resume(clicontext *cli.Context) error {
 	if err != nil {
 		return errors.Wrap(err, "failed to create envd engine")
 	}
-	if name, err := envdEngine.ResumeEnvironment(clicontext.Context, env); err != nil {
+	name, err := envdEngine.ResumeEnvironment(clicontext.Context, env)
+	if err != nil {
 		return errors.Wrap(err, "failed to pause the environment")
-	} else if name != "" {
+	}
+	if name != "" {
 		logrus.Infof("%s is resumed", name)
 	}
 	return nil

pkg/app/up.go

@@ -22,7 +22,7 @@ import (
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/tensorchord/envd/pkg/builder"
 	"github.com/tensorchord/envd/pkg/docker"
@@ -145,9 +145,9 @@ func up(clicontext *cli.Context) error {
 	if err := builder.Build(clicontext.Context, clicontext.Path("public-key")); err != nil {
 		return errors.Wrap(err, "failed to build the image")
 	}
-	gpu_enable := clicontext.Bool("no-gpu")
+	gpuEnable := clicontext.Bool("no-gpu")
 	var gpu bool
-	if gpu_enable {
+	if gpuEnable {
 		gpu = false
 	} else {
 		gpu = builder.GPUEnabled()

pkg/app/version.go

@@ -17,8 +17,9 @@ package app
 import (
 	"fmt"
 
-	"github.com/tensorchord/envd/pkg/version"
 	"github.com/urfave/cli/v2"
+
+	"github.com/tensorchord/envd/pkg/version"
 )
 
 var CommandVersion = &cli.Command{

pkg/builder/util.go

@@ -11,6 +11,7 @@
 // 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 builder
 
 import (

pkg/config/config.go

@@ -24,7 +24,7 @@ type UpState string
 const (
 	PrivateKeyFile              = "id_rsa_envd"
 	PublicKeyFile               = "id_rsa_envd.pub"
-	ContainerauthorizedKeysPath = "/var/envd/authorized_keys"
+	ContainerAuthorizedKeysPath = "/var/envd/authorized_keys"
 	envdFolderName              = ".envd"
 )
 

pkg/docker/docker.go

@@ -138,14 +138,14 @@ func (c generalClient) WaitUntilRunning(ctx context.Context,
 
 func (c generalClient) ListImage(ctx context.Context) ([]types.ImageSummary, error) {
 	images, err := c.ImageList(ctx, types.ImageListOptions{
-		Filters: dockerfilters(false),
+		Filters: dockerFilters(false),
 	})
 	return images, err
 }
 
 func (c generalClient) GetImage(ctx context.Context, image string) (types.ImageSummary, error) {
 	images, err := c.ImageList(ctx, types.ImageListOptions{
-		Filters: dockerfiltersWithName(image),
+		Filters: dockerFiltersWithName(image),
 	})
 	if err != nil {
 		return types.ImageSummary{}, err
@@ -157,10 +157,9 @@ func (c generalClient) GetImage(ctx context.Context, image string) (types.ImageS
 }
 
 func (c generalClient) ListContainer(ctx context.Context) ([]types.Container, error) {
-	ctrs, err := c.ContainerList(ctx, types.ContainerListOptions{
-		Filters: dockerfilters(false),
+	return c.ContainerList(ctx, types.ContainerListOptions{
+		Filters: dockerFilters(false),
 	})
-	return ctrs, err
 }
 
 func (c generalClient) PauseContainer(ctx context.Context, name string) (string, error) {

pkg/docker/entrypoint.go

@@ -34,9 +34,9 @@ func entrypointSH(g ir.Graph, workingDir string, sshPort int) string {
 	if g.JupyterConfig != nil {
 		cmds := jupyter.GenerateCommand(g, workingDir)
 		return fmt.Sprintf(template,
-			config.ContainerauthorizedKeysPath, sshPort, g.Shell,
+			config.ContainerAuthorizedKeysPath, sshPort, g.Shell,
 			strings.Join(cmds, " "))
 	}
 	return fmt.Sprintf(template,
-		config.ContainerauthorizedKeysPath, sshPort, g.Shell, "")
+		config.ContainerAuthorizedKeysPath, sshPort, g.Shell, "")
 }

pkg/docker/label.go

@@ -34,7 +34,7 @@ func labels(name string, jupyterConfig *ir.JupyterConfig, sshPort int) map[strin
 	return res
 }
 
-func dockerfilters(gpu bool) filters.Args {
+func dockerFilters(gpu bool) filters.Args {
 	f := filters.NewArgs()
 	f.Add("label", fmt.Sprintf("%s=%s", types.ImageLabelVendor, types.ImageVendorEnvd))
 	if gpu {
@@ -43,7 +43,7 @@ func dockerfilters(gpu bool) filters.Args {
 	return f
 }
 
-func dockerfiltersWithName(name string) filters.Args {
+func dockerFiltersWithName(name string) filters.Args {
 	f := filters.NewArgs()
 	f.Add("reference", name)
 	return f

pkg/editor/vscode/vscode.go

@@ -28,7 +28,7 @@ import (
 )
 
 const (
-	cachekeyPrefix = "vscode-plugins"
+	cacheKeyPrefix = "vscode-plugins"
 )
 
 type Client interface {
@@ -78,7 +78,7 @@ func unzipPath(p Plugin) string {
 // DownloadOrCache downloads or cache the plugin.
 // If the plugin is already downloaded, it returns true.
 func (c generalClient) DownloadOrCache(p Plugin) (bool, error) {
-	cacheKey := fmt.Sprintf("%s-%s", cachekeyPrefix, p)
+	cacheKey := fmt.Sprintf("%s-%s", cacheKeyPrefix, p)
 	if home.GetManager().Cached(cacheKey) {
 		logrus.WithFields(logrus.Fields{
 			"cache": cacheKey,

pkg/envd/engine.go

@@ -11,13 +11,15 @@
 // 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 envd
 
 import (
 	"context"
 
 	"github.com/cockroachdb/errors"
 	"github.com/sirupsen/logrus"
+
 	"github.com/tensorchord/envd/pkg/docker"
 	"github.com/tensorchord/envd/pkg/types"
 )
@@ -105,9 +107,8 @@ func (e generalEngine) ResumeEnvironment(ctx context.Context, env string) (strin
 	return name, nil
 }
 
-// ListEnvDependency gets the dependencies of the given environment.
-func (e generalEngine) ListImageDependency(
-	ctx context.Context, image string) (*types.Dependency, error) {
+// ListImageDependency gets the dependencies of the given environment.
+func (e generalEngine) ListImageDependency(ctx context.Context, image string) (*types.Dependency, error) {
 	logger := logrus.WithFields(logrus.Fields{
 		"image": image,
 	})