feat(cmd/gf): add gendao fileNameCase and ai coding stuffs (#4764)

This pull request introduces new and updated prompt and instruction documents for the experimental OPSX workflow system, providing detailed, step-by-step guidance for proposing, applying, archiving, and exploring changes using OpenSpec. The changes standardize workflow guardrails, clarify user interactions, and ensure consistent artifact handling across all major workflow operations. **OPSX Workflow Prompt Additions and Enhancements:** * **Propose Workflow** - Adds `.agents/prompts/opsx/propose.md` outlining how to propose a new change, including artifact creation order, dependency handling, and user input requirements. Emphasizes using schema-defined instructions and templates, and clarifies that context/rules are for internal guidance only. * **Apply Workflow** - Introduces `.agents/prompts/opsx/apply.md` detailing the process for implementing tasks from an OpenSpec change. Covers change selection, context reading, task loop execution, state handling, and output formatting. Includes guardrails for ambiguity, blockers, and minimal change scope. * **Archive Workflow** - Adds `.agents/prompts/opsx/archive.md` specifying the process for archiving completed changes, including artifact/task completion checks, delta spec sync assessment, user prompts for incomplete work, and summary output. Ensures robust handling of archive naming conflicts and user confirmations. * **Explore Mode** - Adds `.agents/prompts/opsx/explore.md` describing "explore mode" for non-implementation discovery, problem investigation, and requirements clarification. Outlines stance, behaviors, and guardrails for thinking and artifact capture without code changes. **Documentation Standardization:** * **Markdown Formatting Standards** - Adds `.agents/instructions/markdown-format.instructions.md` to standardize markdown document formatting, including heading levels, code block usage, list formatting, and language-specific punctuation rules for improved clarity and consistency.
2026-07-08 06:35:16 +08:00 · 2026-04-25 17:47:05 +08:00
parent cb7cfa58ab
commit 94623a19d1
33 changed files with 2205 additions and 36 deletions
--- a/cmd/gf/internal/cmd/cmd_z_unit_gen_dao_test.go
+++ b/cmd/gf/internal/cmd/cmd_z_unit_gen_dao_test.go
@ -412,3 +412,60 @@ func Test_Gen_Dao_Sqlite3(t *testing.T) {
 		}
 	})
 }
