chore: various lint corrections

Make various lint corrections in order to appease `staticcheck`.
This commit is contained in:
Chris Allen Lane 2022-08-04 20:38:49 -04:00 committed by Chris Lane
parent 484b447391
commit 85f5ae8ec7
19 changed files with 30 additions and 49 deletions

View File

@ -18,11 +18,7 @@ func cmdDirectories(opts map[string]interface{}, conf config.Config) {
// generate sorted, columnized output // generate sorted, columnized output
for _, path := range conf.Cheatpaths { for _, path := range conf.Cheatpaths {
fmt.Fprintln(w, fmt.Sprintf( fmt.Fprintf(w, "%s:\t%s\n", path.Name, path.Path)
"%s:\t%s",
path.Name,
path.Path,
))
} }
// write columnized output to stdout // write columnized output to stdout

View File

@ -20,7 +20,7 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }

View File

@ -21,7 +21,7 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }
@ -63,10 +63,7 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
// compile the regex // compile the regex
reg, err := regexp.Compile(pattern) reg, err := regexp.Compile(pattern)
if err != nil { if err != nil {
fmt.Fprintln( fmt.Fprintf(os.Stderr, "failed to compile regexp: %s, %v\n", pattern, err)
os.Stderr,
fmt.Sprintf("failed to compile regexp: %s, %v", pattern, err),
)
os.Exit(1) os.Exit(1)
} }
@ -95,12 +92,7 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
// generate sorted, columnized output // generate sorted, columnized output
for _, sheet := range flattened { for _, sheet := range flattened {
fmt.Fprintln(w, fmt.Sprintf( fmt.Fprintf(w, "%s\t%s\t%s\n", sheet.Title, sheet.Path, strings.Join(sheet.Tags, ","))
"%s\t%s\t%s",
sheet.Title,
sheet.Path,
strings.Join(sheet.Tags, ","),
))
} }
// write columnized output to stdout // write columnized output to stdout

View File

@ -17,7 +17,7 @@ func cmdRemove(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }
@ -37,19 +37,19 @@ func cmdRemove(opts map[string]interface{}, conf config.Config) {
// fail early if the requested cheatsheet does not exist // fail early if the requested cheatsheet does not exist
sheet, ok := consolidated[cheatsheet] sheet, ok := consolidated[cheatsheet]
if !ok { if !ok {
fmt.Fprintln(os.Stderr, fmt.Sprintf("No cheatsheet found for '%s'.\n", cheatsheet)) fmt.Fprintf(os.Stderr, "No cheatsheet found for '%s'.\n", cheatsheet)
os.Exit(2) os.Exit(2)
} }
// fail early if the sheet is read-only // fail early if the sheet is read-only
if sheet.ReadOnly { if sheet.ReadOnly {
fmt.Fprintln(os.Stderr, fmt.Sprintf("cheatsheet '%s' is read-only.", cheatsheet)) fmt.Fprintf(os.Stderr, "cheatsheet '%s' is read-only.\n", cheatsheet)
os.Exit(1) os.Exit(1)
} }
// otherwise, attempt to delete the sheet // otherwise, attempt to delete the sheet
if err := os.Remove(sheet.Path); err != nil { if err := os.Remove(sheet.Path); err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to delete sheet: %s, %v", sheet.Title, err)) fmt.Fprintf(os.Stderr, "failed to delete sheet: %s, %v\n", sheet.Title, err)
os.Exit(1) os.Exit(1)
} }
} }

View File

@ -19,7 +19,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }
@ -55,7 +55,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
// compile the regex // compile the regex
reg, err := regexp.Compile(pattern) reg, err := regexp.Compile(pattern)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to compile regexp: %s, %v", pattern, err)) fmt.Fprintf(os.Stderr, "failed to compile regexp: %s, %v\n", pattern, err)
os.Exit(1) os.Exit(1)
} }

View File

@ -15,7 +15,7 @@ func cmdTags(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }

View File

@ -18,7 +18,7 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
// load the cheatsheets // load the cheatsheets
cheatsheets, err := sheets.Load(conf.Cheatpaths) cheatsheets, err := sheets.Load(conf.Cheatpaths)
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to list cheatsheets: %v", err)) fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
os.Exit(1) os.Exit(1)
} }

