deblan-mirror/dnote
1
0
Fork 0
mirror of https://github.com/dnote/dnote synced 2026-03-14 22:45:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve text output and error messages (#75)

Browse source 
* Fix newline

* Allow to specify default for confirmation

* Improve error handling

* Include more options and default to vi

* 0.2.1

* Improve error output
This commit is contained in:
Sung Won Cho 2018-02-17 11:48:09 +11:00 • committed by GitHub
commit 86d75466ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 90 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -38,5 +38,3 @@ Please refer to [commands](/COMMANDS.md).
MIT
[![Build Status](https://travis-ci.org/dnote-io/cli.svg?branch=master)](https://travis-ci.org/dnote-io/cli)
[![Go Report Card](https://goreportcard.com/badge/github.com/dnote-io/cli)](https://goreportcard.com/report/github.com/dnote-io/cli)
[![GolangCI](https://golangci.com/badges/github.com/dnote-io/cli.svg)](https://golangci.com)

4
cmd/login/login.go
View file

@ -32,7 +32,7 @@ func newRun(ctx infra.DnoteCtx) core.RunEFunc {
log.Plain(" (_) (__)\n\n")
log.Plain("Welcome to Dnote Cloud :)\n\n")
log.Plain("A home for your engineering microlessons\n")
log.Plain("You can register at https://dnote.io\n\n")
log.Plain("You can register at https://dnote.io/cloud\n\n")
log.Printf("API key: ")
var apiKey string
@ -52,7 +52,7 @@ func newRun(ctx infra.DnoteCtx) core.RunEFunc {
config.APIKey = apiKey
err = core.WriteConfig(ctx, config)
if err != nil {
return err
return errors.Wrap(err, "Failed to write to config file")
}
log.Success("configured\n")

4
cmd/remove/remove.go
View file

@ -85,7 +85,7 @@ func note(ctx infra.DnoteCtx, index int, bookName string) error {
content := notes[index].Content
log.Printf("content: \"%s\"\n", content)
ok, err := utils.AskConfirmation("remove this note?")
ok, err := utils.AskConfirmation("remove this note?", false)
if err != nil {
return errors.Wrap(err, "Failed to get confirmation")
}
@ -113,7 +113,7 @@ func note(ctx infra.DnoteCtx, index int, bookName string) error {
// book deletes a book with the given name
func book(ctx infra.DnoteCtx, bookName string) error {
ok, err := utils.AskConfirmation(fmt.Sprintf("delete book '%s' and all its notes?", bookName))
ok, err := utils.AskConfirmation(fmt.Sprintf("delete book '%s' and all its notes?", bookName), false)
if err != nil {
return err
}

2
cmd/sync/sync.go
View file

@ -57,7 +57,7 @@ func newRun(ctx infra.DnoteCtx) core.RunEFunc {
}
if config.APIKey == "" {
fmt.Println("Login required. Please run `dnote login`")
log.Error("login required. please run `dnote login`\n")
return nil
}

52
core/core.go
View file

@ -18,7 +18,7 @@ import (
const (
// Version is the current version of dnote
Version = "0.2.0"
Version = "0.2.1"
// TimestampFilename is the name of the file containing upgrade info
TimestampFilename = "timestamps"
@ -79,15 +79,22 @@ func InitActionFile(ctx infra.DnoteCtx) error {
func getEditorCommand() string {
editor := os.Getenv("EDITOR")
if editor == "atom" {
switch editor {
case "atom":
return "atom -w"
} else if editor == "subl" {
case "subl":
return "subl -n -w"
} else if editor == "mate" {
case "mate":
return "mate -w"
case "vim":
return "vim"
case "nano":
return "nano"
case "emacs":
return "emacs"
default:
return "vi"
}
return "vim"
}
// InitConfigFile populates a new config file if it does not exist yet
@ -242,7 +249,12 @@ func WriteDnote(ctx infra.DnoteCtx, dnote infra.Dnote) error {
notePath := GetDnotePath(ctx)
return ioutil.WriteFile(notePath, d, 0644)
err = ioutil.WriteFile(notePath, d, 0644)
if err != nil {
errors.Wrap(err, "Failed to write to the dnote file")
}
return nil
}
func WriteConfig(ctx infra.DnoteCtx, config infra.Config) error {
@ -253,7 +265,12 @@ func WriteConfig(ctx infra.DnoteCtx, config infra.Config) error {
configPath := GetConfigPath(ctx)
return ioutil.WriteFile(configPath, d, 0644)
err = ioutil.WriteFile(configPath, d, 0644)
if err != nil {
errors.Wrap(err, "Failed to write to the config file")
}
return nil
}
// LogAction appends the action to the action log and updates the last_action
@ -287,7 +304,12 @@ func WriteActionLog(ctx infra.DnoteCtx, actions []Action) error {
return errors.Wrap(err, "Failed to marshal newly generated actions to JSON")
}
return ioutil.WriteFile(path, d, 0644)
err = ioutil.WriteFile(path, d, 0644)
if err != nil {
return errors.Wrap(err, "Failed to write to the actions file")
}
return nil
}
func ClearActionLog(ctx infra.DnoteCtx) error {
@ -321,7 +343,11 @@ func ReadActionLog(ctx infra.DnoteCtx) ([]Action, error) {
}
err = json.Unmarshal(b, &ret)
return ret, err
if err != nil {
return ret, errors.Wrap(err, "Failed to unmarshal action log JSON")
}
return ret, nil
}
func ReadConfig(ctx infra.DnoteCtx) (infra.Config, error) {
@ -334,7 +360,11 @@ func ReadConfig(ctx infra.DnoteCtx) (infra.Config, error) {
}
err = yaml.Unmarshal(b, &ret)
return ret, err
if err != nil {
return ret, errors.Wrap(err, "Failed to unmarshal config YAML")
}
return ret, nil
}
func UpdateLastActionTimestamp(ctx infra.DnoteCtx, val int64) error {

10
log/log.go
View file

@ -17,11 +17,11 @@ var (
var indent = " "
func Info(msg string) {
fmt.Fprintf(color.Output, "%s %s %s\n", indent, SprintfBlue("•"), msg)
fmt.Fprintf(color.Output, "%s%s %s", indent, SprintfBlue("•"), msg)
}
func Infof(msg string, v ...interface{}) {
fmt.Fprintf(color.Output, "%s %s %s", indent, SprintfBlue("•"), fmt.Sprintf(msg, v...))
fmt.Fprintf(color.Output, "%s%s %s", indent, SprintfBlue("•"), fmt.Sprintf(msg, v...))
}
func Success(msg string) {
@ -45,7 +45,11 @@ func Warnf(msg string, v ...interface{}) {
}
func Error(msg string) {
fmt.Fprintf(color.Output, "%s%s %s\n", indent, SprintfRed("⨯"), msg)
fmt.Fprintf(color.Output, "%s%s %s", indent, SprintfRed("⨯"), msg)
}
func Errorf(msg string, v ...interface{}) {
fmt.Fprintf(color.Output, "%s%s %s", indent, SprintfRed("⨯"), fmt.Sprintf(msg, v...))
}
func Printf(msg string, v ...interface{}) {

2
main.go
View file

@ -46,7 +46,7 @@ func main() {
root.Register(upgrade.NewCmd(ctx))
if err := root.Execute(); err != nil {
log.Error(err.Error())
log.Errorf("%s\n", err.Error())
os.Exit(1)
}
}

6
migrate/migrate.go
View file

@ -186,7 +186,11 @@ func readSchema(ctx infra.DnoteCtx) (schema, error) {
}
err = yaml.Unmarshal(b, &ret)
return ret, err
if err != nil {
return ret, errors.Wrap(err, "Failed to unmarshal the schema JSON")
}
return ret, nil
}
func writeSchema(ctx infra.DnoteCtx, s schema) error {

17
migrate/migrations.go
View file

@ -148,15 +148,22 @@ func migrateToV3(ctx infra.DnoteCtx) error {
func getEditorCommand() string {
editor := os.Getenv("EDITOR")
if editor == "atom" {
switch editor {
case "atom":
return "atom -w"
} else if editor == "subl" {
case "subl":
return "subl -n -w"
} else if editor == "mate" {
case "mate":
return "mate -w"
case "vim":
return "vim"
case "nano":
return "nano"
case "emacs":
return "emacs"
default:
return "vi"
}
return "vim"
}
func migrateToV4(ctx infra.DnoteCtx) error {

11
upgrade/upgrade.go
View file

@ -19,6 +19,7 @@ import (
"github.com/pkg/errors"
)
// upgradeInterval is 7 days
var upgradeInterval int64 = 86400 * 7
// getAsset finds the asset to download from the liast of assets in a release
@ -70,7 +71,7 @@ func AutoUpgrade(ctx infra.DnoteCtx) error {
}
if shouldCheck {
willCheck, err := utils.AskConfirmation("check for upgrade?")
willCheck, err := utils.AskConfirmation("check for upgrade?", true)
if err != nil {
return errors.Wrap(err, "Failed to get user confirmation for checking upgrade")
}
@ -112,7 +113,7 @@ func Upgrade(ctx infra.DnoteCtx) error {
// Check if up to date
if latestVersion == core.Version {
log.Success("you are up-to-date\n")
log.Success("you are up-to-date\n\n")
err = touchLastUpgrade(ctx)
if err != nil {
return errors.Wrap(err, "Failed to update the upgrade timestamp")
@ -132,7 +133,7 @@ func Upgrade(ctx infra.DnoteCtx) error {
}
// Download temporary file
log.Infof("Downloading: %s\n", latestVersion)
log.Infof("downloading: %s\n", latestVersion)
tmpPath := path.Join(os.TempDir(), "dnote_update")
out, err := os.Create(tmpPath)
@ -174,7 +175,7 @@ func Upgrade(ctx infra.DnoteCtx) error {
return errors.Wrap(err, "Upgrade is done, but failed to update the last_upgrade timestamp.")
}
log.Successf("Updated: v%s -> v%s\n", core.Version, latestVersion)
log.Info("Changelog: https://github.com/dnote-io/cli/releases\n")
log.Successf("updated: v%s -> v%s\n", core.Version, latestVersion)
log.Plain("changelog: https://github.com/dnote-io/cli/releases\n\n")
return nil
}

15
utils/utils.go
View file

@ -33,8 +33,15 @@ func GetInput() (string, error) {
return input, nil
}
func AskConfirmation(question string) (bool, error) {
log.Printf("%s (y/N): ", question)
func AskConfirmation(question string, optimistic bool) (bool, error) {
var choices string
if optimistic {
choices = "(Y/n)"
} else {
choices = "(y/N)"
}
log.Printf("%s %s: ", question, choices)
res, err := GetInput()
if err != nil {
@ -43,6 +50,10 @@ func AskConfirmation(question string) (bool, error) {
confirmed := res == "y\n" || res == "y\r\n"
if optimistic {
confirmed = confirmed || res == "\n" || res == "\r\n"
}
return confirmed, nil
}