+
+func Test_Gen_Dao_FileNameCaseSnakeFirstUpper(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		var (
+			err        error
+			db         = testDB
+			table      = "sys_i18n_message"
+			sqlContent = fmt.Sprintf(
+				gtest.DataContent(`gendao`, `user.tpl.sql`),
+				table,
+			)
+		)
+		dropTableWithDb(db, table)
+		array := gstr.SplitAndTrim(sqlContent, ";")
+		for _, v := range array {
+			if _, err = db.Exec(ctx, v); err != nil {
+				t.AssertNil(err)
+			}
+		}
+		defer dropTableWithDb(db, table)
+
+		var (
+			path = gfile.Temp(guid.S())
+			in   = gendao.CGenDaoInput{
+				Path:         path,
+				Link:         link,
+				Group:        "test",
+				Tables:       table,
+				FileNameCase: "SnakeFirstUpper",
+			}
+		)
+		err = gutil.FillStructWithDefault(&in)
+		t.AssertNil(err)
+
+		err = gfile.Mkdir(path)
+		t.AssertNil(err)
+		defer gfile.Remove(path)
+
+		err = gfile.Copy(
+			gtest.DataPath("gendao", "go.mod.txt"),
+			gfile.Join(path, "go.mod"),
+		)
+		t.AssertNil(err)
+
+		_, err = gendao.CGenDao{}.Dao(ctx, in)
+		t.AssertNil(err)
+
+		files, err := gfile.ScanDir(path, "*.go", true)
+		t.AssertNil(err)
+		t.Assert(files, []string{
+			filepath.FromSlash(path + "/dao/internal/sys_i18n_message.go"),
+			filepath.FromSlash(path + "/dao/sys_i18n_message.go"),
+			filepath.FromSlash(path + "/model/do/sys_i18n_message.go"),
+			filepath.FromSlash(path + "/model/entity/sys_i18n_message.go"),
+		})
+	})
+}
--- a/cmd/gf/internal/cmd/gendao/gendao.go
+++ b/cmd/gf/internal/cmd/gendao/gendao.go
@ -46,6 +46,7 @@ type (
 		RemovePrefix       string   `name:"removePrefix"        short:"r"  brief:"{CGenDaoBriefRemovePrefix}"`
 		RemoveFieldPrefix  string   `name:"removeFieldPrefix"   short:"rf" brief:"{CGenDaoBriefRemoveFieldPrefix}"`
 		JsonCase           string   `name:"jsonCase"            short:"j"  brief:"{CGenDaoBriefJsonCase}" d:"CamelLower"`
+		FileNameCase       string   `name:"fileNameCase"        short:"fc" brief:"{CGenDaoBriefFileNameCase}" d:"Snake"`
 		ImportPrefix       string   `name:"importPrefix"        short:"i"  brief:"{CGenDaoBriefImportPrefix}"`
 		DaoPath            string   `name:"daoPath"             short:"d"  brief:"{CGenDaoBriefDaoPath}" d:"dao"`
 		TablePath          string   `name:"tablePath"           short:"tp" brief:"{CGenDaoBriefTablePath}" d:"table"`
--- a/cmd/gf/internal/cmd/gendao/gendao_dao.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_dao.go
@ -69,7 +69,7 @@ func generateDaoSingle(ctx context.Context, in generateDaoSingleInput) {
 	var (
 		tableNameCamelCase      = formatFieldName(in.NewTableName, FieldNameCaseCamel)
 		tableNameCamelLowerCase = formatFieldName(in.NewTableName, FieldNameCaseCamelLower)
-		tableNameSnakeCase      = gstr.CaseSnake(in.NewTableName)
+		fileName                = formatFileName(in.NewTableName, in.FileNameCase)
 		importPrefix            = in.ImportPrefix
 	)
 	if importPrefix == "" {
@ -78,13 +78,6 @@ func generateDaoSingle(ctx context.Context, in generateDaoSingleInput) {
 		importPrefix = gstr.Join(g.SliceStr{importPrefix, in.DaoPath}, "/")
 	}

-	fileName := gstr.Trim(tableNameSnakeCase, "-_.")
-	if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
-		// Add suffix to avoid the table name which contains "_test",
-		// which would make the go file a testing file.
-		fileName += "_table"
-	}
-
 	// dao - index
 	generateDaoIndex(generateDaoIndexInput{
 		generateDaoSingleInput:  in,
--- a/cmd/gf/internal/cmd/gendao/gendao_do.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_do.go
@ -36,7 +36,7 @@ func generateDo(ctx context.Context, in CGenDaoInternalInput) {
 		}
 		var (
 			newTableName        = in.NewTableNames[i]
-			doFilePath          = gfile.Join(dirPathDo, gstr.CaseSnake(newTableName)+".go")
+			doFilePath          = gfile.Join(dirPathDo, formatFileName(newTableName, in.FileNameCase)+".go")
 			structDefinition, _ = generateStructDefinition(ctx, generateStructDefinitionInput{
 				CGenDaoInternalInput: in,
 				TableName:            tableName,
--- a/cmd/gf/internal/cmd/gendao/gendao_entity.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_entity.go
@ -13,7 +13,6 @@ import (

 	"github.com/gogf/gf/v2/os/gfile"
 	"github.com/gogf/gf/v2/os/gview"
-	"github.com/gogf/gf/v2/text/gstr"

 	"github.com/gogf/gf/cmd/gf/v2/internal/consts"
 	"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
@ -32,7 +31,7 @@ func generateEntity(ctx context.Context, in CGenDaoInternalInput) {

 		var (
 			newTableName                    = in.NewTableNames[i]
-			entityFilePath                  = filepath.FromSlash(gfile.Join(dirPathEntity, gstr.CaseSnake(newTableName)+".go"))
+			entityFilePath                  = filepath.FromSlash(gfile.Join(dirPathEntity, formatFileName(newTableName, in.FileNameCase)+".go"))
 			structDefinition, appendImports = generateStructDefinition(ctx, generateStructDefinitionInput{
 				CGenDaoInternalInput: in,
 				TableName:            tableName,
--- a/cmd/gf/internal/cmd/gendao/gendao_structure.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_structure.go
@ -208,6 +208,28 @@ func formatFieldName(fieldName string, nameCase FieldNameCase) string {
 	}
 }

+// formatFileName formats and returns a new file name for generated source files.
+func formatFileName(fileName, nameCase string) string {
+	if nameCase == "" {
+		nameCase = string(gstr.Snake)
+	}
+	fileName = normalizeNameForCaseConvert(fileName)
+	fileName = gstr.Trim(gstr.CaseConvert(fileName, gstr.CaseTypeMatch(nameCase)), "-_.")
+	if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
+		// Add suffix to avoid the table name which contains "_test",
+		// which would make the go file a testing file.
+		fileName += "_table"
+	}
+	return fileName
+}
+
+func normalizeNameForCaseConvert(name string) string {
+	if isAllUpper(name) {
+		return strings.ToLower(name)
+	}
+	return name
+}
+
 // isAllUpper checks and returns whether given `fieldName` all letters are upper case.
 func isAllUpper(fieldName string) bool {
 	for _, b := range fieldName {
--- a/cmd/gf/internal/cmd/gendao/gendao_table.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_table.go
@ -17,7 +17,6 @@ import (
 	"github.com/gogf/gf/v2/database/gdb"
 	"github.com/gogf/gf/v2/os/gfile"
 	"github.com/gogf/gf/v2/os/gview"
-	"github.com/gogf/gf/v2/text/gstr"
 	"github.com/gogf/gf/v2/util/gconv"

 	"github.com/gogf/gf/cmd/gf/v2/internal/consts"
@ -67,13 +66,7 @@ func generateTableSingle(ctx context.Context, in generateTableSingleInput) {
 		mlog.Fatalf(`fetching tables fields failed for table "%s": %+v`, in.TableName, err)
 	}

-	tableNameSnakeCase := gstr.CaseSnake(in.NewTableName)
-	fileName := gstr.Trim(tableNameSnakeCase, "-_.")
-	if len(fileName) > 5 && fileName[len(fileName)-5:] == "_test" {
-		// Add suffix to avoid the table name which contains "_test",
-		// which would make the go file a testing file.
-		fileName += "_table"
-	}
+	fileName := formatFileName(in.NewTableName, in.FileNameCase)
 	path := filepath.FromSlash(gfile.Join(in.DirPathTable, fileName+".go"))
 	in.genItems.AppendGeneratedFilePath(path)
 	if in.OverwriteDao || !gfile.Exists(path) {
--- a/cmd/gf/internal/cmd/gendao/gendao_tag.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_tag.go
@ -58,23 +58,30 @@ CONFIGURATION SUPPORT
 	CGenDaoBriefStdTime           = `use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables`
 	CGenDaoBriefWithTime          = `add created time for auto produced go files`
 	CGenDaoBriefGJsonSupport      = `use gJsonSupport to use *gjson.Json instead of string for generated json fields of tables`
-	CGenDaoBriefImportPrefix      = `custom import prefix for generated go files`
-	CGenDaoBriefDaoPath           = `directory path for storing generated dao files under path`
-	CGenDaoBriefTablePath         = `directory path for storing generated table files under path`
-	CGenDaoBriefDoPath            = `directory path for storing generated do files under path`
-	CGenDaoBriefEntityPath        = `directory path for storing generated entity files under path`
-	CGenDaoBriefOverwriteDao      = `overwrite all dao files both inside/outside internal folder`
-	CGenDaoBriefModelFile         = `custom file name for storing generated model content`
-	CGenDaoBriefModelFileForDao   = `custom file name generating model for DAO operations like Where/Data. It's empty in default`
-	CGenDaoBriefDescriptionTag    = `add comment to description tag for each field`
-	CGenDaoBriefNoJsonTag         = `no json tag will be added for each field`
-	CGenDaoBriefNoModelComment    = `no model comment will be added for each field`
-	CGenDaoBriefClear             = `delete all generated go files that do not exist in database`
-	CGenDaoBriefGenTable          = `generate table files`
-	CGenDaoBriefTypeMapping       = `custom local type mapping for generated struct attributes relevant to fields of table`
-	CGenDaoBriefFieldMapping      = `custom local type mapping for generated struct attributes relevant to specific fields of table`
-	CGenDaoBriefShardingPattern   = `sharding pattern for table name, e.g. "users_?" will be replace tables "users_001,users_002,..." to "users" dao`
-	CGenDaoBriefGroup             = `
+	CGenDaoBriefFileNameCase      = `
+generated go file name case for dao/table/do/entity files, cases are as follows:
+| Case            | Example            |
+|---------------- |--------------------|
+| Snake           | any_kind_of_string | default
+| SnakeFirstUpper | rgb_code_md5       |
+`
+	CGenDaoBriefImportPrefix    = `custom import prefix for generated go files`
+	CGenDaoBriefDaoPath         = `directory path for storing generated dao files under path`
+	CGenDaoBriefTablePath       = `directory path for storing generated table files under path`
+	CGenDaoBriefDoPath          = `directory path for storing generated do files under path`
+	CGenDaoBriefEntityPath      = `directory path for storing generated entity files under path`
+	CGenDaoBriefOverwriteDao    = `overwrite all dao files both inside/outside internal folder`
+	CGenDaoBriefModelFile       = `custom file name for storing generated model content`
+	CGenDaoBriefModelFileForDao = `custom file name generating model for DAO operations like Where/Data. It's empty in default`
+	CGenDaoBriefDescriptionTag  = `add comment to description tag for each field`
+	CGenDaoBriefNoJsonTag       = `no json tag will be added for each field`
+	CGenDaoBriefNoModelComment  = `no model comment will be added for each field`
+	CGenDaoBriefClear           = `delete all generated go files that do not exist in database`
+	CGenDaoBriefGenTable        = `generate table files`
+	CGenDaoBriefTypeMapping     = `custom local type mapping for generated struct attributes relevant to fields of table`
+	CGenDaoBriefFieldMapping    = `custom local type mapping for generated struct attributes relevant to specific fields of table`
+	CGenDaoBriefShardingPattern = `sharding pattern for table name, e.g. "users_?" will be replace tables "users_001,users_002,..." to "users" dao`
+	CGenDaoBriefGroup           = `
 specifying the configuration group name of database for generated ORM instance,
 it's not necessary and the default value is "default"
 `
@ -128,6 +135,7 @@ func init() {
 		`CGenDaoBriefRemoveFieldPrefix`:  CGenDaoBriefRemoveFieldPrefix,
 		`CGenDaoBriefStdTime`:            CGenDaoBriefStdTime,
 		`CGenDaoBriefWithTime`:           CGenDaoBriefWithTime,
+		`CGenDaoBriefFileNameCase`:       CGenDaoBriefFileNameCase,
 		`CGenDaoBriefDaoPath`:            CGenDaoBriefDaoPath,
 		`CGenDaoBriefTablePath`:          CGenDaoBriefTablePath,
 		`CGenDaoBriefDoPath`:             CGenDaoBriefDoPath,
--- a/cmd/gf/internal/cmd/gendao/gendao_test.go
+++ b/cmd/gf/internal/cmd/gendao/gendao_test.go
@ -10,6 +10,7 @@ import (
 	"testing"

 	"github.com/gogf/gf/v2/test/gtest"
+	"github.com/gogf/gf/v2/text/gstr"
 )

 // Test containsWildcard function.
@ -180,3 +181,12 @@ func Test_filterTablesByPatterns_NonExistent(t *testing.T) {
 		t.AssertNI("nonexistent", result)
 	})
 }
+
+func Test_formatFileName(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		t.Assert(formatFileName("sys_i18n_message", ""), "sys_i_18_n_message")
+		t.Assert(formatFileName("sys_i18n_message", string(gstr.SnakeFirstUpper)), "sys_i18n_message")
+		t.Assert(formatFileName("SYS_I18N_MESSAGE", string(gstr.SnakeFirstUpper)), "sys_i18n_message")
+		t.Assert(formatFileName("user_test", string(gstr.SnakeFirstUpper)), "user_test_table")
+	})
+}