View File

@ -46,7 +46,7 @@ func TestFilterFailure(t *testing.T) {
} }
// filter the paths // filter the paths
paths, err := Filter(paths, "qux") _, err := Filter(paths, "qux")
if err == nil { if err == nil {
t.Errorf("failed to return an error on non-existent cheatpath") t.Errorf("failed to return an error on non-existent cheatpath")
} }

View File

@ -11,12 +11,10 @@ func Writeable(cheatpaths []Cheatpath) (Cheatpath, error) {
// NB: we're going backwards because we assume that the most "local" // NB: we're going backwards because we assume that the most "local"
// cheatpath will be specified last in the configs // cheatpath will be specified last in the configs
for i := len(cheatpaths) - 1; i >= 0; i-- { for i := len(cheatpaths) - 1; i >= 0; i-- {
// if the cheatpath is not read-only, it is writeable, and thus returned // if the cheatpath is not read-only, it is writeable, and thus returned
if cheatpaths[i].ReadOnly == false { if !cheatpaths[i].ReadOnly {
return cheatpaths[i], nil return cheatpaths[i], nil
} }
} }
// otherwise, return an error // otherwise, return an error

View File

@ -2,7 +2,6 @@ package config
import ( import (
"fmt" "fmt"
"io/ioutil"
"os" "os"
"os/exec" "os/exec"
"path/filepath" "path/filepath"
@ -29,7 +28,7 @@ type Config struct {
func New(opts map[string]interface{}, confPath string, resolve bool) (Config, error) { func New(opts map[string]interface{}, confPath string, resolve bool) (Config, error) {
// read the config file // read the config file
buf, err := ioutil.ReadFile(confPath) buf, err := os.ReadFile(confPath)
if err != nil { if err != nil {
return Config{}, fmt.Errorf("could not read config file: %v", err) return Config{}, fmt.Errorf("could not read config file: %v", err)
} }

View File

@ -2,7 +2,6 @@ package config
import ( import (
"fmt" "fmt"
"io/ioutil"
"os" "os"
"path/filepath" "path/filepath"
) )
@ -16,7 +15,7 @@ func Init(confpath string, configs string) error {
} }
// write the config file // write the config file
if err := ioutil.WriteFile(confpath, []byte(configs), 0644); err != nil { if err := os.WriteFile(confpath, []byte(configs), 0644); err != nil {
return fmt.Errorf("failed to create file: %v", err) return fmt.Errorf("failed to create file: %v", err)
} }

View File

@ -1,7 +1,6 @@
package config package config
import ( import (
"io/ioutil"
"os" "os"
"testing" "testing"
) )
@ -10,7 +9,7 @@ import (
func TestInit(t *testing.T) { func TestInit(t *testing.T) {
// initialize a temporary config file // initialize a temporary config file
confFile, err := ioutil.TempFile("", "cheat-test") confFile, err := os.CreateTemp("", "cheat-test")
if err != nil { if err != nil {
t.Errorf("failed to create temp file: %v", err) t.Errorf("failed to create temp file: %v", err)
} }
@ -25,7 +24,7 @@ func TestInit(t *testing.T) {
} }
// read back the config file contents // read back the config file contents
bytes, err := ioutil.ReadFile(confFile.Name()) bytes, err := os.ReadFile(confFile.Name())
if err != nil { if err != nil {
t.Errorf("failed to read config file: %v", err) t.Errorf("failed to read config file: %v", err)
} }

View File

@ -1,7 +1,6 @@
package config package config
import ( import (
"io/ioutil"
"os" "os"
"testing" "testing"
) )
@ -24,7 +23,7 @@ func TestPathConfigNotExists(t *testing.T) {
func TestPathConfigExists(t *testing.T) { func TestPathConfigExists(t *testing.T) {
// initialize a temporary config file // initialize a temporary config file
confFile, err := ioutil.TempFile("", "cheat-test") confFile, err := os.CreateTemp("", "cheat-test")
if err != nil { if err != nil {
t.Errorf("failed to create temp file: %v", err) t.Errorf("failed to create temp file: %v", err)
} }

View File

@ -10,7 +10,7 @@ import (
func Faint(str string, conf config.Config) string { func Faint(str string, conf config.Config) string {
// make `str` faint only if colorization has been requested // make `str` faint only if colorization has been requested
if conf.Colorize { if conf.Colorize {
return fmt.Sprintf(fmt.Sprintf("\033[2m%s\033[0m", str)) return fmt.Sprintf("\033[2m%s\033[0m", str)
} }
// otherwise, return the string unmodified // otherwise, return the string unmodified

View File

@ -4,5 +4,5 @@ import "fmt"
// Underline returns an underlined string // Underline returns an underlined string
func Underline(str string) string { func Underline(str string) string {
return fmt.Sprintf(fmt.Sprintf("\033[4m%s\033[0m", str)) return fmt.Sprintf("\033[4m%s\033[0m", str)
} }

View File

@ -31,7 +31,7 @@ func Write(out string, conf config.Config) {
// handle errors // handle errors
err := cmd.Run() err := cmd.Run()
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, fmt.Sprintf("failed to write to pager: %v", err)) fmt.Fprintf(os.Stderr, "failed to write to pager: %v\n", err)
os.Exit(1) os.Exit(1)
} }
} }

View File

@ -14,7 +14,7 @@ func Prompt(prompt string, def bool) (bool, error) {
reader := bufio.NewReader(os.Stdin) reader := bufio.NewReader(os.Stdin)
// display the prompt // display the prompt
fmt.Print(fmt.Sprintf("%s: ", prompt)) fmt.Printf("%s: ", prompt)
// read the answer // read the answer
ans, err := reader.ReadString('\n') ans, err := reader.ReadString('\n')

View File

@ -1,7 +1,6 @@
package sheet package sheet
import ( import (
"io/ioutil"
"os" "os"
"path" "path"
"testing" "testing"
@ -13,7 +12,7 @@ func TestCopyFlat(t *testing.T) {
// mock a cheatsheet file // mock a cheatsheet file
text := "this is the cheatsheet text" text := "this is the cheatsheet text"
src, err := ioutil.TempFile("", "foo-src") src, err := os.CreateTemp("", "foo-src")
if err != nil { if err != nil {
t.Errorf("failed to mock cheatsheet: %v", err) t.Errorf("failed to mock cheatsheet: %v", err)
} }
@ -41,7 +40,7 @@ func TestCopyFlat(t *testing.T) {
} }
// assert that the destination file contains the correct text // assert that the destination file contains the correct text
got, err := ioutil.ReadFile(outpath) got, err := os.ReadFile(outpath)
if err != nil { if err != nil {
t.Errorf("failed to read destination file: %v", err) t.Errorf("failed to read destination file: %v", err)
} }
@ -60,7 +59,7 @@ func TestCopyDeep(t *testing.T) {
// mock a cheatsheet file // mock a cheatsheet file
text := "this is the cheatsheet text" text := "this is the cheatsheet text"
src, err := ioutil.TempFile("", "foo-src") src, err := os.CreateTemp("", "foo-src")
if err != nil { if err != nil {
t.Errorf("failed to mock cheatsheet: %v", err) t.Errorf("failed to mock cheatsheet: %v", err)
} }
@ -94,7 +93,7 @@ func TestCopyDeep(t *testing.T) {
} }
// assert that the destination file contains the correct text // assert that the destination file contains the correct text
got, err := ioutil.ReadFile(outpath) got, err := os.ReadFile(outpath)
if err != nil { if err != nil {
t.Errorf("failed to read destination file: %v", err) t.Errorf("failed to read destination file: %v", err)
} }

View File

@ -2,7 +2,7 @@ package sheet
import ( import (
"fmt" "fmt"
"io/ioutil" "os"
"sort" "sort"
"github.com/cheat/cheat/internal/frontmatter" "github.com/cheat/cheat/internal/frontmatter"
@ -29,7 +29,7 @@ func New(
) (Sheet, error) { ) (Sheet, error) {
// read the cheatsheet file // read the cheatsheet file
markdown, err := ioutil.ReadFile(path) markdown, err := os.ReadFile(path)
if err != nil { if err != nil {
return Sheet{}, fmt.Errorf("failed to read file: %s, %v", path, err) return Sheet{}, fmt.Errorf("failed to read file: %s, %v", path, err)
} }