Merge pull request #186 from misha-ssh/add-doc-block

Add doc block

Author: deniskorbakov

cmd/misha/README.md

@@ -18,6 +18,7 @@ var (
 	errConvertPort      = errors.New(`cannot convert port`)
 )
 
+// Run Main function that runs an interactive form to collect SSH connection details
 func Run() (*Fields, error) {
 	var authPassConfirm bool
 

internal/component/create/create.go

@@ -1,5 +1,6 @@
 package create
 
+// Fields A struct that stores SSH connection details
 type Fields struct {
 	Alias      string
 	Login      string

internal/component/create/fields.go

@@ -27,6 +27,7 @@ var (
 	errPreloadedConnections error
 )
 
+// init Loads existing SSH connections at startup
 func init() {
 	connections, err := kernel.List()
 	if err != nil {
@@ -36,6 +37,7 @@ func init() {
 	preloadedConnections = connections
 }
 
+// aliasValidate validate on exists alias
 func aliasValidate(alias string) error {
 	if strings.TrimSpace(alias) == "" || alias == "" {
 		return errAliasIsNotEmpty
@@ -54,6 +56,7 @@ func aliasValidate(alias string) error {
 	return nil
 }
 
+// portValidate validate on correctly port
 func portValidate(s string) error {
 	port, err := strconv.Atoi(s)
 	if err != nil {
@@ -67,6 +70,7 @@ func portValidate(s string) error {
 	return nil
 }
 
+// privateKeyValidate validate on exists file
 func privateKeyValidate(filename string) error {
 	if strings.TrimSpace(filename) == "" || filename == "" {
 		return nil

internal/component/create/validate.go

@@ -11,6 +11,7 @@ var (
 	errNotFoundConnections = errors.New("not found connections")
 )
 
+// Run Get selected connection from list
 func Run(connections *connect.Connections) (*connect.Connect, error) {
 	var aliases []string
 	var selectedAlias string

internal/component/list/list.go

@@ -6,6 +6,7 @@ var (
 	ErrorColor = lipgloss.Color("#FF0000")
 )
 
+// Error get message line for erros
 func Error(s string) {
 	style := lipgloss.NewStyle().Foreground(ErrorColor)
 	println(style.Render(s))

internal/component/output/error.go

@@ -6,6 +6,7 @@ var (
 	successColor = lipgloss.Color("#04B575")
 )
 
+// Success get message lin for success operations
 func Success(s string) {
 	style := lipgloss.NewStyle().Foreground(successColor)
 	println(style.Render(s))

internal/component/output/success.go

@@ -1,5 +1,6 @@
 package update
 
+// Fields A struct that update SSH connection details
 type Fields struct {
 	Alias      string
 	Login      string

internal/component/update/fields.go

@@ -15,6 +15,7 @@ var (
 	errConvertPort      = errors.New(`cannot convert port`)
 )
 
+// Run get form for update connect.Connect
 func Run(connection *connect.Connect) (*Fields, error) {
 	var authPassConfirm bool
 

internal/component/update/update.go

@@ -27,6 +27,7 @@ var (
 	errPreloadedConnections error
 )
 
+// init Loads existing SSH connections at startup
 func init() {
 	connections, err := kernel.List()
 	if err != nil {
@@ -36,6 +37,7 @@ func init() {
 	preloadedConnections = connections
 }
 
+// aliasValidate validate on exists alias
 func aliasValidate(alias string) error {
 	if strings.TrimSpace(alias) == "" || alias == "" {
 		return errAliasIsNotEmpty
@@ -54,6 +56,7 @@ func aliasValidate(alias string) error {
 	return nil
 }
 
+// portValidate validate on correctly port
 func portValidate(s string) error {
 	port, err := strconv.Atoi(s)
 	if err != nil {
@@ -67,6 +70,7 @@ func portValidate(s string) error {
 	return nil
 }
 
+// privateKeyValidate validate on exists file
 func privateKeyValidate(filename string) error {
 	if strings.TrimSpace(filename) == "" || filename == "" {
 		return nil