[Go]このコードを綺麗にするには？

Question

綺麗なコードが分かりません。

このコードの汚い箇所・構造、等アドバイスお願いします。
Goで書いたコード管理ツールです。

※追記しました。

追記

抽象的な質問失礼しました。
今までチーム開発の経験が無く、私は汚いと感じないのですが、他人から見た見やすいコードとは何だろうと思い質問しました。

気になった事

構造体

構造体を使った方が分かりやすいでしょうか？
例

type cmd_line struct {
 Cmd string
 Opition string
 Name string
}

今は入力を全て配列に突っ込んでしまっています。
私は、分散すると行ったり来たりで分かりにくいと感じます。しかし、他人のコードを見ると構造体がよく使われています。
また、他に構造体にした方が良い箇所はありますか？

同じような動作をどちらかに統一すべきか

exec.Command("cat"~)とos.Open()を、os.Open()にまとめるべきでしょうか

関数の分け方

コマンドごとでしか関数を分けていませんが、cat,lsのコマンド呼び出し部分を一つにまとめた方が良いでしょうか？
2行程度なのでまとめ無くて良いかな〜と思っちゃいます。

質問として不適切かもしれませんが、Goをやっている、かつ、不特定多数に聞ける。のはここしか無いと思い質問させて頂きました。
Goをやっている人が周りに居ないもので...

コード

main.go

package main

import (
	"atCoder/BeginnersSelection"
	"bufio"
	"fmt"
	"os"
	"os/exec"
	"strings"
)

// パッケージディレクトリのパス
var dir_path string = "BeginnersSelection/"

// ループフラグ
var fl bool = true

func main() {
	fmt.Println(" hakadoru へようこそ")
	fmt.Println(" hakadoru はAtCoderコード管理ツールです。")
	fmt.Println(" 試しに `man` コマンドでマニュアルを見てみましょう！ ")
	fmt.Printf("\n\n")

	// 動作部分。flがfalseで終了(100回の制限あり)
	for i := 0; fl && i < 100; i++ {
		fmt.Printf("hakadoru-command > ")

		var sc = bufio.NewScanner(os.Stdin)
		sc.Scan()
		st := sc.Text()
		arr := strings.Split(st, " ")

		command_run(arr)
	}
}

// 各コマンドの選択
func command_run(arr []string) {
	cmd := arr[0]
	switch cmd {
	case "man":
		manual()
	case "run":
		run(arr)
	case "cat":
		cat(arr)
	case "list":
		list_view(dir_path)
	case "exit":
		fl = false
	default:
		fmt.Printf("command not found: %s \n", arr)
	}
}

// `cat`コマンド動作部分
func cat(arr []string) {
	var result string
	// sedオプション時
	if arr[1] == "-sed" {
		cat := exec.Command("cat", dir_path+arr[2]+".go")
		var cat_result, err = cat.Output()
		tmp := strings.Replace(dir_path, "/", "", -1)
		result = string(cat_result)
		result = strings.Replace(result, tmp, "main", -1)
		tmp = strings.Replace(arr[2], arr[2][:1], strings.ToUpper(arr[2][:1]), -1)
		result = strings.Replace(result, tmp, "main", -1)

		if err != nil {
			fmt.Println("err: ", err)
		}

	} else {
		// catオプション無い時
		cat := exec.Command("cat", dir_path+arr[1]+".go")
		var cat_result, err = cat.Output()
		result = string(cat_result)

		if err != nil {
			fmt.Println("err: ", err)
		}
	}
	fmt.Println(result)
}

// `list`コマンド動作部分
func list_view(path string) {
	cmd := exec.Command("ls", path)
	var ls_result, err = cmd.Output()
	var str string = string(ls_result)

	if err != nil {
		fmt.Println("err: ", err)
	}

	fmt.Println("<ファイル一覧>")
	slice := strings.Split(str, "\n")
	for _, str := range slice {
		if str != "" {
			str = strings.Replace(str, ".go", "", -1)
			fmt.Println(str)
		}
	}
}

