Go言語でcodemod

Tue, 13 Aug 2024 08:00:00 +0900

大規模なコードベースでリファクタリングを省エネ化するためにcodemodを最近調べていて、軽く試行錯誤したのでそのメモ。

やりたいこと

例えば以下のようなTable Driven TestなコードをBEFOREからAFTERに書き換えたい。コード量が多いため人間がやるのは現実的ではなく、codemodで機械的に書き換えたい。

BEFORE

package main

import (
    "slices"
    "testing"
)

func TestContains(t *testing.T) {
    type args struct {
        ss []string
        s  string
    }
    tests := []struct {
        name string
        args args
        want bool
    }{
        {
            name: "empty: false",
            args: args{[]string{}, ""},
            want: false,
        },
        {
            name: "found: true",
            args: args{[]string{"a", "b", "c"}, "b"},
            want: true,
        },
        {
            name: "not found: false",
            args: args{[]string{"a", "b"}, "c"},
            want: false,
        },
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            if got := contains(tt.args.ss, tt.args.s); got != tt.want {
                t.Errorf("contains(): want=%v, got=%v", got, tt.want)
            }
        })
    }
}

func contains(ss []string, s string) bool {
    return slices.Contains(ss, s)
}

AFTER

func TestContains(t *testing.T) {
    type args struct {
        ss []string
        s  string
    }
    tests := map[string]struct {
        args args
        want bool
    }{
        "empty: false": {
            args: args{[]string{}, ""},
            want: false,
        },
    }
    ...
}

DIFF

Go on oinume journal

Go言語でcodemod

やりたいこと