From 7bf600ea4970fbdad3a9ed1950fa67249f59ee62 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=9A=D0=B8=D1=80=D0=B8=D0=BB=D0=BB=20=D0=A1=D1=8B=D1=81?=
 =?UTF-8?q?=D0=BE=D0=B5=D0=B2?= <k.sysoev@me.com>
Date: Mon, 13 Nov 2023 15:23:43 +0800
Subject: [PATCH] Adds documentation to macro

---
 pkg/cli/macro.go | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/pkg/cli/macro.go b/pkg/cli/macro.go
index a96fd91..d0f9c91 100644
--- a/pkg/cli/macro.go
+++ b/pkg/cli/macro.go
@@ -20,6 +20,9 @@ type Macro struct {
 	domains []string
 }
 
+// NewMacro creates a new Macro instance with the specified domains.
+// The domains parameter is a slice of strings representing the allowed domains for the macro.
+// Returns a pointer to the newly created Macro instance.
 func NewMacro(domains []string) *Macro {
 	return &Macro{
 		macro:   make(map[string]Executer),
@@ -27,6 +30,11 @@ func NewMacro(domains []string) *Macro {
 	}
 }
 
+// AddCommands adds a new macro with the given name and commands to the Macro instance.
+// If a macro with the same name already exists, it returns an error.
+// If the rawCommands slice is empty, it returns an error.
+// If the rawCommands slice has only one command, it adds the command directly to the macro.
+// Otherwise, it creates a new CommandSequence with the commands and adds it to the macro.
 func (m *Macro) AddCommands(name string, rawCommands []string) error {
 	if _, ok := m.macro[name]; ok {
 		return fmt.Errorf("macro already exists: %s", name)
@@ -55,6 +63,8 @@ func (m *Macro) AddCommands(name string, rawCommands []string) error {
 	return nil
 }
 
+// merge merges the given macro into the current macro.
+// If a macro with the same name already exists, an error is returned.
 func (m *Macro) merge(macro *Macro) error {
 	for name, cmd := range macro.macro {
 		if _, ok := m.macro[name]; ok {
@@ -67,6 +77,7 @@ func (m *Macro) merge(macro *Macro) error {
 	return nil
 }
 
+// Get returns the Executer associated with the given name, or an error if the name is not found.
 func (m *Macro) Get(name string) (Executer, error) {
 	if cmd, ok := m.macro[name]; ok {
 		return cmd, nil
@@ -75,7 +86,9 @@ func (m *Macro) Get(name string) (Executer, error) {
 	return nil, fmt.Errorf("unknown command: %s", name)
 }
 
-func LoadMacro(path string) (*Macro, error) {
+// LoadFromFile loads a macro configuration from a file at the given path.
+// It returns a Macro instance and an error if the file cannot be read or parsed.
+func LoadFromFile(path string) (*Macro, error) {
 	data, err := os.ReadFile(path)
 	if err != nil {
 		return nil, err
@@ -101,6 +114,9 @@ func LoadMacro(path string) (*Macro, error) {
 	return macroCfg, nil
 }
 
+// LoadMacroForDomain loads a macro for a given domain from a directory.
+// It takes the directory path and the domain name as input parameters.
+// It returns a pointer to a Macro struct and an error if any.
 func LoadMacroForDomain(macroDir, domain string) (*Macro, error) {
 	files, err := os.ReadDir(macroDir)
 	if err != nil {
@@ -110,7 +126,7 @@ func LoadMacroForDomain(macroDir, domain string) (*Macro, error) {
 	var macro *Macro
 
 	for _, file := range files {
-		fileMacro, err := LoadMacro(macroDir + "/" + file.Name())
+		fileMacro, err := LoadFromFile(macroDir + "/" + file.Name())
 
 		if err != nil {
 			return nil, err