// `run`コマンド動作部分
// が増える度に追記する。
func run(arr []string) {
	sel := arr[1]
	fmt.Printf("running : %s\n", sel)

	switch sel {
	case "q": //quit
	case "practiceA":
		BeginnersSelection.PracticeA()
	case "abc086a":
		BeginnersSelection.Abc086a()
	case "abc081a":
		BeginnersSelection.Abc081a()
	case "abc081b":
		BeginnersSelection.Abc081b()
	case "abc087b":
		BeginnersSelection.Abc087b()
	case "abc083b":
		BeginnersSelection.Abc083b()
	case "abc088b":
		BeginnersSelection.Abc088b()
	default:
		fmt.Printf(">%s does not exist  \n", sel)
	}
}

func manual() {
	var result string

	str, err := os.Open("manual.txt")
	if err != nil {
		fmt.Println(err)
	}
	defer str.Close()

	tmp_slice := make([]byte, 1024)
	for {
		n, err := str.Read(tmp_slice)
		if n == 0 {
			break
		}
		if err != nil {
			break
		}
		result += string(tmp_slice[:n]) + "\n"
	}
	fmt.Println(result)
}

ディレクトリ構造

atCoder/
├── BeginnersSelection
│   ├── abc081a.go
│   ├── abc081b.go
│   ├── abc083b.go
│   ├── abc086a.go
│   ├── abc087b.go
│   ├── abc088b.go
│   └── practiceA.go
├── README.md
├── go.mod
├── main.go
└── manual.txt

説明

AtCoderの問題別コードをを管理するツール

リポジトリ:https://github.com/null-miraiLABO/AtCoder-Go

流れ

1.atCoder ディレクトリ上で go run main.go をする。

2.各コマンドの実行

3.exitで終了

cmdマニュアル

//実装済みの全コマンド

  man //マニュアルの表示

  list //パッケージ内ファイル一覧

  run [パッケージ名] //選択したパッケージを実行

  cat [オプション] [パッケージ名] //選択したパッケージのコードを表示
    -sed //選択したパッケージをコードをAtCoder提出用に文字列置換し表示

  exit //終了。

//記入例
  cat -sed abc083b

Comments

[y_waiwai]

あなたは、このコードのどの部分が「汚い」と感じるんでしょうか
あるいは、どの部分をどうにかしたいと思ってるんでしょう

[gentaro]

ここはあなたを教育するための無料相談所ではないので、「困っていること」を明確にして質問しよう。
このコードの問題点を示す義務はあなたの側にあるので、それができないのに「キレイにしてくれ」というのは質問にすらなってない。

[miraiLABO]

質問内容に追記しました。ご回答頂けると助かります。

Answer 1

(私はあまりGoは詳しくないですが)

Goをやっている人が周りに居ないもので...

こういうのは大抵、言語には依存しない事が多いです。
仮に依存していても、調べればいいだけです。

たとえば、「ク○コード」を反面教師にするとか。

構造体を使った方が分かりやすいでしょうか

場合によります。

質問にあるコード(の断片)だと、

type cmd_line struct {
 Cmd string
 Opition string
 Name string
}

だと、Cmd や Option, Name はそれぞれ関係のあるものでしょうか。

相当アレなところだと、「関係のないものも、別の関数で使うから構造体にする」とかっていう人もいるようです。それはナンセンスですね。

構造体の役割は、複数のデータをひとまとめにして、意味を持たせるためです。

たとえば、

CSVファイル( カンマを区切り文字にした、Excelっぽいファイル ) を読み込んでソートするとかの場合とかですね。

学籍番号 - 名前 - 数学の点数 - 国語の点数 - 英語の点数

で一行分(= 1人分 ) として、

101,田中太郎,30,40,50
102,田中次郎,100,100,100
103,山田三郎,100,0,100
104, ...

と言う風にあったとします。

これをソートして表示するとかそういう場合、

name1 string, name2 string... のように別々の変数にしたり、
names[] string, numbers[] int ... のように別々の配列にしたりするよりも、

Person構造体を用意して、

type Person struct {
 number int // 学籍番号
 name string
 math int
 japanese int
 english int
}

とかみたいにして、「1人分のデータ」として、それの配列とかを持つ。

でも、この構造体に、(他の関数とかで使うからって)関係のない「コマンドライン引数」を持つとかだとダメ。
まとめて意味を持たせる。

後は『コーディング規約』とかで検索してください。
かなり議論されていますから。