Preparing report...

Report for github.com/carlmontanari/boxen

(v0.0.0)

A+    Excellent!    Found 59 issues across 96 files

Tweet

gofmt100%

Gofmt formats Go programs. We run gofmt -s on your code, where -s is for the "simplify" command

No problems detected. Good job!


go_vet100%

go vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.

No problems detected. Good job!


gocyclo100%

Gocyclo calculates cyclomatic complexities of functions in Go source code. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 15.

No problems detected. Good job!


golint38%

Golint is a linter for Go source code.

    • boxen/instance/qemu.go
    • Line 15: warning: exported type Qemu should have comment or be unexported (golint)
    • Line 37: warning: exported function NewQemu should have comment or be unexported (golint)
    • Line 122: warning: exported method Qemu.Install should have comment or be unexported (golint)
    • Line 126: warning: exported method Qemu.Start should have comment or be unexported (golint)
    • Line 230: warning: exported method Qemu.Stop should have comment or be unexported (golint)
    • Line 288: warning: exported method Qemu.GetPid should have comment or be unexported (golint)
    • boxen/instance/qemulaunchcmd.go
    • Line 17: warning: exported type QemuLaunchCmd should have comment or be unexported (golint)
    • Line 34: warning: exported method QemuLaunchCmd.Render should have comment or be unexported (golint)
    • Line 232: warning: exported method Qemu.GenerateMac should have comment or be unexported (golint)
    • Line 274: warning: exported method Qemu.BuildDataNic should have comment or be unexported (golint)
    • boxen/config/platform.go
    • Line 3: warning: exported type Profile should have comment or be unexported (golint)
    • Line 10: warning: exported type Platform should have comment or be unexported (golint)
    • Line 15: warning: exported function NewPlatform should have comment or be unexported (golint)
    • boxen/util/errors.go
    • Line 5: warning: exported var ErrIgnoredOption should have comment or be unexported (golint)
    • Line 7: warning: exported var ErrInspectionError should have comment or be unexported (golint)
    • Line 8: warning: exported var ErrValidationError should have comment or be unexported (golint)
    • Line 9: warning: exported var ErrAllocationError should have comment or be unexported (golint)
    • Line 10: warning: exported var ErrProvisionError should have comment or be unexported (golint)
    • Line 12: warning: exported var ErrCommandError should have comment or be unexported (golint)
    • Line 14: warning: exported var ErrInstanceError should have comment or be unexported (golint)
    • Line 15: warning: exported var ErrConsoleError should have comment or be unexported (golint)
    • boxen/util/ints.go
    • Line 3: warning: exported function IntSliceContains should have comment or be unexported (golint)
    • Line 13: warning: exported function IntSliceUniqify should have comment or be unexported (golint)
    • boxen/instance/logging.go
    • Line 11: warning: exported type Loggers should have comment or be unexported (golint)
    • Line 23: warning: exported function NewInstanceLoggersFOut should have comment or be unexported (golint)
    • boxen/assets.go
    • Line 5: warning: comment on exported var Assets should be of the form "Assets ..." (golint)
    • boxen/util/timeouts.go
    • Line 3: warning: exported function GetTimeoutMultiplier should have comment or be unexported (golint)
    • Line 10: warning: exported function ApplyTimeoutMultiplier should have comment or be unexported (golint)
    • boxen/instance/base.go
    • Line 3: warning: exported type Option should have comment or be unexported (golint)
    • Line 5: warning: exported type Base should have comment or be unexported (golint)
    • boxen/config/config.go
    • Line 14: warning: exported const MAXINSTANCES should have comment (or a comment on this block) or be unexported (golint)
    • boxen/platforms/ciscocsr1000v.go
    • Line 18: warning: exported const CiscoCsr1000vInstallCdromName should have comment (or a comment on this block) or be unexported (golint)
    • Line 24: warning: exported type CiscoCsr1000v should have comment or be unexported (golint)
    • Line 38: warning: exported method CiscoCsr1000v.Package should have comment or be unexported (golint)
    • Line 100: warning: exported method CiscoCsr1000v.Install should have comment or be unexported (golint)
    • Line 189: warning: exported method CiscoCsr1000v.Start should have comment or be unexported (golint)
    • Line 237: warning: exported method CiscoCsr1000v.SaveConfig should have comment or be unexported (golint)
    • Line 250: warning: exported method CiscoCsr1000v.SetUserPass should have comment or be unexported (golint)
    • Line 259: warning: exported method CiscoCsr1000v.SetHostname should have comment or be unexported (golint)
    • boxen/platforms/console.go
    • Line 29: warning: exported type ScrapliConsole should have comment or be unexported (golint)
    • Line 36: warning: exported function NewScrapliConsole should have comment or be unexported (golint)
    • Line 81: warning: exported method ScrapliConsole.Config should have comment or be unexported (golint)
    • Line 86: warning: exported method ScrapliConsole.Detach should have comment or be unexported (golint)
    • Line 263: warning: exported method ScrapliConsole.InstallConfig should have comment or be unexported (golint)
    • boxen/logging/options.go
    • Line 8: warning: exported type Option should have comment or be unexported (golint)
    • Line 10: warning: exported function WithLevel should have comment or be unexported (golint)
    • boxen/instance/qemuhealth.go
    • Line 15: warning: exported const HealthOK should have comment (or a comment on this block) or be unexported (golint)
    • Line 85: warning: exported method Qemu.RunUntilSigInt should have comment or be unexported (golint)
    • boxen/config/allocate.go
    • Line 3: warning: exported method Config.AllocatedInstanceIDs should have comment or be unexported (golint)
    • Line 13: warning: exported method Config.AllocatedMonitorPorts should have comment or be unexported (golint)
    • Line 23: warning: exported method Config.AllocatedSerialPorts should have comment or be unexported (golint)
    • Line 33: warning: exported method Config.AllocatedHostSideNatPorts should have comment or be unexported (golint)
    • Line 51: warning: exported method Config.AllocatedDataPlaneListenPorts should have comment or be unexported (golint)
    • boxen/platforms/ciscon9kv.go
    • Line 15: warning: exported const CiscoN9kvBiosName should have comment (or a comment on this block) or be unexported (golint)
    • Line 24: warning: exported type CiscoN9kv should have comment or be unexported (golint)
    • Line 29: warning: exported method CiscoN9kv.Package should have comment or be unexported (golint)
    • Line 171: warning: exported method CiscoN9kv.Install should have comment or be unexported (golint)
    • Line 271: warning: exported method CiscoN9kv.Start should have comment or be unexported (golint)
    • Line 319: warning: exported method CiscoN9kv.SaveConfig should have comment or be unexported (golint)
    • Line 332: warning: exported method CiscoN9kv.SetUserPass should have comment or be unexported (golint)
    • Line 341: warning: exported method CiscoN9kv.SetHostname should have comment or be unexported (golint)
    • boxen/docker/rm.go
    • Line 9: warning: exported function RmImage should have comment or be unexported (golint)
    • Line 34: warning: exported function RmContainer should have comment or be unexported (golint)
    • boxen/config/global.go
    • Line 3: warning: exported type GlobalOptions should have comment or be unexported (golint)
    • Line 9: warning: exported type Credentials should have comment or be unexported (golint)
    • Line 22: warning: exported type Qemu should have comment or be unexported (golint)
    • Line 29: warning: exported type Build should have comment or be unexported (golint)
    • boxen/cli/start.go
    • Line 9: warning: exported function Start should have comment or be unexported (golint)
    • Line 25: warning: exported function StartGroup should have comment or be unexported (golint)
    • boxen/platforms/util.go
    • Line 21: warning: exported function GetPlatformTypeFromDisk should have comment or be unexported (golint)
    • Line 55: warning: exported function GetDiskVersion should have comment or be unexported (golint)
    • boxen/docker/options.go
    • Line 5: warning: exported type Option should have comment or be unexported (golint)
    • Line 7: warning: exported function WithWorkDir should have comment or be unexported (golint)
    • Line 15: warning: exported function WithDockerfile should have comment or be unexported (golint)
    • Line 23: warning: exported function WithCidFile should have comment or be unexported (golint)
    • Line 31: warning: exported function WithPrivileged should have comment or be unexported (golint)
    • Line 39: warning: exported function WithRepo should have comment or be unexported (golint)
    • Line 47: warning: exported function WithTag should have comment or be unexported (golint)
    • Line 55: warning: exported function WithContainer should have comment or be unexported (golint)
    • Line 63: warning: exported function WithCommitChange should have comment or be unexported (golint)
    • Line 71: warning: exported function WithStdOut should have comment or be unexported (golint)
    • Line 79: warning: exported function WithStdErr should have comment or be unexported (golint)
    • Line 87: warning: exported function WithNoCache should have comment or be unexported (golint)
    • boxen/platforms/factory.go
    • Line 10: warning: exported function GetPlatformType should have comment or be unexported (golint)
    • Line 38: warning: exported function GetPlatformEmptyStruct should have comment or be unexported (golint)
    • Line 57: warning: exported function NewPlatformFromConfig should have comment or be unexported (golint)
    • boxen/platforms/junipervsrx.go
    • Line 18: warning: exported const JuniperVsrxScrapliPlatform should have comment (or a comment on this block) or be unexported (golint)
    • Line 21: warning: exported type JuniperVsrx should have comment or be unexported (golint)
    • Line 26: warning: exported method JuniperVsrx.Package should have comment or be unexported (golint)
    • Line 77: warning: exported method JuniperVsrx.Install should have comment or be unexported (golint)
    • Line 166: warning: exported method JuniperVsrx.Start should have comment or be unexported (golint)
    • Line 235: warning: exported method JuniperVsrx.SaveConfig should have comment or be unexported (golint)
    • Line 248: warning: exported method JuniperVsrx.SetUserPass should have comment or be unexported (golint)
    • Line 278: warning: exported method JuniperVsrx.SetHostname should have comment or be unexported (golint)
    • boxen/boxen/common.go
    • Line 18: warning: exported var Version should have comment or be unexported (golint)
    • Line 20: warning: exported type Disk should have comment or be unexported (golint)
    • boxen/platforms/ciscoxrv9k.go
    • Line 13: warning: exported const CiscoXrv9kScrapliPlatform should have comment (or a comment on this block) or be unexported (golint)
    • Line 20: warning: exported type CiscoXrv9k should have comment or be unexported (golint)
    • Line 25: warning: exported method CiscoXrv9k.Package should have comment or be unexported (golint)
    • Line 146: warning: exported method CiscoXrv9k.Install should have comment or be unexported (golint)
    • Line 249: warning: exported method CiscoXrv9k.Start should have comment or be unexported (golint)
    • Line 297: warning: exported method CiscoXrv9k.SaveConfig should have comment or be unexported (golint)
    • Line 310: warning: exported method CiscoXrv9k.SetUserPass should have comment or be unexported (golint)
    • Line 319: warning: exported method CiscoXrv9k.SetHostname should have comment or be unexported (golint)
    • boxen/command/options.go
    • Line 8: warning: exported type ExecuteOption should have comment or be unexported (golint)
    • Line 10: warning: exported function WithArgs should have comment or be unexported (golint)
    • Line 18: warning: exported function WithWorkDir should have comment or be unexported (golint)
    • Line 26: warning: exported function WithSudo should have comment or be unexported (golint)
    • Line 34: warning: exported function WithStdOut should have comment or be unexported (golint)
    • Line 42: warning: exported function WithStdErr should have comment or be unexported (golint)
    • Line 50: warning: exported function WithWait should have comment or be unexported (golint)
    • Line 58: warning: exported type CheckOption should have comment or be unexported (golint)
    • Line 60: warning: exported function WithIgnore should have comment or be unexported (golint)
    • Line 68: warning: exported function WithIsError should have comment or be unexported (golint)
    • Line 76: warning: exported function WithDuration should have comment or be unexported (golint)
    • Line 84: warning: exported function WithInterval should have comment or be unexported (golint)
    • boxen/util/spinner.go
    • Line 10: warning: exported type Spinner should have comment or be unexported (golint)
    • Line 22: warning: exported function NewSpinner should have comment or be unexported (golint)
    • Line 66: warning: exported method Spinner.Start should have comment or be unexported (golint)
    • Line 116: warning: exported method Spinner.Stop should have comment or be unexported (golint)
    • boxen/util/env.go
    • Line 8: warning: exported function GetEnvIntOrDefault should have comment or be unexported (golint)
    • Line 22: warning: exported function GetEnvStrOrDefault should have comment or be unexported (golint)
    • boxen/logging/message.go
    • Line 29: warning: exported method DefaultFormatter.Encode should have comment or be unexported (golint)
    • Line 33: warning: exported method DefaultFormatter.Decode should have comment or be unexported (golint)
    • Line 54: warning: exported method NoopFormatter.Encode should have comment or be unexported (golint)
    • Line 58: warning: exported method NoopFormatter.Decode should have comment or be unexported (golint)
    • boxen/config/interfaces.go
    • Line 3: warning: exported type MgmtIntf should have comment or be unexported (golint)
    • Line 8: warning: exported type Nat should have comment or be unexported (golint)
    • Line 13: warning: exported type NatPortPair should have comment or be unexported (golint)
    • Line 18: warning: exported type Bridge should have comment or be unexported (golint)
    • Line 20: warning: exported type DataPlaneIntf should have comment or be unexported (golint)
    • Line 24: warning: exported type SocketConnectPair should have comment or be unexported (golint)
    • boxen/platforms/paloaltopanos.go
    • Line 16: warning: exported const PaloAltoPanosScrapliPlatform should have comment (or a comment on this block) or be unexported (golint)
    • Line 22: warning: exported type PaloAltoPanos should have comment or be unexported (golint)
    • Line 27: warning: exported method PaloAltoPanos.Package should have comment or be unexported (golint)
    • Line 154: warning: exported method PaloAltoPanos.Install should have comment or be unexported (golint)
    • Line 264: warning: exported method PaloAltoPanos.Start should have comment or be unexported (golint)
    • Line 331: warning: exported method PaloAltoPanos.SaveConfig should have comment or be unexported (golint)
    • Line 344: warning: exported method PaloAltoPanos.SetUserPass should have comment or be unexported (golint)
    • Line 378: warning: exported method PaloAltoPanos.SetHostname should have comment or be unexported (golint)
    • boxen/cli/stop.go
    • Line 9: warning: exported function Stop should have comment or be unexported (golint)
    • Line 25: warning: exported function StopGroup should have comment or be unexported (golint)
    • boxen/logging/fifo.go
    • Line 8: warning: exported type FifoLogQueue should have comment or be unexported (golint)
    • Line 13: warning: exported function NewFifoLogQueue should have comment or be unexported (golint)
    • Line 20: warning: exported method FifoLogQueue.Accept should have comment or be unexported (golint)
    • Line 36: warning: exported method FifoLogQueue.Emit should have comment or be unexported (golint)
    • boxen/logging/writer.go
    • Line 12: warning: exported type IoWriterOption should have comment or be unexported (golint)
    • Line 14: warning: exported function WithIoWriterLevel should have comment or be unexported (golint)
    • Line 20: warning: exported function NewInstanceIoWriter should have comment or be unexported (golint)
    • boxen/util/qemu.go
    • Line 39: warning: exported function AvailableAccel should have comment or be unexported (golint)
    • Line 57: warning: exported function GetQemuPath should have comment or be unexported (golint)
    • boxen/platforms/aristaveos.go
    • Line 17: warning: exported const AristaVeosAbootFileName should have comment (or a comment on this block) or be unexported (golint)
    • Line 23: warning: exported type AristaVeos should have comment or be unexported (golint)
    • Line 28: warning: exported method AristaVeos.Package should have comment or be unexported (golint)
    • Line 130: warning: exported method AristaVeos.Install should have comment or be unexported (golint)
    • Line 219: warning: exported method AristaVeos.Start should have comment or be unexported (golint)
    • Line 267: warning: exported method AristaVeos.SaveConfig should have comment or be unexported (golint)
    • Line 280: warning: exported method AristaVeos.SetUserPass should have comment or be unexported (golint)
    • Line 289: warning: exported method AristaVeos.SetHostname should have comment or be unexported (golint)
    • boxen/config/hardware.go
    • Line 3: warning: exported type ProfileHardware should have comment or be unexported (golint)
    • Line 12: warning: exported method ProfileHardware.ToHardware should have comment or be unexported (golint)
    • Line 25: warning: exported type Hardware should have comment or be unexported (golint)
    • Line 35: warning: exported type Advanced should have comment or be unexported (golint)
    • Line 41: warning: exported type AdvancedCPU should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign100%

IneffAssign detects ineffectual assignments in Go code.

No problems detected. Good job!


misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!