Fix codacy

README.md

@@ -3,6 +3,7 @@
 ![Lint](https://github.com/murat/dicterm/actions/workflows/lint.yml/badge.svg)
 ![Tests](https://github.com/murat/dicterm/actions/workflows/test.yml/badge.svg)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/295007f859ca44b5b1a9418bb5685d40)](https://www.codacy.com/gh/murat/dicterm/dashboard?utm_source=github.com&utm_medium=referral&utm_content=murat/dicterm&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/295007f859ca44b5b1a9418bb5685d40)](https://www.codacy.com/gh/murat/dicterm/dashboard?utm_source=github.com&utm_medium=referral&utm_content=murat/dicterm&utm_campaign=Badge_Coverage)
 
 dicterm is a cli interface for merriem webster dictionary.
 
@@ -65,5 +66,5 @@ stems:
 
 ## Todo
 
-  - [x] store key in a dotfile
-  - [ ] use a beatiful tui
+- [X] store key in a dotfile
+- [ ] use a beatiful tui

internal/api/api.go

@@ -6,13 +6,15 @@ import (
 	"net/http"
 )
 
+// Handler is the handler for the API.
 type Handler struct {
 	Client  *http.Client
 	BaseURL string
 	Key     string
 }
 
 const (
+	// BaseURL is the base URL for the API.
 	BaseURL = "https://www.dictionaryapi.com/api/v3/references/collegiate/json"
 )
 

internal/config/config.go

@@ -6,11 +6,13 @@ import (
 	"os"
 )
 
+// IConfig is interface for config file
 type IConfig interface {
 	Read() (*string, error)
 	Write(string) error
 }
 
+// Config is configuration file
 type Config struct {
 	File *os.File
 }
@@ -35,6 +37,7 @@ func New(path string) (*Config, error) {
 	return &Config{file}, nil
 }
 
+// Read reads key from config file
 func (cfg *Config) Read() (*string, error) {
 	buf := make([]byte, 1024)
 	n, err := cfg.File.Read(buf)
@@ -50,6 +53,7 @@ func (cfg *Config) Read() (*string, error) {
 	return &key, nil
 }
 
+// Write writes key to config file
 func (cfg *Config) Write(key string) error {
 	_, err := cfg.File.Write([]byte(key))
 	if err != nil {

internal/config/error.go

@@ -2,4 +2,5 @@ package config
 
 import "errors"
 
+// ErrEmptyFile is error for empty config file
 var ErrEmptyFile = errors.New("file is empty")