Compare commits

..

46 Commits

Author SHA1 Message Date
f3d36ad408 Apply gci import order changes 2026-05-18 20:36:18 +00:00
64aaf9e14d Apply gci import order changes 2026-04-28 09:21:28 +00:00
320ad437cb feat(cli): 添加可视化配置编辑器 2026-04-28 17:20:52 +08:00
94623a19d1 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-04-25 17:47:05 +08:00
cb7cfa58ab fix: guard os.Args access for wasm which panics when building (#4762)
This pull request improves the reliability and safety of server restart
and reload operations by ensuring the correct retrieval of the current
executable path and process arguments. It replaces direct usage of
`os.Args[0]` with a more robust approach using `gfile.SelfPath()`, and
adds error handling for cases where the executable path cannot be
determined. Additionally, it introduces a helper function to safely
obtain process arguments, and removes an unnecessary import.

**Executable Path Handling and Error Checking:**

- Replaced usage of `os.Args[0]` with `gfile.SelfPath()` throughout the
server admin and process management code to reliably determine the
current executable path; added checks and error responses when the path
cannot be determined.
[[1]](diffhunk://#diff-0d174b149c56c4aa7ffeba2be94d16dc1b8000933f1f2a2e6bf011acdad3272fL122-R134)
[[2]](diffhunk://#diff-0d174b149c56c4aa7ffeba2be94d16dc1b8000933f1f2a2e6bf011acdad3272fL168-R184)
[[3]](diffhunk://#diff-3b4265be7ef0335b832dacfc2fc7ddc0f9dfae5b81340ff57d2b6a526c60d9e1L62-R65)
- Added early returns in initialization functions if `os.Args` is empty,
preventing potential panics or misbehavior when the argument list is
missing.
[[1]](diffhunk://#diff-0aa99f033274ea60b9c466ae4fc98d0816ec13781d8ec787fb3ef106a49a79ecR35-R37)
[[2]](diffhunk://#diff-5782fa47aa858b8e8358fd50353b050ee30418b7844b36e313e9c6d01188c092R47-R49)

**Process Argument Handling:**

- Introduced the `getCurrentProcessArgs()` helper function to safely
return process arguments (excluding the program name), ensuring correct
behavior even if no arguments are provided. Updated process creation
calls to use this helper.

**Code Cleanup:**

- Removed an unused import of the `os` package from
`ghttp_server_admin.go`.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-04-22 20:44:57 +08:00
1878202625 test(contrib/drivers/mariadb): add layer 3 features and issue regression tests (#4724)
## Summary

- Port 5 feature tests: duplicate-key handling
(OnDuplicate/OnDuplicateEx/Save), JSON field operations, row-level
locking (Lock/LockUpdate/LockShared with transactions), master-slave
configuration, table metadata inspection
- Port 1 partition test: RANGE partitioning with Partition() clause
(adapted from MySQL baseline)
- Port 30 issue regression tests from MySQL baseline
- Includes 14 testdata SQL files for issue-specific table schemas

Layer 3 tests cover MariaDB-specific adaptations where needed (e.g.,
SKIP LOCKED requires MariaDB 10.6+ — commented out for compatibility,
LOCK IN SHARE MODE instead of FOR SHARE for older versions).

All tests are structurally aligned with the MySQL driver baseline.
Package and import references are adapted for MariaDB.

ref #4689

Co-authored-by: John Guo <claymore1986@gmail.com>
2026-04-10 09:38:43 +08:00
bb71ccfd4c fix(database/gdb): strip quote chars from schema in Model.TableFields (#4730)
## Summary

When performing cross-database JOINs with soft-delete, the schema name
parsed from `` `schema`.`table` `` format retains database-specific
quote characters. These quoted schema names break `information_schema`
WHERE clause queries in `TableFields` lookups.

This PR strips quote characters from `usedSchema` in
`Model.TableFields()`, matching the existing unquoting pattern used for
`usedTable` via `guessPrimaryTableName`.

## Changes

- `database/gdb/gdb_model_utility.go`: Add quote-stripping for
`usedSchema` using `gstr.Trim` with database-specific quote chars from
`GetChars()`

## Test

Existing `Test_Issue2338` in MySQL
(`contrib/drivers/mysql/mysql_z_unit_issue_test.go:685`) covers this
case. The MariaDB version exists in PR #4724 branch
(`contrib/drivers/mariadb/mariadb_z_unit_issue_test.go:688`), not yet
merged. Once both PRs are merged, the MariaDB test will also validate
this fix.

closes #4725

Co-authored-by: John Guo <claymore1986@gmail.com>
2026-04-10 09:05:17 +08:00
f67b2dca26 fix(contrib/drivers/mysql): use unreachable port for nodeInvalid test config (#4726)
## Summary
- Change nodeInvalid port from 3307 to 3316 (default 3306 + 10) so the
connection is guaranteed to fail as intended
- Port 3307 may collide with a running MariaDB instance in CI, causing
nodeInvalid to accidentally connect to a live database

ref #4689
2026-03-24 17:51:21 +08:00
68b02218d7 test(contrib/drivers/mariadb): add infrastructure, core and model tests (#4719)
## Summary

- Add full test infrastructure (`mariadb_unit_init_test.go`) with
MariaDB-specific helpers (createTable, createInitTable, dropTable)
matching the MySQL test baseline
- Port 4 basic tests from MySQL: `Test_New`, `Test_DB_Ping`,
`Test_DB_Query`, `Test_DB_Exec`
- Port 47 core tests covering CRUD operations, raw SQL, schema
switching, and DB/TX method parity
- Port 55 model tests covering Model API: Fields, Where, Scan, Save,
Replace, InsertIgnore, InsertGetId, OmitEmpty, Distinct,
Count/Min/Max/Avg/Sum, HasField, chained operations, testdata SQL-based
scenarios and more
- Add 5 testdata SQL files required by model tests (copied from MySQL
baseline)

All tests are structurally identical to the MySQL driver baseline. SQL
syntax is standard and shared. Package and import references are adapted
for MariaDB.

ref #4689

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-03-24 17:50:05 +08:00
766579d868 test(contrib/drivers/mariadb): add transaction, where, hook and ctx tests (#4720)
## Summary

- Port 28 transaction tests: Begin/Commit/Rollback, nested SavePoint,
transaction propagation (Required/Nested/NotSupported), timeout, panic
recovery, concurrent transactions
- Port 41 where-condition tests:
Where/WhereOr/WhereNot/WhereIn/WhereBetween, prefix handling, complex
AND/OR combinations, NULL checks, struct/map/slice parameter types
- Port 11 hook tests: HookSelect/HookInsert/HookUpdate/HookDelete for
both Model and raw SQL paths, hook chaining and context propagation
- Port 8 ctx tests: context propagation through Model/TX operations,
context-based logging with traceId verification

All tests are structurally identical to the MySQL driver baseline. SQL
syntax is standard and shared. Package and import references are adapted
for MariaDB.

ref #4689
2026-03-12 11:16:14 +08:00
030cd84836 test(contrib/drivers/mariadb): add softtime, with, scanlist, union and do tests (#4721)
## Summary

- Port 48 soft-time tests: soft create/update/delete with
timestamp/datetime/date types, SoftTime switches
(SoftTimeTypeOff/Delete/Timestamp), Unscoped, ForceDelete, joined
queries with soft-delete
- Port 19 With/ScanList tests: With/WithAll for eager loading of
hasOne/hasMany/belongsTo relations, ScanList for manual relation
mapping, nested With
- Port 12 union tests: Union/UnionAll with various parameter forms
(string/Model/subquery), combined with OrderBy, Limit, Where conditions
- Port 12 gdb.Do tests: DoSelect/DoInsert/DoUpdate/DoDelete raw
operation hooks, batch insert, InsertIgnore/InsertGetId/Replace via
DoInsert option

Includes testdata SQL files for With relation table schemas (with_tpl).
Soft-time tests create tables inline via SQL, no separate testdata files
needed.

All tests are structurally identical to the MySQL driver baseline. SQL
syntax is standard and shared. Package and import references are adapted
for MariaDB.

ref #4689
2026-03-12 11:15:42 +08:00
6314cd4c89 test(contrib/drivers/mariadb): add builder, struct, join, batch, cache and omit tests (#4722)
## Summary

- Port 25 SQL builder tests: WhereBuilder chaining, complex
Where/WhereOr/WhereNot combinations, nested builders, Build() output
verification
- Port 9 subquery tests: subquery in Where/Having/From, correlated
subqueries, subquery with Model builder
- Port 11 struct-mapping tests: Scan to struct/slice, embedded structs,
tag-based field mapping, pointer fields, OmitEmpty with struct input
- Port 12 join tests: LeftJoin/RightJoin/InnerJoin, multi-table joins,
join with Where/Order/Fields, subquery joins, testdata SQL-based join
scenarios
- Port 8 batch operation tests: Batch insert/update/replace/save with
configurable batch size, conflict handling
- Port 4 cache tests: query result caching, cache invalidation on
update/delete, cache duration, ClearCache
- Port 4 OmitNil/OmitEmpty tests: nil field omission in insert/update,
zero-value vs nil distinction

All tests are structurally identical to the MySQL driver baseline. SQL
syntax is standard and shared. Package and import references are adapted
for MariaDB.

ref #4689
2026-03-12 11:15:17 +08:00
0588009c40 test(contrib/drivers/mariadb): add pagination, error, concurrent, rawtype and sharding tests (#4723)
## Summary

- Port 11 pagination tests: Page/Limit/Offset, combined with
Where/Order, boundary conditions (page 0, large offset), Count with
pagination
- Port 8 error-handling tests: invalid table/field names, syntax errors,
duplicate key, connection errors, error wrapping and message
verification
- Port 5 concurrency tests: parallel read/write with goroutines and
WaitGroup, concurrent transactions, race condition verification
- Port 6 raw-type tests: custom type scanning, time.Time handling,
json.RawMessage, sql.NullString/NullInt64, []byte fields
- Port 6 sharding/table-name tests: dynamic table name via Sharding
callback, table name with prefix, schema.table format

All tests are structurally identical to the MySQL driver baseline. SQL
syntax is standard and shared. Package and import references are adapted
for MariaDB.

ref #4689
2026-03-12 11:14:48 +08:00
6204c132c7 test(contrib/drivers/mysql): add pagination and error handling tests (#4703)
## Summary
- Add comprehensive pagination tests (Limit, Offset, Page, ForPage)
- Add error handling tests for invalid operations
- Add tests for edge cases and boundary conditions

**Test coverage added:**
- Pagination: ~28 test functions
- Error handling: ~20 test functions

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "TestModel_Pagination|TestModel_Error|TestModel_InvalidOperation"
```
2026-02-27 20:00:25 +08:00
a4b80e8680 fix(contrib/drivers/pgsql): preserve bytea data integrity on read and write (#4678)
## Summary

Fix two bytea data corruption issues in the PostgreSQL driver:

1. **READ path** (fixes #4677): `CheckLocalTypeForField` and
`ConvertValueForLocal` had no case for plain `bytea` type, causing it to
fall through to the Core layer which incorrectly mapped it to
`LocalTypeString`. Binary data was then converted to string via
`gconv.String()`, corrupting the bytes on retrieval.

2. **WRITE path** (fixes #4231): `ConvertValueForField` applied
PostgreSQL array syntax conversion (`[` → `{`, `]` → `}`) to all slice
types including `[]byte` for bytea columns, corrupting bytes `0x5B`
(`[`) and `0x5D` (`]`) on insertion.

## Changes

- **`contrib/drivers/pgsql/pgsql_convert.go`**:
  - `CheckLocalTypeForField`: Add `case "bytea"` → `LocalTypeBytes`
- `ConvertValueForLocal`: Add `case "bytea"` to preserve `[]byte` as-is
- `ConvertValueForField`: Skip `[]`→`{}` replacement for `[]byte` with
`bytea` field type

- **`contrib/drivers/pgsql/pgsql_z_unit_convert_test.go`**:
- Add unit tests for `bytea` type in `CheckLocalTypeForField`,
`ConvertValueForLocal`, and `ConvertValueForField`

- **`contrib/drivers/pgsql/pgsql_z_unit_issue_test.go`**:
- Add `Test_Issue4677`: End-to-end round-trip test with various binary
data (including 0x00, 0x5B, 0x5D, 0xFF)
- Add `Test_Issue4231`: Targeted test for 0x5D byte corruption on write

## Test plan

- [x] `Test_CheckLocalTypeForField` - bytea returns `LocalTypeBytes`
- [x] `Test_ConvertValueForLocal` - bytea preserves `[]byte` as-is
- [x] `Test_ConvertValueForField` - bytea skips array syntax replacement
- [x] `Test_Issue4677` - full DB round-trip with binary data
- [x] `Test_Issue4231` - write path preserves 0x5B/0x5D bytes
- [x] Full pgsql test suite passes with no regressions

closes #4677
closes #4231

ref #4689
2026-02-27 16:22:43 +08:00
0e1cb15dc0 fix(os/gstructs): strip tag options in TagPriorityName to avoid field name pollution (#4681)
## Summary
- Fix `TagPriorityName()` to strip comma-separated tag options (e.g.,
`omitempty`) from tag values
- Before: `json:"user_name,omitempty"` → field name =
`user_name,omitempty`
- After: `json:"user_name,omitempty"` → field name = `user_name`
- Aligns with `structcache.genPriorityTagAndFieldName()` which already
handles this correctly
- When tag name is empty (e.g., `gconv:",omitempty"`), continues to next
priority tag instead of breaking

## Test plan
- [x] Reproduced bug: `RuleFuncInput.Field` was `user_name,omitempty`
instead of `user_name`
- [x] Verified fix: field name correctly extracted as `user_name`
- [x] Verified fallthrough: `gconv:",omitempty"` + `json:"name"` → uses
`name`
- [x] Existing `Test_Fields_TagPriorityName` passes
- [x] Full `os/gstructs` test suite passes
- [x] Full `util/gvalid` test suite passes
- [x] Full `util/gconv` test suite passes

closes #4665
2026-02-27 16:14:26 +08:00
612e545ae2 fix(databse/gdb): use COUNT(1) if fields number is greater than 1 even when parameter useFieldForCount is true in AllAndCount/ScanAndCount (#4701)
## Summary
Fix bug where `AllAndCount(true)` with multiple fields generates invalid
SQL `COUNT(field1, field2, ...)` causing syntax error.

## Root Cause
When `useFieldForCount=true`, the COUNT query inherits the fields
configuration from the model:
```go
// Before (buggy code)
if !useFieldForCount {
    countModel.fields = []any{Raw("1")}
}
// When useFieldForCount=true, fields remain as ["id", "nickname"]
// Generates: SELECT COUNT(id, nickname) FROM table 
```

## Fix
Always use `COUNT(1)` regardless of `useFieldForCount` parameter since
COUNT() accepts only one argument:
```go
// After (fixed code)
// Always use COUNT(1) for counting, regardless of useFieldForCount.
// COUNT() accepts only one argument, so we can't use multiple fields.
countModel.fields = []any{Raw("1")}
```

Applied to both `AllAndCount()` and `ScanAndCount()` methods.

## Tests
Added `Test_Issue4698` with 5 test cases:
1. AllAndCount(true) with multiple fields
2. AllAndCount(false) with multiple fields (baseline)
3. ScanAndCount with multiple fields
4. AllAndCount with single field
5. AllAndCount with WHERE condition

All tests verify that COUNT generates valid SQL and returns correct
count.

## Related
Fixes #4698
Ref #4703 (discovered during pagination test development)
2026-02-27 16:12:58 +08:00
bbdd442954 fix(database/gdb): treat negative Limit/Page/Offset values as zero (#4702)
## Summary
Fix bug where negative values in `Limit()`, `Page()`, and `Offset()`
methods generate invalid SQL causing database errors.

## Root Cause
The methods don't validate negative input:
- `Limit(-1)` generates `LIMIT -1` → SQL error
- `Page(1, -10)` generates `LIMIT -10` → SQL error  
- `Offset(-5)` generates `OFFSET -5` → SQL error

## Fix
Treat all negative values as zero (safe default):

**Limit() method**:
```go
case 1:
    if limit[0] < 0 { limit[0] = 0 }
case 2:
    if limit[0] < 0 { limit[0] = 0 }
    if limit[1] < 0 { limit[1] = 0 }
```

**Page() method**:
```go
if limit < 0 { limit = 0 }
```

**Offset() method**:
```go
if offset < 0 { offset = 0 }
```

## Behavior Changes
- `Limit(-1)` → `Limit(0)` (no limit)
- `Limit(-10, -5)` → `Limit(0, 0)` (no offset, no limit)
- `Page(1, -10)` → `Page(1, 0)` (no results)
- `Offset(-5)` → `Offset(0)` (no offset)

## Documentation
Added "Note: Negative values are treated as zero" to all three methods.

## Tests
Added `Test_Issue4699` in `database/gdb/gdb_z_unit_issue_test.go` with 7
test cases:
1. Limit with single negative parameter
2. Limit with two negative parameters
3. Limit with mixed parameters (negative start, positive limit)
4. Page with negative limit
5. Page with negative limit on page 2
6. Offset with negative value
7. Offset with positive value (sanity check)

## Related
Fixes #4699
Ref #4703 (discovered during pagination test development)
2026-02-27 16:00:53 +08:00
6686bd65a2 test(contrib/drivers/mysql): enhance transaction tests (#4704)
## Summary
- Add nested transaction tests
- Add transaction propagation tests
- Add transaction rollback/commit behavior tests
- Add transaction context handling tests

**Test coverage added:** ~25 test functions

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "TestTX_Nested|TestTX_Propagation|TestTX_Transaction"
```
2026-02-27 15:56:16 +08:00
319a812934 test(contrib/drivers/mysql): enhance data type tests (#4705)
## Summary
- Add comprehensive tests for various data types (int, float, string,
[]byte, time, etc.)
- Add struct field type conversion tests
- Add JSON/XML data type tests
- Add binary data handling tests

**Test coverage added:** ~28 test functions

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "TestModel_.*Type|TestModel_.*Convert"
```
2026-02-27 15:53:44 +08:00
307c6ec307 test(contrib/drivers/mysql): enhance complex query tests (#4707)
## Summary
- Add comprehensive JOIN tests (Inner/Left/Right Join)
- Add SubQuery tests
- Add complex WHERE condition tests (Or/Group/Having)
- Add advanced query builder tests

**Test coverage added:** ~26 test functions across 3 files

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "TestModel_Join|TestModel_SubQuery|TestModel_Where.*Complex"
```
2026-02-27 15:52:41 +08:00
bac637570d test(contrib/drivers/mysql): add MySQL-specific feature tests (#4709)
## Summary
- Add ON DUPLICATE KEY UPDATE tests (basic, increment, batch,
conditional, transaction)
- Add MySQL JSON data type tests (insert/update/query, JSON_EXTRACT,
JSON_CONTAINS, struct scanning)
- Add MySQL partition tests (RANGE, HASH, LIST partitioning with CRUD
and transactions)

**Test coverage added:** ~25 test functions across 3 files (Layer 3)

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "Test_OnDuplicateKeyUpdate|Test_DataType_Json|Test_Partition"
```
2026-02-27 15:52:06 +08:00
c8a11f7f6e test(contrib/drivers/mysql): add concurrent/Hook/Ctx tests (#4708)
## Summary
- Add concurrent operation tests
- Add Hook mechanism tests (Insert/Update/Delete/Select)
- Add Context propagation tests
- Add race condition tests

**Test coverage added:** ~28 test functions across 5 files

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -race -run "TestModel_Concurrent|TestModel_Hook|TestModel_Ctx"
```
2026-02-26 16:28:20 +08:00
e0c032d1b1 fix(database/gdb): handle empty string in Fields() gracefully (#4700)
## Summary
Fix bug where `Fields("")` with empty string generates invalid SQL
`SELECT FROM table`.

## Root Cause
`mappingAndFilterToTableFields` method doesn't skip empty strings when
processing fields:
- `gstr.SplitAndTrim("", ",")` returns empty array
- No fields added to query
- Results in invalid SQL: `SELECT FROM table`

## Fix
Skip empty string fields in `mappingAndFilterToTableFields` (line
97-100):
```go
// Skip empty string fields
if fieldStr == "" {
    continue
}
```

## Behavior Changes
- `Fields("")` → SELECT * FROM table (uses default)
- `Fields("", "id")` → SELECT id FROM table (ignores empty string)
- `Fields("id", "", "nickname")` → SELECT id, nickname FROM table

## Tests
Added `Test_Issue4697` with 3 scenarios covering all cases above.

## Related
Fixes #4697
Ref #4703 (discovered during pagination test development)
2026-02-26 16:27:00 +08:00
063264ebff test(contrib/drivers/mysql): add Lock/Omit/Cache/Batch tests (#4706)
## Summary
- Add Lock/LockUpdate/LockShared tests
- Add OmitNil/OmitEmpty/OmitNilData tests
- Add Cache mechanism tests
- Add Batch operation tests

**Test coverage added:** ~34 test functions across 4 files

Ref #4689

## Test plan
```bash
cd contrib/drivers/mysql
go test -v -run "TestModel_Lock|TestModel_Omit|TestModel_Cache|TestModel_Batch"
```
2026-02-26 09:53:35 +08:00
02abc515a3 test(contrib/drivers/gaussdb): add soft time, with, scanlist test coverage (#4686)
## Summary
- Port 3 test files and 4 testdata SQL files from PgSQL driver to
GaussDB driver
- Add `gaussdb_z_unit_feature_soft_time_test.go` (15 tests): soft time
create/update/delete, bool/int/datetime soft delete
- Add `gaussdb_z_unit_feature_with_test.go` (6 tests): With/WithAll ORM
relation queries, multiple dependency levels
- Add `gaussdb_z_unit_feature_scanlist_test.go` (9 tests): ScanList for
1:1, 1:N, N:N relation mapping
- Add 4 testdata SQL files for With relation tests
- **30 new test functions**, ~3,941 net new lines

## Test plan
- [x] `go build ./...` passes
- [x] `gofmt` and `gci` applied
- [x] No remaining `pgsql` references in new files
- [ ] Run full test suite against GaussDB instance

ref #4689

---------

Co-authored-by: John Guo <claymore1986@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-26 09:51:52 +08:00
be7851c664 test(contrib/drivers/pgsql): add SoftTime, With, ScanList test coverage (#4676)
## Summary
- Add 3 new test files for pgsql driver (39 test functions, ~3800 lines)
- `pgsql_z_unit_feature_soft_time_test.go`: 15 tests — soft delete
(SoftDeleted/Unscoped), auto time fields
(CreatedAt/UpdatedAt/DeletedAt), time format options
- `pgsql_z_unit_feature_with_test.go`: 17 tests — With relation queries
(one-to-one, one-to-many, many-to-many), nested With, WithAll,
conditional With
- `pgsql_z_unit_feature_scanlist_test.go`: 7 tests — ScanList relation
mapping for struct slices
- Add testdata SQL templates for With tests

**PostgreSQL adaptations from MySQL:**
- `AUTO_INCREMENT` → `SERIAL/BIGSERIAL`
- `datetime` → `timestamp`
- MySQL backticks → PostgreSQL double quotes for identifiers
- Timestamp format handling for soft time fields

## Test plan
- [x] Run `go test -v -run "Test_Model_Soft" -count=1` in
`contrib/drivers/pgsql`
- [x] Run `go test -v -run "Test_Model_With" -count=1` in
`contrib/drivers/pgsql`
- [x] Run `go test -v -run "Test_Model_ScanList" -count=1` in
`contrib/drivers/pgsql`

ref #4689
2026-02-26 09:49:48 +08:00
dc08920a7f feat(gcrypto/gsha512): add sha512 implements (#4667)
Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-26 09:47:08 +08:00
1ab0b18115 feat(os/gcfg): add GetEffective method with standard config priority (#4673)
## Summary
- Add `GetEffective` and `MustGetEffective` methods following 12-Factor
App config priority
- Priority: Command line > Environment variables > Config file > Default
value
- Add clarifying notes to existing `GetWithEnv`/`GetWithCmd` methods
- Add comprehensive unit tests

## Test plan
- [x] All gcfg unit tests pass (44 tests)
- [x] New `Test_GetEffective` covers 6 scenarios:
  - Config file only
  - Env overrides config
  - Cmd overrides env
  - Default value fallback
  - Empty string override (industry standard)
  - Key only in env

Closes #4650

---------

Co-authored-by: John Guo <claymore1986@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-26 09:45:56 +08:00
ebd78fb533 test(contrib/drivers/pgsql): add transaction, where, hook, ctx test coverage (#4675)
## Summary
- Add 4 new test files for pgsql driver to align with MySQL driver test
coverage (86 test functions, ~3100 lines)
- `pgsql_z_unit_transaction_test.go`: 40 tests — TX CRUD, nested
transactions, propagation behaviors
(Required/RequiresNew/Nested/NotSupported/Mandatory/Never/Supports),
isolation levels (ReadCommitted/RepeatableRead/Serializable), savepoints
- `pgsql_z_unit_model_where_test.go`: 35 tests — Where variants
(string/slice/map/struct/gmap), comparisons (LT/LTE/GT/GTE), IN/NotIn,
Between, Like, Null, EXISTS/NOT EXISTS subqueries, WherePrefix with JOIN
- `pgsql_z_unit_feature_hook_test.go`: 6 tests —
Select/Insert/Update/Delete hooks, Count with hook, hook chaining and
error handling
- `pgsql_z_unit_feature_ctx_test.go`: 5 tests — context propagation,
trace logging (SpanId/TraceId), transaction context, timeout
cancellation
- Migrate `Test_Model_Where` from `pgsql_z_unit_model_test.go` to
dedicated where test file with expanded coverage (2 → 30+ sub-tests)

**PostgreSQL adaptations from MySQL:**
- `?` → `$N` placeholders for raw SQL
- `REPLACE INTO` → `OnConflict("id").Save()` for upsert
- `AUTO_INCREMENT` → `bigserial`
- `user` alias → `"user"` (reserved word in PgSQL)
- Skip `READ UNCOMMITTED` dirty read test (PgSQL treats as READ
COMMITTED)

## Test plan
- [ ] Run `go test -v -run "Test_TX_" -count=1` in
`contrib/drivers/pgsql`
- [ ] Run `go test -v -run "Test_Model_Where" -count=1` in
`contrib/drivers/pgsql`
- [ ] Run `go test -v -run "Test_Model_Hook" -count=1` in
`contrib/drivers/pgsql`
- [ ] Run `go test -v -run "Test_Ctx" -count=1` in
`contrib/drivers/pgsql`
- [ ] Verify `go vet ./...` passes (only unreachable code warnings
matching MySQL driver pattern)

ref #4689

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-02-26 09:43:32 +08:00
841003eeb3 test(contrib/drivers/gaussdb): add transaction, where, hook, ctx test coverage (#4685)
## Summary
- Port 4 test files from PgSQL driver to GaussDB driver to align test
coverage
- Add `gaussdb_z_unit_transaction_test.go` (40 tests): nested
transactions, savepoints, rollback, panic recovery, context propagation
- Add `gaussdb_z_unit_model_where_test.go` (35 tests): comprehensive
Where clause combinations (map, slice, struct, pointer, operators, nil,
empty)
- Add `gaussdb_z_unit_feature_hook_test.go` (6 tests): model hook
callbacks (Select/Insert/Update/Delete)
- Add `gaussdb_z_unit_feature_ctx_test.go` (5 tests): context
propagation, timeout, logging with context
- Remove old `Test_Model_Where` (2 sub-tests) from
`gaussdb_z_unit_model_test.go`, replaced by comprehensive version in
dedicated where test file (35 tests)
- **86 new test functions**, ~3,224 net new lines

## Test plan
- [x] `go build ./...` passes
- [x] `gofmt` and `gci` applied
- [x] No remaining `pgsql` references in new files
- [ ] Run `go test -v -run "Test_TX_" -count=1` against GaussDB instance
- [ ] Run `go test -v -run "Test_Model_Where" -count=1` against GaussDB
instance
- [ ] Run `go test -v -run "Test_Model_Hook" -count=1` against GaussDB
instance
- [ ] Run `go test -v -run "Test_Ctx" -count=1` against GaussDB instance

ref #4689
2026-02-26 09:42:10 +08:00
1739d4dfb2 feat(i18n/gi18n): decoding and loading i18n files content by automatic file extension check (#4662)
The i18n file handling now checks file extensions instead of content. If
no extension info is found, it reverts to checking the file content.
2026-02-11 15:19:40 +08:00
46cc4cef9e test(contrib/drivers/pgsql): add Union, DO and Raw Where test coverage (#4679)
## Summary
- Add `pgsql_z_unit_feature_union_test.go`: 4 tests for Union/UnionAll
on both db and model level
- Add `pgsql_z_unit_feature_model_do_test.go`: 10 tests for DO (Data
Object) pattern - insert, batch insert, update, pointer fields, WHERE,
DAO pattern, and field prefix handling
- Enhance `pgsql_z_unit_raw_test.go`: add `Test_Raw_Where` for subquery
NOT EXISTS and field comparison using `gdb.Raw()`, adapted for PgSQL
double-quote quoting
- Add `testdata/table_with_prefix.sql` for PgSQL-compatible FieldPrefix
test

All tests adapted from MySQL driver test suite with PgSQL-specific
adjustments:
- Nullable table schema for DO partial inserts (PgSQL NOT NULL is
stricter than MySQL)
- Double-quote identifier quoting instead of backticks
- Unquoted table aliases in generated SQL

## Test plan
- [x] All 15 new tests pass locally
- [x] Full pgsql test suite (107 tests) passes with zero regressions

ref #4689

---------

Co-authored-by: John Guo <claymore1986@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-11 14:41:42 +08:00
90331d85bf test(contrib/drivers/gaussdb): add union, DO, raw where test coverage (#4687)
## Summary
- Port 2 test files, 1 testdata SQL, and append Test_Raw_Where from
PgSQL driver to GaussDB driver
- Add `gaussdb_z_unit_feature_union_test.go` (4 tests): Union/UnionAll
query operations
- Add `gaussdb_z_unit_feature_model_do_test.go` (10 tests): DO
struct-based CRUD operations
- Append `Test_Raw_Where` to `gaussdb_z_unit_raw_test.go` (1 test): raw
SQL in Where with subquery and column comparison
- Add `testdata/table_with_prefix.sql` for DO prefix tests
- **15 new test functions**, ~605 net new lines

## Test plan
- [x] `go build ./...` passes
- [x] `gofmt` and `gci` applied
- [x] No remaining `pgsql` references in new files
- [ ] Run full test suite against GaussDB instance

ref #4689

---------

Co-authored-by: John Guo <claymore1986@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-11 14:40:46 +08:00
98fd2a1973 chore: cleanup makefile, remove unnecessary scripts (#4684)
This pull request primarily removes submodule management targets from
the `Makefile` and makes minor updates to the project documentation in
both English and Chinese. The most important changes are grouped below.

Makefile cleanup:

* Removed the `subup` and `subsync` targets from the `Makefile`,
eliminating commands related to updating and committing submodules.

Documentation updates:

* Updated the logo alt text in both `README.MD` and `README.zh_CN.MD`
from "goframe gf logo" to "goframe logo" for clarity.
[[1]](diffhunk://#diff-01e6d9ffed056a02cae8d8a0ec5d476a64d017bf85c0d5a94bb23ca21f33f5aaL4-R4)
[[2]](diffhunk://#diff-c93759cb9a9500f20e551c741eb167fc72825fd638d36121357feb8253ce6ac1L4-R4)
* Revised a description in `README.zh_CN.MD` to clarify the framework's
purpose, changing “一个强大的框架” to “一款强大的框架”.
* Simplified the license description in `README.zh_CN.MD` to state
"100%开源和免费".
2026-02-11 14:37:49 +08:00
d5633ebad7 fix(contrib/registry): etcd doKeepAlive does not exit even when client context done (#4669)
Fixed #4668 

```
// client
package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/gsvc"
	"github.com/gogf/gf/v2/os/gctx"

	"github.com/gogf/gf/contrib/registry/etcd/v2"
)

func main() {
	gsvc.SetRegistry(etcd.New(`etcd.etcd.orb.local:2379`))

	var (
		ctx    = gctx.New()
		client = g.Client()
	)
	client.SetDiscovery(gsvc.GetRegistry())
	res := client.GetContent(ctx, `http://hello.svc/`)
	g.Log().Info(ctx, res)
}

// server
package main

import (
	"github.com/gogf/gf/contrib/registry/etcd/v2"
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
	"github.com/gogf/gf/v2/net/gsvc"
)

func main() {
	gsvc.SetRegistry(etcd.New(`etcd.etcd.orb.local:2379`))

	s := g.Server(`hello.svc`)
	s.BindHandler("/", func(r *ghttp.Request) {
		g.Log().Info(r.Context(), `request received`)
		r.Response.Write(`Hello world`)
	})
	s.Run()
}

```

```
        /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:105
2. context deadline exceeded
 
Stack:
1.  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doKeepAlive
    /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:107

{"level":"warn","ts":"2026-01-30T22:30:33.863409+0800","logger":"etcd-client","caller":"v3@v3.5.17/retry_interceptor.go:63","msg":"retrying of unary invoker failed","target":"etcd-endpoints://0x1400023a780/etcd.etcd.orb.local:2379","attempt":0,"error":"rpc error: code = DeadlineExceeded desc = latest balancer error: last connection error: connection error: desc = \"transport: Error while dialing: dial tcp 192.168.138.6:2379: connect: operation timed out\""}
2026-01-30T22:30:33.863+08:00 [ERRO] keepalive retry register failed, will retry in 2s: etcd grant failed with keepalive ttl "10s": context deadline exceeded
1. etcd grant failed with keepalive ttl "10s"
   1).  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doRegisterLease
        /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:38
   2).  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doKeepAlive
        /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:105
2. context deadline exceeded
 
Stack:
1.  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doKeepAlive
    /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:107

{"level":"warn","ts":"2026-01-30T22:30:40.865971+0800","logger":"etcd-client","caller":"v3@v3.5.17/retry_interceptor.go:63","msg":"retrying of unary invoker failed","target":"etcd-endpoints://0x1400023a780/etcd.etcd.orb.local:2379","attempt":0,"error":"rpc error: code = DeadlineExceeded desc = latest balancer error: last connection error: connection error: desc = \"transport: Error while dialing: dial tcp 192.168.138.6:2379: connect: operation timed out\""}
2026-01-30T22:30:40.866+08:00 [ERRO] keepalive retry register failed, will retry in 3s: etcd grant failed with keepalive ttl "10s": context deadline exceeded
1. etcd grant failed with keepalive ttl "10s"
   1).  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doRegisterLease
        /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:38
   2).  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doKeepAlive
        /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:105
2. context deadline exceeded
 
Stack:
1.  github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doKeepAlive
    /Users/shown/workspace/golang/open_source/gf/contrib/registry/etcd/etcd_registrar.go:107

2026-01-30T22:30:43.903+08:00 [DEBU] etcd put success with key "/service/default/default/hello.svc/latest/192.168.27.229:60201,192.168.139.3:60201,192.168.163.0:60201", value "{"insecure":true,"protocol":"http"}", lease "7587892536770637317"
2026-01-30T22:30:43.904+08:00 [INFO] keepalive retry register success for service "/service/default/default/hello.svc/latest/192.168.27.229:60201,192.168.139.3:60201,192.168.163.0:60201"
2026-01-30T22:30:51.385+08:00 [INFO] {e0ffad1cac888f18eed5ef7a3ba3f6d0} request received
2026-01-30T22:30:52.121+08:00 [INFO] {78ca8848ac888f18573a386e0b596eaa} request received
```

---------

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
2026-02-11 14:37:15 +08:00
58d6410291 fix(registry/etcd): etcd.NewWithClient() has no DialTimeout (#4670)
# Description

The `etcd.NewWithClient()` function internally does not set a
`DialTimeout` value, which causes it to default to 0. This leads to all
`context.WithTimeout(context.Background(), r.etcdConfig.DialTimeout)`
calls immediately timing out, as a timeout of 0 results in instant
expiration.

# Example

```go
package main

import (
	"context"
	"testing"
	"time"

	"github.com/gogf/gf/contrib/registry/etcd/v2"
	"github.com/gogf/gf/v2/errors/gerror"
	"github.com/gogf/gf/v2/net/gsvc"
	clientv3 "go.etcd.io/etcd/client/v3"
)

func TestEtcdWithClient(t *testing.T) {
	cli, _ := clientv3.New(clientv3.Config{
		Endpoints:   []string{"http://127.0.0.1:2379"},
		DialTimeout: 2 * time.Second,
	})
	defer cli.Close()

	registry := etcd.NewWithClient(cli)
	_, err := registry.Register(context.Background(), &gsvc.LocalService{
		Name:      "test",
		Endpoints: gsvc.NewEndpoints("127.0.0.1:8888"),
	})
	if err != nil {
		t.Error(gerror.Stack(err))
		return
	}
}
```

Running tool: /opt/homebrew/bin/go test -test.fullpath=true -timeout 30s
-run ^TestEtcdWithClient$ etop.roommanageserver

=== RUN   TestEtcdWithClient

{"level":"warn","ts":"2026-01-31T09:59:06.994867+0800","logger":"etcd-client","caller":"v3@v3.6.7/retry_interceptor.go:65","msg":"retrying
of unary invoker
failed","target":"etcd-endpoints://0x14000262f00/127.0.0.1:2379","method":"/etcdserverpb.Lease/LeaseGrant","attempt":0,"error":"rpc
error: code = DeadlineExceeded desc = context deadline exceeded"}
/Users/guolihui/projects/mpl-poker/room-manage-server/main_test.go:27:
1. etcd grant failed with keepalive ttl "10s"
1).
github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).doRegisterLease

/Users/guolihui/projects/mpl-poker/room-manage-server/gfv2/contrib/registry/etcd/etcd_registrar.go:38
2). github.com/gogf/gf/contrib/registry/etcd/v2.(*Registry).Register

/Users/guolihui/projects/mpl-poker/room-manage-server/gfv2/contrib/registry/etcd/etcd_registrar.go:24
           3).  etop%2eroommanageserver.TestEtcdWithClient
/Users/guolihui/projects/mpl-poker/room-manage-server/main_test.go:22
        2. context deadline exceeded

--- FAIL: TestEtcdWithClient (0.00s)
2026-02-11 14:25:19 +08:00
54087de518 test(contrib/drivers/pgsql): add Builder/Subquery/Join/Struct tests (#4680)
## Summary
- Port MySQL test coverage for Builder, Subquery, Join, and Struct
features to PgSQL driver
- Add 4 new test files with 23 test functions covering builder patterns,
subquery WHERE/HAVING/Model, all JOIN types, and struct scanning
- PgSQL dialect adaptations: double-quoted identifiers, GROUP BY with
HAVING, letter-prefixed table names, int64 id assertions, removed `Uid`
field

## Test plan
- [x] Builder tests pass: `go test -v -run
"Test_Model_Builder|Test_Safe_Builder" -count=1`
- [x] Subquery tests pass: `go test -v -run "Test_Model_SubQuery"
-count=1`
- [x] Join tests pass: `go test -v -run
"Test_Model_.*Join.*|Test_Model_FieldsPrefix" -count=1`
- [x] Struct tests pass: `go test -v -run
"Test_Model_Embedded|Test_Struct|Test_Structs|Test_Model_Scan|Test_Scan_Auto"
-count=1`
- [x] Full PgSQL test suite: 113/113 PASS

ref #4689
2026-02-11 13:51:47 +08:00
fc39fffe9c test(contrib/drivers/gaussdb): add builder, subquery, join, struct test coverage (#4688)
## Summary
- Port 4 test files from PgSQL driver to GaussDB driver
- Add `gaussdb_z_unit_feature_model_builder_test.go` (2 tests): SQL
builder with raw expressions and safe mode
- Add `gaussdb_z_unit_feature_model_subquery_test.go` (3 tests):
subquery in Select/Where/Having
- Add `gaussdb_z_unit_feature_model_join_test.go` (7 tests):
LeftJoin/RightJoin/InnerJoin with various conditions
- Add `gaussdb_z_unit_feature_model_struct_test.go` (11 tests):
struct-based insert/update/scan with tag mapping
- **23 new test functions**, ~861 net new lines

## Test plan
- [x] `go build ./...` passes
- [x] `gofmt` and `gci` applied
- [x] No remaining `pgsql` references in new files
- [ ] Run full test suite against GaussDB instance

ref #4689
2026-02-11 13:50:30 +08:00
6a3ea897a8 docs: Update README Add DeepWiki badges (#4661) 2026-01-28 15:42:11 +08:00
91f9864b25 fix: update gf cli to v2.10.0 (#4658)
Automated changes by
[create-pull-request](https://github.com/peter-evans/create-pull-request)
GitHub action

Co-authored-by: gqcn <gqcn@users.noreply.github.com>
2026-01-27 17:43:29 +08:00
8c8c7c8c71 feat: new version v2.10.0 (#4657)
This pull request upgrades the GoFrame framework and all related
dependencies from version `v2.9.8` (and similar) to `v2.10.0` across the
codebase. It also refactors the `.make_version.sh` script to improve
cross-platform compatibility when editing files, and ensures
documentation reflects the new version. These changes help keep the
project up-to-date and simplify version management.

**Dependency upgrades:**

* Updated all `go.mod` files in the main repo and contrib modules to
require `github.com/gogf/gf/v2 v2.10.0` (replacing `v2.9.8` and similar)
for consistency and latest features/bugfixes.
[[1]](diffhunk://#diff-ee0abb9c50b9f91f424349123e31b7b1ba1e1e4f7497250422696c5bda2e74ceL6-R12)
[[2]](diffhunk://#diff-cef597d401b6dad225f9e2e431bdde7e53cb60bdf287624cef38a6a7bb9ae7a3L7-R7)
[[3]](diffhunk://#diff-970f7eacff9cd97a0d8a00d59ea8041eedaa21c7544c6669aaa58ca692c6b274L6-R6)
[[4]](diffhunk://#diff-c23d0ca80cd6588b7df84de8ef84713f0ce0555ba05d2d9e7f5d1e0324b1ed3aL6-R6)
[[5]](diffhunk://#diff-aa230a2b1198e6ef8afeb7f48335eb2e2f51d87d918d63c4d891fea612d18ff0L6-R6)
[[6]](diffhunk://#diff-86c2390edbede20803cd862908fe95e7207f7dbabd5089ddd4838e1f26e7fecaL6-R6)
[[7]](diffhunk://#diff-5e1af33d38ced461fc0e13981d7051e125876d1692efc3aa9cb4b7faa4c18addL7-R7)
[[8]](diffhunk://#diff-8c6247829130f219981483ccf25af699a63de99afedeb0dd5c1b7bd8ff0919bdL9-R9)
[[9]](diffhunk://#diff-accbd2d37d45e51db3fcb0468043b1e1fd53eeac9e3d3558467ef24444188d2fL7-R7)
[[10]](diffhunk://#diff-15fac9b8e76d2782594c91da72f6a6f42fc18e359c3be35bf6564ac3ca09f700L6-R7)
[[11]](diffhunk://#diff-8e1a76afd564b6073aac7b02ca59f296ae45a24da3dc4d5c40f18169f48ceba1L6-R6)
[[12]](diffhunk://#diff-00a9db26966c21305c72e8f659628dffaff0d6e9dc98a751406d2141d51a5d90L7-R7)
[[13]](diffhunk://#diff-2cbf2f66d5cb77d9f4d00e4c0ce45055620fff50c941a588da31729f09a81f1bL6-R7)
[[14]](diffhunk://#diff-20a21d07addeea398c4adb76d077875894a73b4b5b181b9df1fafe497d3fc843L6-R6)
[[15]](diffhunk://#diff-909670f1c29b0bba24faf1420504b9eacdff124c4cbbec1ddec5de60653ad007L6-R6)
[[16]](diffhunk://#diff-8eef5f0c081743f8002e0faba686e838b323cb53b749706ea42e0440aaa793f1L7-R7)
[[17]](diffhunk://#diff-82345842a29e8eaffa4f51aab96fa2aa78597e6639fe4b0ece797bc60edacea8L6-R6)

**Script improvements:**

* Refactored `.make_version.sh` to use a new `sed_inplace` function for
in-place file editing, improving cross-platform support (Linux/macOS)
and removing reliance on a global variable for the sed command.
* Updated `.make_version.sh` to use `sed_inplace` consistently for
version replacement and dependency cleanup steps, ensuring robust file
modification regardless of OS.
[[1]](diffhunk://#diff-546db9206ba1b7973e6187a1025b3904a0b08681d40d0ee4767082040fd0f661L46-R47)
[[2]](diffhunk://#diff-546db9206ba1b7973e6187a1025b3904a0b08681d40d0ee4767082040fd0f661L84-R97)
* Added a step in `.make_version.sh` to insert local development replace
directives for Go modules, streamlining local testing and development.

**Documentation updates:**

* Updated contributor badge version in `README.MD` and `README.zh_CN.MD`
to reflect the new GoFrame version (`v2.10.0`).
[[1]](diffhunk://#diff-01e6d9ffed056a02cae8d8a0ec5d476a64d017bf85c0d5a94bb23ca21f33f5aaL48-R48)
[[2]](diffhunk://#diff-c93759cb9a9500f20e551c741eb167fc72825fd638d36121357feb8253ce6ac1L48-R48)
2026-01-26 20:37:48 +08:00
73211707fb refactor(container): add default nil checker, rename RegisterNilChecker to SetNilChecker, migrate instance containers to type-safe generics (#4630)
## 变更说明

本 PR 主要对代码库进行了重构,以提升类型安全性和优化连接管理实现。

### 详细变更

#### 1. 数据库连接管理优化
- 修改 `RegisterNilChecker`方法返回实例以支持链式调用,涉及
`KVMap`、`ListKVMap`、`TSet`、`AVLKVTree`、`BKVTree`、`RedBlackKVTree`
等多个容器类型
- 更新 `Core`结构体中 `links`字段类型为类型安全的 `KVMap[ConfigNode, *sql.DB]`
- 添加专门的链接检查器函数用于连接池管理
- 使用泛型 `KVMap`替代原始 map 类型提升类型安全性
- 简化连接关闭逻辑并移除不必要的类型断言
- 优化统计功能中的迭代器实现提高性能

#### 2. 数据库驱动类型安全增强
- 将 dm、gaussdb、mssql、oracle 驱动中的 `conflictKeySet` 从 `gset.New`修改为
`gset.NewStrSet`
- 统一使用字符串集合类型以提高类型安全性

#### 3. 配置文件适配器类型安全改进
- 将 `jsonMap`从 `StrAnyMap` 类型更改为泛型 `KVMap[string, *gjson.Json]` 类型
- 添加 `jsonMapChecker` 函数用于 JSON 对象验证
- 使用 `NewKVMapWithChecker` 替代 `NewStrAnyMap` 提高类型安全性
- 简化数据库链接关闭日志中的键值转换逻辑

## 影响范围

- 数据库连接管理模块
- 多个数据库驱动实现
- 配置文件管理系统

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: John Guo <john@johng.cn>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-01-23 16:37:38 +08:00
609f44c5fe fix(cmd/gf): fix genservice losing versioned import paths (#4242) (#4638)
## Summary
- Fix `gf gen service` incorrectly handling versioned imports (e.g.,
`github.com/minio/minio-go/v7` → `github.com/minio/minio-go`)
- The root cause was faulty package name inference from import paths -
Go allows package names to differ from directory names
- Solution: Keep all non-anonymous imports and let gofmt clean up unused
ones

## Changes
- Simplified `calculateImportedItems` function in
`genservice_calculate.go`
- Added test case for versioned imports and aliased imports

## Test plan
- [x] All existing genservice tests pass (`Test_Gen_Service_Default`,
`Test_Issue3328`, `Test_Issue3835`)
- [x] New test `Test_Issue4242` verifies both versioned imports and
aliased imports are preserved
- [x] Verified generated files match expected output exactly

Closes #4242

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-01-22 20:45:19 +08:00
0a82036da5 feat(contrib/registry): update nacos sdk to 2.3.5 (#4628)
- Update nacos go sdk to 2.3.5;
- ctx params not use, skip it;
- adjust docs style

---------

Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
Co-authored-by: hailaz <739476267@qq.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-01-22 19:09:06 +08:00
b4053ed32e feat(os/gcfg): add Loader with automatic struct binding and config watching (like Spring Boot @ConfigurationProperties) (#4575)
# Loader 配置加载器

Loader 是一个通用的配置管理器,提供了类似于 Spring Boot
的`@ConfigurationProperties`的配置加载、监控、更新和管理功能。

## 功能特性

- **泛型支持**:使用 Go 泛型,类型安全的配置绑定
- **配置加载**:从配置源加载数据并绑定到结构体
- **配置监控**:自动监控配置变化并更新
- **自定义转换器**:支持自定义数据转换函数
- **回调处理**:配置变更时的回调函数
- **错误处理**:灵活的错误处理机制

## 安装

```bash
go get github.com/gogf/gf/v2
```

## 使用示例

### 1. 基本用法

#### 用法一

```go
package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gcfg"
	"github.com/gogf/gf/v2/os/gctx"
)

type AppConfig struct {
	Name     string       `json:"name"`
	Age      int          `json:"age"`
	Enabled  bool         `json:"enabled"`
	Features []string     `json:"features"`
	Server   ServerConfig `json:"server"`
}

type ServerConfig struct {
	Host string `json:"host"`
	Port int    `json:"port"`
}

func main() {
	ctx := gctx.New()
	// 创建配置器实例
	loader := gcfg.NewLoader[AppConfig](g.Cfg("test"), "")

	// 加载和监听配置
	loader.MustLoadAndWatch(ctx, "test-watcher")

	// 获取配置
	config := loader.Get()
	fmt.Println(config.Name)
}
```

#### 用法二

```go
package main

import (
	"fmt"
	"github.com/gogf/gf/v2/os/gcfg"
	"github.com/gogf/gf/v2/os/gctx"
)

type AppConfig struct {
	Name     string       `json:"name"`
	Age      int          `json:"age"`
	Enabled  bool         `json:"enabled"`
	Features []string     `json:"features"`
	Server   ServerConfig `json:"server"`
}

type ServerConfig struct {
	Host string `json:"host"`
	Port int    `json:"port"`
}

func main() {
	ctx := gctx.New()

	// 使用单独的适配器创建
	// 创建配置管理器
	cfg, _ := gcfg.NewAdapterFile("test.yaml")
	// 创建配置器实例
	loader := gcfg.NewLoaderWithAdapter[AppConfig](cfg, "")

	// 加载和监听配置
	loader.MustLoadAndWatch(ctx, "test-watcher")

	// 获取配置
	config := loader.Get()
	fmt.Println(config.Name)
}
```

### 2. 配置监控

```go


// 仅加载App配置
loader := gcfg.NewLoaderWithAdapter[AppConfig](cfg, "app")

// 设置配置变更回调
loader.OnChange(func (updated AppConfig) error {
// 配置变更时的处理逻辑
println("配置已更新:", updated.Name)
return nil
})

// 加载数据
err := loader.Load(ctx)
if err != nil {
panic(err)
}

// 开始监控配置变化
err := loader.Watch(context.Background(), "my-watcher")
if err != nil {
panic(err)
}

```

### 3. 自定义转换器

```go
// 设置自定义转换器
loader.SetConverter(func (data any, target *AppConfig) error {
// 自定义数据转换逻辑
return nil
})
```

### 4. 便捷方法

```go
// 一步完成加载和监控
loader.MustLoadAndWatch(context.Background(), "my-app")
```

## API 参考

### `NewLoader`

创建一个新的 Loader 实例。

```go
func NewLoader[T any](config *Config, propertyKey string, targetStruct ...*T) *Loader[T]
```

参数:

- `config`: 配置实例,用于监控变化
- `propertyKey`: 监控的属性键模式(使用 "" 或 "." 监控所有配置)
- `targetStruct`: 接收配置值的结构体指针(可选)

### `NewLoaderWithAdapter`

使用适配器创建一个新的 Loader 实例。

```go
func NewLoaderWithAdapter[T any](adapter Adapter, propertyKey string, targetStruct ...*T) *Loader[T]
```

### `Load`

从配置实例加载数据并绑定到目标结构体。

```go
func (l *Loader[T]) Load(ctx context.Context) error
```

### `MustLoad`

与 Load 类似,但出错时会 panic。

```go
func (l *Loader[T]) MustLoad(ctx context.Context)
```

### `Watch`

开始监控配置变化并自动更新目标结构体。

```go
func (l *Loader[T]) Watch(ctx context.Context, name string) error
```

### `MustWatch`

与 Watch 类似,但出错时会 panic。

```go
func (l *Loader[T]) MustWatch(ctx context.Context, name string)
```

### `MustLoadAndWatch`

便捷方法,调用 MustLoad 和 MustWatch。

```go
func (l *Loader[T]) MustLoadAndWatch(ctx context.Context, name string)
```

### `Get`

返回当前配置结构体。

```go
func (l *Loader[T]) Get() T
```

### `GetPointer() *T`

返回指向当前配置结构体的指针。

```go
func (l *Loader[T]) GetPointer() *T
```

### `OnChange`

设置配置变化时调用的回调函数。

```go
func (l *Loader[T]) OnChange(fn func (updated T) error)
```

### `SetConverter`

设置在 Load 操作期间使用的自定义转换函数。

```go
func (l *Loader[T]) SetConverter(converter func (data any, target *T) error)
```

### `SetWatchErrorHandler`

设置在 Watch 过程中 Load 操作失败时调用的错误处理函数。

```go
func (l *Loader[T]) SetWatchErrorHandler(errorFunc func(ctx context.Context, err error))
```

### `SetReuseTargetStruct`

设置是否在更新时重用相同的目标结构体或创建新结构体。

```go
func (l *Loader[T]) SetReuseTargetStruct(reuse bool)
```

### `StopWatch`

停止监控配置变化并移除关联的监控器。

```go
func (l *Loader[T]) StopWatch(ctx context.Context) (bool, error)
```

### `IsWatching`

返回 Loader 是否正在监控配置变化。

```go
func (l *Loader[T]) IsWatching() bool
```

## 高级用法

### 监控特定配置键

```go
// 只监控特定配置键
loader := gcfg.NewLoaderWithAdapter[ServerConfig](cfg, "server")
```

### 使用默认值

```go
// 创建带默认值的目标结构体
var targetConfig AppConfig
targetConfig.Name = "default-app" // 设置默认值

loader := gcfg.NewLoaderWithAdapter(cfg, "", &targetConfig)
```

## 错误处理

Loader 提供了灵活的错误处理机制:

```go
loader.SetWatchErrorHandler(func(ctx context.Context, err error) {
    // 处理加载错误
    log.Printf("配置加载失败: %v", err)
})
```

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: houseme <housemecn@gmail.com>
2026-01-22 19:04:52 +08:00
289 changed files with 55505 additions and 6383 deletions

View File

@ -0,0 +1,21 @@
---
name: "Standardize markdown document formatting"
description: "Standardize the formatting of all markdown documents to keep structure clear, content readable, and the overall quality and user experience consistent. This document explains requirements for heading levels, paragraph formatting, code block usage, list formatting, and image and link insertion so authors can follow a unified style that is easier to read and maintain."
applyTo: "*.{md,MD}"
---
# Primary Formatting Requirements
- Keywords or specialized terms in the document must be formatted with inline code, for example `RuntimeClass`, `containerd`, `GPU`, and `AI`.
- In Chinese text, do not add spaces around inline code.
- For technical articles, review the generated content before finalizing it to ensure the material is technically accurate and contains no incorrect technical descriptions.
- When the generated content is too large, split it into multiple tasks to avoid exceeding model output limits and causing the workflow to fail.
# Detailed Content Requirements
- When documenting parameters or configuration items for a component or project, prefer tables when practical, and keep tables short enough to avoid horizontal scrolling during normal reading.
- In Chinese paragraphs, use full-width punctuation rather than half-width punctuation, for example `` instead of `,` and `` instead of `;`.
- Use `mermaid` for architecture diagrams, flowcharts, and similar visuals. If you need line breaks inside `mermaid`, use `<br/>` instead of `\n`.
- If a code block is not a `mermaid` diagram and instead uses box-drawing characters such as `┌─`, `┐`, `┤`, or `│`, keep the content in English so the layout stays aligned.
- Do not use `---` as a separator between paragraphs.

View File

@ -0,0 +1,152 @@
---
name: "OPSX: Apply"
description: Implement tasks from an OpenSpec change (Experimental)
category: Workflow
tags: [workflow, artifacts, experimental]
---
Implement tasks from an OpenSpec change.
**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
**Steps**
1. **Select the change**
If a name is provided, use it. Otherwise:
- Infer from conversation context if the user mentioned a change
- Auto-select if only one active change exists
- If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select
Always announce: "Using change: <name>" and how to override (e.g., `/opsx:apply <other>`).
2. **Check status to understand the schema**
```bash
openspec status --change "<name>" --json
```
Parse the JSON to understand:
- `schemaName`: The workflow being used (e.g., "spec-driven")
- Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others)
3. **Get apply instructions**
```bash
openspec instructions apply --change "<name>" --json
```
This returns:
- Context file paths (varies by schema)
- Progress (total, complete, remaining)
- Task list with status
- Dynamic instruction based on current state
**Handle states:**
- If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue`
- If `state: "all_done"`: congratulate, suggest archive
- Otherwise: proceed to implementation
4. **Read context files**
Read the files listed in `contextFiles` from the apply instructions output.
The files depend on the schema being used:
- **spec-driven**: proposal, specs, design, tasks
- Other schemas: follow the contextFiles from CLI output
5. **Show current progress**
Display:
- Schema being used
- Progress: "N/M tasks complete"
- Remaining tasks overview
- Dynamic instruction from CLI
6. **Implement tasks (loop until done or blocked)**
For each pending task:
- Show which task is being worked on
- Make the code changes required
- Keep changes minimal and focused
- Mark task complete in the tasks file: `- [ ]` → `- [x]`
- Continue to next task
**Pause if:**
- Task is unclear → ask for clarification
- Implementation reveals a design issue → suggest updating artifacts
- Error or blocker encountered → report and wait for guidance
- User interrupts
7. **On completion or pause, show status**
Display:
- Tasks completed this session
- Overall progress: "N/M tasks complete"
- If all done: suggest archive
- If paused: explain why and wait for guidance
**Output During Implementation**
```
## Implementing: <change-name> (schema: <schema-name>)
Working on task 3/7: <task description>
[...implementation happening...]
✓ Task complete
Working on task 4/7: <task description>
[...implementation happening...]
✓ Task complete
```
**Output On Completion**
```
## Implementation Complete
**Change:** <change-name>
**Schema:** <schema-name>
**Progress:** 7/7 tasks complete ✓
### Completed This Session
- [x] Task 1
- [x] Task 2
...
All tasks complete! You can archive this change with `/opsx:archive`.
```
**Output On Pause (Issue Encountered)**
```
## Implementation Paused
**Change:** <change-name>
**Schema:** <schema-name>
**Progress:** 4/7 tasks complete
### Issue Encountered
<description of the issue>
**Options:**
1. <option 1>
2. <option 2>
3. Other approach
What would you like to do?
```
**Guardrails**
- Keep going through tasks until done or blocked
- Always read context files before starting (from the apply instructions output)
- If task is ambiguous, pause and ask before implementing
- If implementation reveals issues, pause and suggest artifact updates
- Keep code changes minimal and scoped to each task
- Update task checkbox immediately after completing each task
- Pause on errors, blockers, or unclear requirements - don't guess
- Use contextFiles from CLI output, don't assume specific file names
**Fluid Workflow Integration**
This skill supports the "actions on a change" model:
- **Can be invoked anytime**: Before all artifacts are done (if tasks exist), after partial implementation, interleaved with other actions
- **Allows artifact updates**: If implementation reveals design issues, suggest updating artifacts - not phase-locked, work fluidly

View File

@ -0,0 +1,157 @@
---
name: "OPSX: Archive"
description: Archive a completed change in the experimental workflow
category: Workflow
tags: [workflow, archive, experimental]
---
Archive a completed change in the experimental workflow.
**Input**: Optionally specify a change name after `/opsx:archive` (e.g., `/opsx:archive add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
**Steps**
1. **If no change name provided, prompt for selection**
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
Show only active changes (not already archived).
Include the schema used for each change if available.
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
2. **Check artifact completion status**
Run `openspec status --change "<name>" --json` to check artifact completion.
Parse the JSON to understand:
- `schemaName`: The workflow being used
- `artifacts`: List of artifacts with their status (`done` or other)
**If any artifacts are not `done`:**
- Display warning listing incomplete artifacts
- Prompt user for confirmation to continue
- Proceed if user confirms
3. **Check task completion status**
Read the tasks file (typically `tasks.md`) to check for incomplete tasks.
Count tasks marked with `- [ ]` (incomplete) vs `- [x]` (complete).
**If incomplete tasks found:**
- Display warning showing count of incomplete tasks
- Prompt user for confirmation to continue
- Proceed if user confirms
**If no tasks file exists:** Proceed without task-related warning.
4. **Assess delta spec sync state**
Check for delta specs at `openspec/changes/<name>/specs/`. If none exist, proceed without sync prompt.
**If delta specs exist:**
- Compare each delta spec with its corresponding main spec at `openspec/specs/<capability>/spec.md`
- Determine what changes would be applied (adds, modifications, removals, renames)
- Show a combined summary before prompting
**Prompt options:**
- If changes needed: "Sync now (recommended)", "Archive without syncing"
- If already synced: "Archive now", "Sync anyway", "Cancel"
If user chooses sync, use Task tool (subagent_type: "general-purpose", prompt: "Use Skill tool to invoke openspec-sync-specs for change '<name>'. Delta spec analysis: <include the analyzed delta spec summary>"). Proceed to archive regardless of choice.
5. **Perform the archive**
Create the archive directory if it doesn't exist:
```bash
mkdir -p openspec/changes/archive
```
Generate target name using current date: `YYYY-MM-DD-<change-name>`
**Check if target already exists:**
- If yes: Fail with error, suggest renaming existing archive or using different date
- If no: Move the change directory to archive
```bash
mv openspec/changes/<name> openspec/changes/archive/YYYY-MM-DD-<name>
```
6. **Display summary**
Show archive completion summary including:
- Change name
- Schema that was used
- Archive location
- Spec sync status (synced / sync skipped / no delta specs)
- Note about any warnings (incomplete artifacts/tasks)
**Output On Success**
```
## Archive Complete
**Change:** <change-name>
**Schema:** <schema-name>
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
**Specs:** ✓ Synced to main specs
All artifacts complete. All tasks complete.
```
**Output On Success (No Delta Specs)**
```
## Archive Complete
**Change:** <change-name>
**Schema:** <schema-name>
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
**Specs:** No delta specs
All artifacts complete. All tasks complete.
```
**Output On Success With Warnings**
```
## Archive Complete (with warnings)
**Change:** <change-name>
**Schema:** <schema-name>
**Archived to:** openspec/changes/archive/YYYY-MM-DD-<name>/
**Specs:** Sync skipped (user chose to skip)
**Warnings:**
- Archived with 2 incomplete artifacts
- Archived with 3 incomplete tasks
- Delta spec sync was skipped (user chose to skip)
Review the archive if this was not intentional.
```
**Output On Error (Archive Exists)**
```
## Archive Failed
**Change:** <change-name>
**Target:** openspec/changes/archive/YYYY-MM-DD-<name>/
Target archive directory already exists.
**Options:**
1. Rename the existing archive
2. Delete the existing archive if it's a duplicate
3. Wait until a different date to archive
```
**Guardrails**
- Always prompt for change selection if not provided
- Use artifact graph (openspec status --json) for completion checking
- Don't block archive on warnings - just inform and confirm
- Preserve .openspec.yaml when moving to archive (it moves with the directory)
- Show clear summary of what happened
- If sync is requested, use the Skill tool to invoke `openspec-sync-specs` (agent-driven)
- If delta specs exist, always run the sync assessment and show the combined summary before prompting

View File

@ -0,0 +1,173 @@
---
name: "OPSX: Explore"
description: "Enter explore mode - think through ideas, investigate problems, clarify requirements"
category: Workflow
tags: [workflow, explore, experimental, thinking]
---
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first and create a change proposal. You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
**Input**: The argument after `/opsx:explore` is whatever the user wants to think about. Could be:
- A vague idea: "real-time collaboration"
- A specific problem: "the auth system is getting unwieldy"
- A change name: "add-dark-mode" (to explore in context of that change)
- A comparison: "postgres vs sqlite for this"
- Nothing (just enter explore mode)
---
## The Stance
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
- **Adaptive** - Follow interesting threads, pivot when new information emerges
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
---
## What You Might Do
Depending on what the user brings, you might:
**Explore the problem space**
- Ask clarifying questions that emerge from what they said
- Challenge assumptions
- Reframe the problem
- Find analogies
**Investigate the codebase**
- Map existing architecture relevant to the discussion
- Find integration points
- Identify patterns already in use
- Surface hidden complexity
**Compare options**
- Brainstorm multiple approaches
- Build comparison tables
- Sketch tradeoffs
- Recommend a path (if asked)
**Visualize**
```
┌─────────────────────────────────────────┐
│ Use ASCII diagrams liberally │
├─────────────────────────────────────────┤
│ │
│ ┌────────┐ ┌────────┐ │
│ │ State │────────▶│ State │ │
│ │ A │ │ B │ │
│ └────────┘ └────────┘ │
│ │
│ System diagrams, state machines, │
│ data flows, architecture sketches, │
│ dependency graphs, comparison tables │
│ │
└─────────────────────────────────────────┘
```
**Surface risks and unknowns**
- Identify what could go wrong
- Find gaps in understanding
- Suggest spikes or investigations
---
## OpenSpec Awareness
You have full context of the OpenSpec system. Use it naturally, don't force it.
### Check for context
At the start, quickly check what exists:
```bash
openspec list --json
```
This tells you:
- If there are active changes
- Their names, schemas, and status
- What the user might be working on
If the user mentioned a specific change name, read its artifacts for context.
### When no change exists
Think freely. When insights crystallize, you might offer:
- "This feels solid enough to start a change. Want me to create a proposal?"
- Or keep exploring - no pressure to formalize
### When a change exists
If the user mentions a change or you detect one is relevant:
1. **Read existing artifacts for context**
- `openspec/changes/<name>/proposal.md`
- `openspec/changes/<name>/design.md`
- `openspec/changes/<name>/tasks.md`
- etc.
2. **Reference them naturally in conversation**
- "Your design mentions using Redis, but we just realized SQLite fits better..."
- "The proposal scopes this to premium users, but we're now thinking everyone..."
3. **Offer to capture when decisions are made**
| Insight Type | Where to Capture |
|--------------|------------------|
| New requirement discovered | `specs/<capability>/spec.md` |
| Requirement changed | `specs/<capability>/spec.md` |
| Design decision made | `design.md` |
| Scope changed | `proposal.md` |
| New work identified | `tasks.md` |
| Assumption invalidated | Relevant artifact |
Example offers:
- "That's a design decision. Capture it in design.md?"
- "This is a new requirement. Add it to specs?"
- "This changes scope. Update the proposal?"
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
---
## What You Don't Have To Do
- Follow a script
- Ask the same questions every time
- Produce a specific artifact
- Reach a conclusion
- Stay on topic if a tangent is valuable
- Be brief (this is thinking time)
---
## Ending Discovery
There's no required ending. Discovery might:
- **Flow into a proposal**: "Ready to start? I can create a change proposal."
- **Result in artifact updates**: "Updated design.md with these decisions"
- **Just provide clarity**: User has what they need, moves on
- **Continue later**: "We can pick this up anytime"
When things crystallize, you might offer a summary - but it's optional. Sometimes the thinking IS the value.
---
## Guardrails
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
- **Don't fake understanding** - If something is unclear, dig deeper
- **Don't rush** - Discovery is thinking time, not task time
- **Don't force structure** - Let patterns emerge naturally
- **Don't auto-capture** - Offer to save insights, don't just do it
- **Do visualize** - A good diagram is worth many paragraphs
- **Do explore the codebase** - Ground discussions in reality
- **Do question assumptions** - Including the user's and your own

View File

@ -0,0 +1,106 @@
---
name: "OPSX: Propose"
description: Propose a new change - create it and generate all artifacts in one step
category: Workflow
tags: [workflow, artifacts, experimental]
---
Propose a new change - create the change and generate all artifacts in one step.
I'll create a change with artifacts:
- proposal.md (what & why)
- design.md (how)
- tasks.md (implementation steps)
When ready to implement, run /opsx:apply
---
**Input**: The argument after `/opsx:propose` is the change name (kebab-case), OR a description of what the user wants to build.
**Steps**
1. **If no input provided, ask what they want to build**
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
> "What change do you want to work on? Describe what you want to build or fix."
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
2. **Create the change directory**
```bash
openspec new change "<name>"
```
This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
3. **Get the artifact build order**
```bash
openspec status --change "<name>" --json
```
Parse the JSON to get:
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
- `artifacts`: list of all artifacts with their status and dependencies
4. **Create artifacts in sequence until apply-ready**
Use the **TodoWrite tool** to track progress through the artifacts.
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
a. **For each artifact that is `ready` (dependencies satisfied)**:
- Get instructions:
```bash
openspec instructions <artifact-id> --change "<name>" --json
```
- The instructions JSON includes:
- `context`: Project background (constraints for you - do NOT include in output)
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
- `template`: The structure to use for your output file
- `instruction`: Schema-specific guidance for this artifact type
- `outputPath`: Where to write the artifact
- `dependencies`: Completed artifacts to read for context
- Read any completed dependency files for context
- Create the artifact file using `template` as the structure
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
- Show brief progress: "Created <artifact-id>"
b. **Continue until all `applyRequires` artifacts are complete**
- After creating each artifact, re-run `openspec status --change "<name>" --json`
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
- Stop when all `applyRequires` artifacts are done
c. **If an artifact requires user input** (unclear context):
- Use **AskUserQuestion tool** to clarify
- Then continue with creation
5. **Show final status**
```bash
openspec status --change "<name>"
```
**Output**
After completing all artifacts, summarize:
- Change name and location
- List of artifacts created with brief descriptions
- What's ready: "All artifacts created! Ready for implementation."
- Prompt: "Run `/opsx:apply` to start implementing."
**Artifact Creation Guidelines**
- Follow the `instruction` field from `openspec instructions` for each artifact type
- The schema defines what each artifact should contain - follow it
- Read dependency artifacts for context before creating new ones
- Use `template` as the structure for your output file - fill in its sections
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
- These guide what you write, but should never appear in the output
**Guardrails**
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
- Always read dependency artifacts before creating a new one
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
- If a change with that name already exists, ask if user wants to continue it or create a new one
- Verify each artifact file exists after writing before proceeding to next

View File

@ -0,0 +1,280 @@
---
name: gf-feedback
description: >-
Track, fix, verify, and test any bugs, improvements, or gaps reported against an OpenSpec change.
MUST use this skill whenever user reports problems, defects, issues, bugs, or gaps related to
existing implementations, even if they don't explicitly say "feedback" or mention OpenSpec.
compatibility: Requires openspec CLI, Go toolchain, and gf-review skill.
---
# Feedback: Structured Fix, Verification & Test Coverage Loop
When users discover bugs or improvement points after implementation, this skill captures those issues, organizes them into a traceable task list in `tasks.md`, systematically fixes and verifies each one, and ensures every behavior-changing fix is covered by focused unit tests.
**Core principles:**
1. **Spec is the source of truth** — Spec-level changes require spec update before task recording
2. **Write it down first, then fix it** — Every issue gets recorded before any code change
3. **Every fix deserves a test** — Behavior-changing code changes require unit test coverage in the affected package
---
## Workflow
### 1. Identify Target Change
**CRITICAL:**
1. Always append to existing active changes. Only create new change when none exist.
2. An **active change** is any change directory that still exists directly under `openspec/changes/` and has **not** been moved into `openspec/changes/archive/`. Do **not** treat `status: complete`, all tasks checked off, or similar completion signals as "inactive" until archive actually happens.
3. Regardless of whether the feedback content is related to the main functionality of the current active iteration, it MUST be appended to the current active iteration. This ensures all changes are tracked in a single change record for unified management and archiving.
```bash
openspec list --json
# Or: ls openspec/changes/ | grep -v archive
```
When the two signals disagree, prefer the filesystem rule:
- If a change directory still exists under `openspec/changes/` and is not inside `archive/`, it is active.
- `openspec list --json` may still report such a change as `status: complete`; that only means implementation tasks are done, **not** that the change is inactive.
- Only archived changes under `openspec/changes/archive/` are inactive.
| Active Changes | Action |
|----------------|--------|
| None | Create new change (see below) |
| One | Auto-select it, announce and proceed |
| Multiple | Ask user to select from list |
**When multiple active changes exist:**
```
Multiple active changes detected. Which change should this feedback be appended to?
1. config-management — System config CRUD management
2. user-auth — User authentication enhancement
Please select 1 or 2:
```
**When no active change exists:**
1. Derive kebab-case name from feedback (e.g., "fix-menu-circular-ref")
2. If name exists, append suffix ("-2")
3. Create: `openspec new change "<name>"`
4. Generate minimal `proposal.md` (one paragraph summarizing context)
5. Skip `design.md` for pure bug fixes unless architectural changes needed
Announce: "Applying feedback fixes to change: **<name>**"
---
### 2. Read Current Context
| File | Purpose |
|------|---------|
| `tasks.md` | Task structure, naming conventions, numbering |
| `design.md` | Architectural context |
| `proposal.md` | Feature scope and intent |
| `specs/` | Delta spec definitions |
```bash
# Locate existing unit tests in the impacted package before adding a new one
rg --files <pkg-dir> | rg '_test\\.go$'
```
---
### 3. Analyze and Organize Issues
For each reported issue:
**Classify by type:**
- **bug** — Incorrect behavior, code doesn't match spec
- **missing** — Feature incomplete, gaps in implementation
- **ux** — UX improvement, no spec change needed
- **test-gap** — Missing test coverage only
**Classify by spec impact:**
| Level | Definition | Action |
|-------|------------|--------|
| **implementation** | Spec is correct, code is wrong | Fix code only |
| **spec-level** | Requirement missing/incomplete/changed | Update spec first, then fix |
| **internal** | No user-observable change | Fix code, test optional |
**Group related issues** — Same root cause → single task with multiple verification points.
---
### 4. Update Delta Specs (for Spec-Level Issues Only)
For spec-level issues, update specs **before** recording tasks:
1. Identify affected capability: `specs/<capability>/spec.md`
2. Apply delta operation:
```markdown
<!-- ADDED: New requirement -->
### Requirement: Parent Selector Circular Prevention
The system SHALL disable the current menu and all its descendants in the parent selector
to prevent circular references.
#### Scenario: Edit menu with children
WHEN user edits a menu that has child menus
THEN the parent selector SHALL disable the current menu and all descendant menus
<!-- MODIFIED: Changed requirement (include full original block) -->
### Requirement: Import Error Handling
The system SHALL display error messages when import fails.
**MODIFIED:** Error messages SHALL include row number, field name, and validation failure reason.
<!-- REMOVED: Deprecated requirement -->
### Requirement: Legacy Import Format
The system SHALL support legacy CSV format.
**REMOVED:** This format is no longer supported.
**Migration:** Use the new CSV format with header row.
```
---
### 5. Write Task List to tasks.md
Append a **Feedback section** to `tasks.md`:
```markdown
## Feedback
- [ ] **FB-1**: Parent selector allows circular references in menu edit
- [ ] **FB-2**: Import error messages lack row and field details
- [ ] **FB-3**: No test coverage for reset password feature
```
**Numbering:** Sequential `FB-1`, `FB-2`, etc. Continue from last number if section exists.
**One line per task** — No sub-fields. Analysis happens during fix phase.
**Confirm with user** before writing to file.
**Test coverage planning (internal):**
- Behavior-changing code change → Unit test required
- Internal-only optimization → Unit test optional unless logic risk increased
- Prefer extending the nearest `*_z_unit*_test.go` or `*_test.go` in the same package
---
### 6. Execute Fixes (Loop)
For each task:
**a. Announce:** `## Fixing FB-X: <issue title>`
**b. Investigate** — Read source files, confirm root cause
**c. Implement** — Minimal, focused fix following existing patterns
**d. Write/update unit tests** — Prefer the affected package's existing `*_z_unit*_test.go` or `*_test.go` files and keep assertions focused on the changed logic
**e. Assess Impact Scope (MANDATORY)**
After implementing, identify regression risk:
| Change Type | Map To Tests |
|-------------|--------------|
| Package-level logic | Targeted test for changed function/method + package regression tests |
| Shared utility | Utility package unit tests + highest-value dependent package tests already covering reuse |
| DB/DAO logic | DAO/model package unit tests with focused fixtures, mocks, or test helpers |
| Public API validation | Handler/service package unit tests that assert the changed validation path |
| Refactor without behavior change | Existing package tests that prove behavior parity |
```bash
# Example: Find unit tests related to a changed symbol or package
rg -l "GenDao|gdao" . -g '*_test.go'
```
Announce:
```
### Impact Analysis for FB-X
- Modified: cmd/gf/internal/cmd/gendao/gendao.go
- Affected package: cmd/gf/internal/cmd/gendao
- Unit tests: cmd/gf/internal/cmd/gendao/gendao_test.go
- Regression command: go test ./cmd/gf/internal/cmd/gendao -run 'TestGenDao'
```
**f. Verify (MANDATORY before marking complete)**
1. Run new/updated unit tests for this task → **must pass**
2. Run ALL identified package-level regression tests → **must pass**
3. Only then: mark task `[x]` in tasks.md
If regression fails:
- Fix inline if related to current change
- Add as new FB task if separate issue
**g. Run review** — Invoke `gf-review` skill after completion
---
### 7. Comprehensive Verification
After all fixes:
1. Aggregate regression tests from all tasks
2. Run full set in single pass
3. Report:
```
### Comprehensive Verification Results
- Total tests: N
- Passed: N
- Failed: N (list with details)
- Regression tests: all passed ✓ / X failures
```
If failures → add new FB tasks, loop to Step 6.
---
### 8. Report Completion
```markdown
## Feedback Complete
**Change:** <name>
**Issues reported:** X
**Issues fixed:** Y/X
**Tests added:** Z unit tests / focused assertions
**Regression tests run:** R tests across N packages
**Verification:** all passed / N issues remaining
### Fixed This Session
- [x] FB-1: <title> ✓ (unit test: TestGenDao_FiltersInvalidTables | package: ./cmd/gf/internal/cmd/gendao ✓)
- [x] FB-2: <title> ✓ (unit test: existing package coverage extended | package: ./cmd/gf/internal/cmd ✓)
### Remaining (if any)
- [ ] FB-3: <title> — blocked by <reason>
```
---
## Edge Cases
| Situation | Handling |
|-----------|----------|
| Single issue | Still follow full workflow |
| Missing test cases only | Classify as test-gap, implement tests |
| Fix reveals more issues | Add as new FB tasks |
| "Bug" is actually feature request | Re-classify as spec-level, update specs first |
| Unit test not feasible (docs/spec only) | Note reason explicitly and skip only when no runtime code changes exist |
| Multiple feedback rounds | All tasks in single Feedback section, sequential numbering |
---
## Guardrails
- **Append to active change if exists** — Never create new change when active ones exist
- **Specs before tasks for spec-level issues** — Update delta specs first
- **Write tasks before fixing** — Never code without recording
- **Confirm task list with user** — User validates analysis
- **Minimal fixes** — No refactoring beyond issue scope
- **Behavior-changing fix needs unit test** — No exceptions unless the change is docs/spec only
- **No green check without green unit tests** — Mark `[x]` only after tests pass
- **Impact analysis mandatory** — Every fix requires package-level regression test identification
- **Regression failures block completion** — Must resolve before marking done
- **Update tasks.md in real time** — Mark complete immediately after verification
- **Match file language** — Use same language as existing content in target file

View File

@ -0,0 +1,168 @@
---
name: gf-review
description: >-
Code and specification review for OpenSpec workflow. Triggers automatically after /opsx:apply
task completion, after /gf-feedback task completion, and before /opsx:archive. Use when
user requests code review, spec compliance check, or when explicitly invoked via /gf-review.
compatibility: Requires OpenSpec CLI and GoFrame v2 skill.
---
# GF Review
Structured code and specification review for the OpenSpec development workflow.
**Spec Source**: `CLAUDE.md` is the single source of truth for all review criteria.
---
## When This Skill Activates
**Automatic triggers:**
- After completing each task in `/opsx:apply`
- After completing each task in `/gf-feedback`
- Before executing `/opsx:archive`
**Manual trigger:**
- User explicitly requests: "review this code", "check spec compliance", "/gf-review"
---
## Review Workflow
### 1. Identify Scope
Determine what needs to be reviewed:
1. **After task completion** — Review files modified/created by the completed task
2. **Before archive** — Review all changes in the current OpenSpec change
3. **Manual invocation** — Ask user to specify scope or use current change
**Mandatory scope collection rules:**
1. Start with repository status, not `git diff` alone:
```bash
git status --short
git ls-files --others --exclude-standard
```
2. Treat **all tracked and untracked changes** as review candidates, including:
- staged files
- unstaged files
- untracked files shown as `??`
- untracked directories shown as `?? path/`
3. When `git status --short` reports an untracked directory, expand it to concrete files before review:
```bash
find <path> -type f
# Or prefer:
rg --files <path>
```
4. If the task ran generators such as `make ctrl`, `make dao`, codegen scripts, or produced new test files, explicitly include the generated untracked files in review scope even if they do not appear in `git diff`.
5. `git diff` may be used only as a secondary narrowing aid after status collection. It is **never sufficient by itself** for review scope definition.
Run `openspec status --change "<name>" --json` to understand the current change state.
### 2. Load Specifications
Read `CLAUDE.md` to load all specifications. This is the single source of truth.
### 3. Backend Code Review
**Trigger**: Changes to files under `apps/lina-core` directory
1. Invoke `goframe-v2` skill for GoFrame framework conventions
2. Check against `CLAUDE.md` backend code specifications
### 4. RESTful API Review
**Trigger**: Any API endpoint changes
Check against `CLAUDE.md` API design specifications.
### 5. Project Specification Review
**Trigger**: Any implementation changes
Check against `CLAUDE.md` architecture design specifications and code development specifications.
### 6. SQL Review
**Trigger**: New or modified files under `apps/lina-core/manifest/sql/`、`apps/lina-core/manifest/sql/mock-data/`、`apps/lina-plugins/**/manifest/sql/` or SQL snippets embedded in related delivery docs
Check against `CLAUDE.md` SQL file management specifications, at minimum covering:
1. File naming, versioning, and single-iteration single-file rules
2. Seed DML vs mock data separation
3. **Idempotent execution safety** — SQL must be safe to run multiple times without duplicate-object errors or duplicate seed data; verify use of `IF [NOT] EXISTS`, `IF EXISTS`, `INSERT IGNORE`, or equivalent safe re-entry patterns
4. **Seed write style compliance** — delivered SQL must reject `INSERT ... ON DUPLICATE KEY UPDATE` and reject explicit writes to `AUTO_INCREMENT` `id` columns in seed/mock/install data
5. Whether schema/data changes still match the current change scope and deployment path
### 7. Unit Test Review
**Trigger**: New or modified Go implementation files, or new/modified Go unit test files matching `*_test.go`
Check at minimum:
1. Behavior-changing Go code includes focused unit coverage in the same package, preferably by extending existing `*_z_unit*_test.go` or `*_test.go`
2. Tests assert the changed logic directly instead of relying on broad workflow-level coverage when a package-level test is sufficient
3. Verification uses targeted `go test ./path/to/pkg -run TestName` during development and package-level `go test ./path/to/pkg` for regression
### 8. Generate Review Report
```markdown
## GF Review Report
**Change:** <change-name>
**Scope:** <task-specific / full change>
**Files Reviewed:** <count>
**Scope Source:** `git status --short` + `git ls-files --others --exclude-standard` + task/change context
### Backend Code Review
✓ All checks passed / ⚠ N issues found
### RESTful API Review
✓ All endpoints compliant / ⚠ N violations found
### Project Spec Review
✓ Compliant with CLAUDE.md / ⚠ N violations found
### SQL Review
✓ No SQL changes / ✓ SQL changes compliant / ⚠ N SQL issues found
### Unit Test Review
✓ Unit tests are focused and sufficient / ⚠ N issues found
### Summary
- **Critical:** N (must fix before archive)
- **Warnings:** N (recommended to fix)
### Recommended Actions
1. [Specific action with CLAUDE.md reference]
```
---
## Issue Severity
| Level | Behavior |
|-------|----------|
| **Critical** | Block archive, must fix |
| **Warning** | Show but allow proceed |
---
## Integration Points
| Workflow Step | Behavior |
|---------------|----------|
| `/opsx:apply` task done | Review, offer to fix issues before next task |
| `/gf-feedback` task done | Review, fix before marking complete |
| `/opsx:archive` | Review all changes, block on critical issues |
---
## Guardrails
- **CLAUDE.md is the single source of truth** — All spec references point to it
- Only check categories relevant to changed files
- Scope identification MUST include untracked files and expanded untracked directories; never rely on `git diff` alone
- Behavior-changing Go code without focused unit tests is a review finding unless the author documents why tests are not applicable
- Don't block on warnings — only critical issues block archive
- Include file paths and line numbers in issue reports
- Offer to fix issues automatically when straightforward

View File

@ -0,0 +1,148 @@
---
name: git-commit-push
description: Review the current git working tree, generate a commit message from the actual diff using the repository's commit or PR-title convention, commit all current changes on the active branch, and push that branch to `origin`. Use this whenever the user asks to "commit", "push", "commit and push", "generate a commit message", "commit the current changes", or wants the current branch changes sent upstream without hand-writing the git commands.
---
# Git Commit Push
Inspect the current repository changes, derive a concise commit subject that matches the repository convention, commit every current modification on the active branch, and push that branch to `origin`.
This skill is for execution, not just advice. When it triggers, actually run the git workflow unless the repository state makes that unsafe or impossible.
## When To Use
- The user asks you to commit the current changes, with or without asking for push
- The user wants you to write the commit message from the diff instead of inventing one up front
- The user mentions the repo's PR or commit naming convention and wants you to follow it
- The user says things like "commit the current branch", "help me commit", "commit and push", "generate a commit message and push", or "send these changes to origin"
## Core Behavior
1. Confirm you are inside a Git repository and detect the active branch with `git branch --show-current`.
2. Inspect the working tree before committing:
- `git status --short --branch`
- `git diff --stat`
- `git diff --cached --stat`
- `git diff -- . ':(exclude)package-lock.json'` or narrower path filters only when needed for readability
3. If the repository contains `.github/PULL_REQUEST_TEMPLATE.MD`, read it and treat its PR-title rules as the default commit-subject convention.
4. Generate a commit subject from the actual changed files and diff content, not from the user prompt alone.
5. Stage every current modification on the branch with `git add -A`.
6. Commit once with the generated message.
7. Push the current branch to `origin` with `git push origin <current-branch>`.
## Commit Message Rules
The commit message is formatted as follows: `<type>[optional scope]: <description>` For example, `fix(os/gtime): fix time zone issue`
+ `<type>` is mandatory and can be one of `fix`, `feat`, `build`, `ci`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`
+ `fix`: Used when a bug has been fixed.
+ `feat`: Used when a new feature has been added.
+ `build`: Used for modifications to the project build system, such as changes to dependencies, external interfaces, or upgrading Node version.
+ `ci`: Used for modifications to continuous integration processes, such as changes to Travis, Jenkins workflow configurations.
+ `docs`: Used for modifications to documentation, such as changes to README files, API documentation, etc.
+ `style`: Used for changes to code style, such as adjustments to indentation, spaces, blank lines, etc.
+ `refactor`: Used for code refactoring, such as changes to code structure, variable names, function names, without altering functionality.
+ `perf`: Used for performance optimization, such as improving code performance, reducing memory usage, etc.
+ `test`: Used for modifications to test cases, such as adding, deleting, or modifying test cases for code.
+ `chore`: Used for modifications to non-business-related code, such as changes to build processes or tool configurations.
+ After `<type>`, specify the affected package name or scope in parentheses, for example, `(os/gtime)`.
+ The part after the colon uses the verb tense + phrase that completes the blank in
+ Lowercase verb after the colon
+ No trailing period
+ Keep the title as short as possible. ideally under 76 characters or shorter
+ If there is a corresponding issue, add either `fixes #1234` (the latter if this is not a complete fix) to this comment
### Examples
#### Commit message with description and breaking change footer
```
feat: allow provided config object to extend other configs
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
```
#### Commit message with ! to draw attention to breaking change
```
feat!: send an email to the customer when a product is shipped
```
#### Commit message with scope and ! to draw attention to breaking change
```
feat(api)!: send an email to the customer when a product is shipped
```
#### Commit message with both ! and BREAKING CHANGE footer
```
feat!: drop support for Node 6
BREAKING CHANGE: use JavaScript features not available in Node 6.
```
#### Commit message with no body
```
docs: correct spelling of CHANGELOG
```
#### Commit message with scope
```
feat(lang): add Polish language
```
#### Commit message with multi-paragraph body and multiple footers
```
fix: prevent racing of requests
Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.
Remove timeouts which were used to mitigate the racing issue but are
obsolete now.
Reviewed-by: Z
Refs: #123
```
## Execution Rules
- Commit all current tracked and untracked changes in the working tree, because this skill is for "commit the current state" requests
- If there are no changes, say so clearly and stop before commit or push
- If `git branch --show-current` is empty, explain that `HEAD` is detached and stop unless the user explicitly asks you to commit from detached `HEAD`
- Never use `--force`, `--force-with-lease`, or history-rewriting commands unless the user explicitly asks
- If push fails because the remote branch moved, report the exact failure and stop instead of auto-rebasing or auto-merging
- Do not silently drop files from the commit unless the user asked to exclude them
## Suggested Command Flow
```bash
git status --short --branch
git diff --stat
git diff --cached --stat
test -f .github/PULL_REQUEST_TEMPLATE.MD && sed -n '1,220p' .github/PULL_REQUEST_TEMPLATE.MD
branch_name=$(git branch --show-current)
git add -A
git commit -m "<generated-subject>"
git push origin "$branch_name"
```
Inspect `git diff --cached` again after staging if the pre-stage diff was noisy or if untracked files materially change the scope.
## Output Contract
When you use this skill:
- Tell the user which branch you committed
- Provide the final commit subject you used
- Mention that you staged all current changes
- Report the push target as `origin/<branch>`
- If commit or push did not happen, explain exactly why
## Example
User request:
```text
Generate a commit message that follows this repository's convention, then commit and push the current branch
```
Expected behavior:
- Inspect the repo status and diff
- Generate a conventional subject from the real changes
- Run one commit for the whole current working tree
- Push the active branch to `origin`

View File

@ -0,0 +1,142 @@
---
name: git-worktree
description: Create and actively use an isolated git worktree for the user's task, then continue the task inside that new directory. Use this whenever the user asks for a separate worktree, isolated checkout, clean branch directory, safer parallel changes, or a fresh workspace to avoid unrelated local edits.
---
# Git Worktree
Create a dedicated `git worktree` for the current task, then keep working inside that new directory instead of the original checkout.
This skill is about execution, not just advice. When it triggers, actually create the worktree unless the repository state makes that impossible.
Do not introduce helper scripts for this skill. Use direct `git` and shell commands inline.
## When To Use
- The user explicitly asks for a new `git worktree`, independent branch directory, or isolated workspace
- The current checkout contains unrelated local changes and isolation is the safest way forward
- The user wants parallel work on multiple tasks without stashing or disturbing the original worktree
- The user says things like "create a separate branch folder", "open a fresh worktree", "use a clean checkout", or "work in an isolated workspace"
## Core Rule
After creating the worktree, treat the new path as the active working directory for the rest of the task.
In any agent environment, "enter the directory" means:
- Run subsequent commands against the new worktree path
- Apply all edits under that worktree path
- Do not keep using the original checkout by accident
- Confirm the handoff by running at least one follow-up command in the new worktree
Never claim you "switched" unless your subsequent actions actually target the new `worktree_path`.
If your environment supports a per-command working directory, use it for every later command. If it does not, prefix later commands with an explicit `cd <worktree_path> && ...`.
## Name Derivation
- Derive a short ASCII kebab-case task slug from the user's real task, such as `login-timeout-fix` or `user-export`
- Do not use generic names like `git-worktree`, `new-worktree`, or `task` unless the request is too vague
- If the request is mostly non-ASCII or no good slug is obvious, fall back to `task-$(date +%Y%m%d-%H%M%S)`
- Default branch prefix is `worktree/`
- Default worktree directory is a sibling of the repository root, named `<repo-name>-<slug>`
## Default Workflow
1. Inspect the repository context from the current checkout:
- `git rev-parse --show-toplevel`
- `git branch --show-current`
- `git status --short`
- `git worktree list --porcelain`
2. Decide a task slug yourself using the rules above
3. Build branch and path names inline, then create the worktree with direct shell commands like:
```bash
repo_root=$(git rev-parse --show-toplevel)
repo_name=$(basename "$repo_root")
parent_dir=$(dirname "$repo_root")
source_branch=$(git -C "$repo_root" branch --show-current)
if [ -n "$source_branch" ]; then
source_ref="$source_branch"
else
source_ref="HEAD@$(git -C "$repo_root" rev-parse --short HEAD)"
fi
slug="<task-slug>"
base_branch="worktree/$slug"
branch_name="$base_branch"
base_path="$parent_dir/$repo_name-$slug"
worktree_path="$base_path"
index=2
while git -C "$repo_root" show-ref --verify --quiet "refs/heads/$branch_name" || [ -e "$worktree_path" ]; do
branch_name="${base_branch}-$index"
worktree_path="${base_path}-$index"
index=$((index + 1))
done
git -C "$repo_root" worktree add -b "$branch_name" "$worktree_path" HEAD
```
4. Immediately verify the handoff inside the new worktree, for example:
```bash
pwd
git status --short --branch
```
These verification commands must run against `worktree_path`.
5. Announce the new active path briefly, then continue the main task there
6. For the remainder of the task, use `worktree_path` as the working directory for every relevant command or edit operation
## Behavior Rules
- Default base ref is `HEAD` from the current checkout so uncommitted local changes are not dragged into the new worktree
- If a branch name or path already exists, auto-increment it instead of failing
- If you are already inside a non-default worktree and the user still wants another isolated workspace, create a new one from the current `HEAD`
- If the directory is not a Git repository, explain that clearly and do not pretend a worktree was created
- If worktree creation succeeds, continue the user's actual task instead of stopping at setup
- If worktree creation fails because of filesystem permissions, request the minimal approval needed and retry
## Uncommitted Change Policy
The safe default is isolation from uncommitted changes.
- If the source checkout is dirty, still create the new worktree from `HEAD` unless the user explicitly asks to carry local edits over
- Do not silently stash, reset, or move the user's existing changes
- If the user wants local edits copied into the new worktree, use an explicit flow such as a temporary commit, patch, or cherry-pick, and say what you are doing
## Output Contract
When you use this skill:
- Tell the user which branch and directory were created
- Make it clear that subsequent work is now happening inside that path
- Mention the source ref and whether the original checkout was dirty when that context matters
- Do not stop after setup if the user asked for additional work; continue the task in the new worktree
## Example
User request:
```text
Create a separate worktree for this task and then start implementing it.
```
Expected behavior:
- Inspect current repo status
- Create a new `worktree/...` branch and sibling directory with direct `git worktree` commands
- Switch all following commands to that directory
- Continue the requested implementation there
## Cleanup
Only remove a worktree when the user asks or when cleanup is clearly part of the task.
Before cleanup:
- Check status in the worktree you created
- Make sure you are removing the correct path
- Never remove the user's original checkout

View File

@ -0,0 +1,288 @@
---
name: openspec-explore
description: Enter explore mode - a thinking partner for exploring ideas, investigating problems, and clarifying requirements. Use when the user wants to think through something before or during a change.
license: MIT
compatibility: Requires openspec CLI.
metadata:
author: openspec
version: "1.0"
generatedBy: "1.2.0"
---
Enter explore mode. Think deeply. Visualize freely. Follow the conversation wherever it goes.
**IMPORTANT: Explore mode is for thinking, not implementing.** You may read files, search code, and investigate the codebase, but you must NEVER write code or implement features. If the user asks you to implement something, remind them to exit explore mode first and create a change proposal. You MAY create OpenSpec artifacts (proposals, designs, specs) if the user asks—that's capturing thinking, not implementing.
**This is a stance, not a workflow.** There are no fixed steps, no required sequence, no mandatory outputs. You're a thinking partner helping the user explore.
---
## The Stance
- **Curious, not prescriptive** - Ask questions that emerge naturally, don't follow a script
- **Open threads, not interrogations** - Surface multiple interesting directions and let the user follow what resonates. Don't funnel them through a single path of questions.
- **Visual** - Use ASCII diagrams liberally when they'd help clarify thinking
- **Adaptive** - Follow interesting threads, pivot when new information emerges
- **Patient** - Don't rush to conclusions, let the shape of the problem emerge
- **Grounded** - Explore the actual codebase when relevant, don't just theorize
---
## What You Might Do
Depending on what the user brings, you might:
**Explore the problem space**
- Ask clarifying questions that emerge from what they said
- Challenge assumptions
- Reframe the problem
- Find analogies
**Investigate the codebase**
- Map existing architecture relevant to the discussion
- Find integration points
- Identify patterns already in use
- Surface hidden complexity
**Compare options**
- Brainstorm multiple approaches
- Build comparison tables
- Sketch tradeoffs
- Recommend a path (if asked)
**Visualize**
```
┌─────────────────────────────────────────┐
│ Use ASCII diagrams liberally │
├─────────────────────────────────────────┤
│ │
│ ┌────────┐ ┌────────┐ │
│ │ State │────────▶│ State │ │
│ │ A │ │ B │ │
│ └────────┘ └────────┘ │
│ │
│ System diagrams, state machines, │
│ data flows, architecture sketches, │
│ dependency graphs, comparison tables │
│ │
└─────────────────────────────────────────┘
```
**Surface risks and unknowns**
- Identify what could go wrong
- Find gaps in understanding
- Suggest spikes or investigations
---
## OpenSpec Awareness
You have full context of the OpenSpec system. Use it naturally, don't force it.
### Check for context
At the start, quickly check what exists:
```bash
openspec list --json
```
This tells you:
- If there are active changes
- Their names, schemas, and status
- What the user might be working on
### When no change exists
Think freely. When insights crystallize, you might offer:
- "This feels solid enough to start a change. Want me to create a proposal?"
- Or keep exploring - no pressure to formalize
### When a change exists
If the user mentions a change or you detect one is relevant:
1. **Read existing artifacts for context**
- `openspec/changes/<name>/proposal.md`
- `openspec/changes/<name>/design.md`
- `openspec/changes/<name>/tasks.md`
- etc.
2. **Reference them naturally in conversation**
- "Your design mentions using Redis, but we just realized SQLite fits better..."
- "The proposal scopes this to premium users, but we're now thinking everyone..."
3. **Offer to capture when decisions are made**
| Insight Type | Where to Capture |
|--------------|------------------|
| New requirement discovered | `specs/<capability>/spec.md` |
| Requirement changed | `specs/<capability>/spec.md` |
| Design decision made | `design.md` |
| Scope changed | `proposal.md` |
| New work identified | `tasks.md` |
| Assumption invalidated | Relevant artifact |
Example offers:
- "That's a design decision. Capture it in design.md?"
- "This is a new requirement. Add it to specs?"
- "This changes scope. Update the proposal?"
4. **The user decides** - Offer and move on. Don't pressure. Don't auto-capture.
---
## What You Don't Have To Do
- Follow a script
- Ask the same questions every time
- Produce a specific artifact
- Reach a conclusion
- Stay on topic if a tangent is valuable
- Be brief (this is thinking time)
---
## Handling Different Entry Points
**User brings a vague idea:**
```
User: I'm thinking about adding real-time collaboration
You: Real-time collab is a big space. Let me think about this...
COLLABORATION SPECTRUM
════════════════════════════════════════════
Awareness Coordination Sync
│ │ │
▼ ▼ ▼
┌────────┐ ┌────────┐ ┌────────┐
│Presence│ │Cursors │ │ CRDT │
│ "3 │ │ Multi │ │Conflict│
│online" │ │ select │ │ free │
└────────┘ └────────┘ └────────┘
│ │ │
trivial moderate complex
Where's your head at?
```
**User brings a specific problem:**
```
User: The auth system is a mess
You: [reads codebase]
┌─────────────────────────────────────────────┐
│ CURRENT AUTH FLOW │
└─────────────────────────────────────────────┘
┌─────────────┼─────────────┐
▼ ▼ ▼
┌─────────┐ ┌─────────┐ ┌─────────┐
│ Google │ │ GitHub │ │ Email │
│ OAuth │ │ OAuth │ │ Magic │
└────┬────┘ └────┬────┘ └────┬────┘
│ │ │
└─────────────┼─────────────┘
┌───────────┐
│ Session │
└─────┬─────┘
┌───────────┐
│ Perms │
└───────────┘
I see three tangles. Which one's burning?
```
**User is stuck mid-implementation:**
```
User: /opsx:explore add-auth-system
The OAuth integration is more complex than expected
You: [reads change artifacts]
You're on task 4: "Implement OAuth flow"
Let me trace what's involved...
[draws diagram, explores options, suggests paths]
Want to update the design to reflect this?
Or add a spike task to investigate?
```
**User wants to compare options:**
```
User: Should we use Postgres or SQLite?
You: Generic answer is boring. What's the context?
User: A CLI tool that tracks local dev environments
You: That changes everything.
┌─────────────────────────────────────────────────┐
│ CLI TOOL DATA STORAGE │
└─────────────────────────────────────────────────┘
Key constraints:
• No daemon running
• Must work offline
• Single user
SQLite Postgres
Deployment embedded ✓ needs server ✗
Offline yes ✓ no ✗
Single file yes ✓ no ✗
SQLite. Not even close.
Unless... is there a sync component?
```
---
## Ending Discovery
There's no required ending. Discovery might:
- **Flow into a proposal**: "Ready to start? I can create a change proposal."
- **Result in artifact updates**: "Updated design.md with these decisions"
- **Just provide clarity**: User has what they need, moves on
- **Continue later**: "We can pick this up anytime"
When it feels like things are crystallizing, you might summarize:
```
## What We Figured Out
**The problem**: [crystallized understanding]
**The approach**: [if one emerged]
**Open questions**: [if any remain]
**Next steps** (if ready):
- Create a change proposal
- Keep exploring: just keep talking
```
But this summary is optional. Sometimes the thinking IS the value.
---
## Guardrails
- **Don't implement** - Never write code or implement features. Creating OpenSpec artifacts is fine, writing application code is not.
- **Don't fake understanding** - If something is unclear, dig deeper
- **Don't rush** - Discovery is thinking time, not task time
- **Don't force structure** - Let patterns emerge naturally
- **Don't auto-capture** - Offer to save insights, don't just do it
- **Do visualize** - A good diagram is worth many paragraphs
- **Do explore the codebase** - Ground discussions in reality
- **Do question assumptions** - Including the user's and your own

View File

@ -0,0 +1,110 @@
---
name: openspec-propose
description: Propose a new change with all artifacts generated in one step. Use when the user wants to quickly describe what they want to build and get a complete proposal with design, specs, and tasks ready for implementation.
license: MIT
compatibility: Requires openspec CLI.
metadata:
author: openspec
version: "1.0"
generatedBy: "1.2.0"
---
Propose a new change - create the change and generate all artifacts in one step.
I'll create a change with artifacts:
- proposal.md (what & why)
- design.md (how)
- tasks.md (implementation steps)
When ready to implement, run /opsx:apply
---
**Input**: The user's request should include a change name (kebab-case) OR a description of what they want to build.
**Steps**
1. **If no clear input provided, ask what they want to build**
Use the **AskUserQuestion tool** (open-ended, no preset options) to ask:
> "What change do you want to work on? Describe what you want to build or fix."
From their description, derive a kebab-case name (e.g., "add user authentication" → `add-user-auth`).
**IMPORTANT**: Do NOT proceed without understanding what the user wants to build.
2. **Create the change directory**
```bash
openspec new change "<name>"
```
This creates a scaffolded change at `openspec/changes/<name>/` with `.openspec.yaml`.
3. **Get the artifact build order**
```bash
openspec status --change "<name>" --json
```
Parse the JSON to get:
- `applyRequires`: array of artifact IDs needed before implementation (e.g., `["tasks"]`)
- `artifacts`: list of all artifacts with their status and dependencies
4. **Create artifacts in sequence until apply-ready**
Use the **TodoWrite tool** to track progress through the artifacts.
Loop through artifacts in dependency order (artifacts with no pending dependencies first):
a. **For each artifact that is `ready` (dependencies satisfied)**:
- Get instructions:
```bash
openspec instructions <artifact-id> --change "<name>" --json
```
- The instructions JSON includes:
- `context`: Project background (constraints for you - do NOT include in output)
- `rules`: Artifact-specific rules (constraints for you - do NOT include in output)
- `template`: The structure to use for your output file
- `instruction`: Schema-specific guidance for this artifact type
- `outputPath`: Where to write the artifact
- `dependencies`: Completed artifacts to read for context
- Read any completed dependency files for context
- Create the artifact file using `template` as the structure
- Apply `context` and `rules` as constraints - but do NOT copy them into the file
- Show brief progress: "Created <artifact-id>"
b. **Continue until all `applyRequires` artifacts are complete**
- After creating each artifact, re-run `openspec status --change "<name>" --json`
- Check if every artifact ID in `applyRequires` has `status: "done"` in the artifacts array
- Stop when all `applyRequires` artifacts are done
c. **If an artifact requires user input** (unclear context):
- Use **AskUserQuestion tool** to clarify
- Then continue with creation
5. **Show final status**
```bash
openspec status --change "<name>"
```
**Output**
After completing all artifacts, summarize:
- Change name and location
- List of artifacts created with brief descriptions
- What's ready: "All artifacts created! Ready for implementation."
- Prompt: "Run `/opsx:apply` or ask me to implement to start working on the tasks."
**Artifact Creation Guidelines**
- Follow the `instruction` field from `openspec instructions` for each artifact type
- The schema defines what each artifact should contain - follow it
- Read dependency artifacts for context before creating new ones
- Use `template` as the structure for your output file - fill in its sections
- **IMPORTANT**: `context` and `rules` are constraints for YOU, not content for the file
- Do NOT copy `<context>`, `<rules>`, `<project_context>` blocks into the artifact
- These guide what you write, but should never appear in the output
**Guardrails**
- Create ALL artifacts needed for implementation (as defined by schema's `apply.requires`)
- Always read dependency artifacts before creating a new one
- If context is critically unclear, ask the user - but prefer making reasonable decisions to keep momentum
- If a change with that name already exists, ask if user wants to continue it or create a new one
- Verify each artifact file exists after writing before proceeding to next

1
.claude/commands Symbolic link
View File

@ -0,0 +1 @@
../.agents/prompts

1
.claude/skills Symbolic link
View File

@ -0,0 +1 @@
../.agents/skills

5
.codex/config.toml Normal file
View File

@ -0,0 +1,5 @@
approval_policy = "never"
sandbox_mode = "danger-full-access"
[sandbox_workspace_write]
network_access = true

View File

@ -1,7 +1,6 @@
version: "2"
run:
concurrency: 4
go: "1.25"
modules-download-mode: readonly
issues-exit-code: 2
tests: false

View File

@ -1,5 +1,16 @@
#!/usr/bin/env bash
# Function to run sed in-place with OS-specific options
sed_replace() {
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS - requires empty string after -i
sed -i '' "$@"
else
# Linux/Windows Git Bash
sed -i "$@"
fi
}
workdir=.
echo "Prepare to tidy all go.mod files in the ${workdir} directory"
@ -27,9 +38,9 @@ for file in `find ${workdir} -name go.mod`; do
cd $goModPath
# Remove indirect dependencies
sed -i '/\/\/ indirect/d' go.mod
sed_replace '/\/\/ indirect/d' go.mod
go mod tidy
# Remove toolchain line if exists
sed -i '' '/^toolchain/d' go.mod
sed_replace '/^toolchain/d' go.mod
cd - > /dev/null
done

View File

@ -1,19 +1,16 @@
#!/usr/bin/env bash
# Function to detect OS and set sed parameters
setup_sed() {
# Function to run sed in-place with OS-specific options
sed_replace() {
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS
SED_INPLACE="sed -i ''"
# macOS - requires empty string after -i
sed -i '' "$@"
else
# Linux/Windows Git Bash
SED_INPLACE="sed -i"
sed -i "$@"
fi
}
# Initialize sed command
setup_sed
if [ $# -ne 2 ]; then
echo "Parameter exception, please execute in the format of $0 [directory] [version number]"
echo "PS$0 ./ v2.4.0"
@ -43,10 +40,11 @@ fi
if [[ true ]]; then
# Use sed to replace the version number in version.go
$SED_INPLACE 's/VERSION = ".*"/VERSION = "'${newVersion}'"/' version.go
sed_replace 's/VERSION = ".*"/VERSION = "'${newVersion}'"/' version.go
# Use sed to replace the version number in README.MD
$SED_INPLACE 's/version=[^"]*/version='${newVersion}'/' README.MD
sed_replace 's/version=[^"]*/version='${newVersion}'/' README.MD
sed_replace 's/version=[^"]*/version='${newVersion}'/' README.zh_CN.MD
fi
if [ -f "go.work" ]; then
@ -70,6 +68,8 @@ for file in `find ${workdir} -name go.mod`; do
fi
cd $goModPath
# Add replace directive for local development.
if [ $goModPath = "./cmd/gf" ]; then
mv go.work go.work.version.bak
go mod edit -replace github.com/gogf/gf/v2=../../
@ -81,20 +81,20 @@ for file in `find ${workdir} -name go.mod`; do
go mod edit -replace github.com/gogf/gf/contrib/drivers/sqlite/v2=../../contrib/drivers/sqlite
fi
# Remove indirect dependencies
sed -i '/\/\/ indirect/d' go.mod
sed_replace '/\/\/ indirect/d' go.mod
go mod tidy
# Remove toolchain line if exists
$SED_INPLACE '/^toolchain/d' go.mod
sed_replace '/^toolchain/d' go.mod
# Upgrading only GoFrame related libraries, sometimes even if a version number is specified,
# Upgrading only GoFrame related libraries, sometimes even if a version number is specified,
# it may not be possible to successfully upgrade. Please confirm before submitting the code
go list -f "{{if and (not .Indirect) (not .Main)}}{{.Path}}@${newVersion}{{end}}" -m all | grep "^github.com/gogf/gf"
go list -f "{{if and (not .Indirect) (not .Main)}}{{.Path}}@${newVersion}{{end}}" -m all | grep "^github.com/gogf/gf" | xargs -L1 go get -v
go list -f "{{if and (not .Indirect) (not .Main)}}{{.Path}}@${newVersion}{{end}}" -m all | grep "^github.com/gogf/gf" | xargs -L1 go get -v
# Remove indirect dependencies
sed -i '/\/\/ indirect/d' go.mod
sed_replace '/\/\/ indirect/d' go.mod
go mod tidy
# Remove toolchain line if exists
$SED_INPLACE '/^toolchain/d' go.mod
sed_replace '/^toolchain/d' go.mod
if [ $goModPath = "./cmd/gf" ]; then
go mod edit -dropreplace github.com/gogf/gf/v2
go mod edit -dropreplace github.com/gogf/gf/contrib/drivers/clickhouse/v2

1
AGENTS.md Symbolic link
View File

@ -0,0 +1 @@
CLAUDE.md

211
CLAUDE.md Normal file
View File

@ -0,0 +1,211 @@
# Repository Overview
This is the [GoFrame](https://goframe.org) framework (`github.com/gogf/gf/v2`) — a modular Go application framework. The repository is a **multi-module monorepo**: the root module hosts the core framework, while `cmd/gf` and every directory under `contrib/` are independent Go modules with their own `go.mod`.
- Root module: `github.com/gogf/gf/v2` (Go 1.23+)
- Tooling module: `cmd/gf` (CLI: `gf` command, separate `go.work`)
- Plugin modules under `contrib/`: `config/*`, `drivers/*` (mysql, pgsql, mssql, oracle, sqlite, clickhouse, dm, gaussdb, mariadb, oceanbase, tidb, sqlitecgo), `metric/*`, `nosql/*`, `registry/*`, `rpc/grpcx`, `sdk/*`, `trace/*`. Each is published as its own module so users only pull what they need.
The root framework intentionally has **minimal external dependencies** (see `go.mod`). Anything requiring a heavy third-party dep (a DB driver, a registry client, an RPC stack) lives in `contrib/`.
## Top-level package map
| Path | Purpose |
| --- | --- |
| `frame/g`, `frame/gins` | Convenience facade (`g.Server()`, `g.DB()`, `g.Cfg()`) and the singleton/instance container |
| `net/` | `ghttp` (HTTP server/router), `gclient` (HTTP client), `gtcp`, `gudp`, `gsel` (load balancing), `gsvc` (service discovery), `gtrace`, `goai` (OpenAPI) |
| `os/` | OS abstractions: `gcfg` (config), `gcmd` (CLI), `gcron`, `glog`, `gfile`, `gres` (resource embedding), `gview` (templating), `gcache`, `gsession`, `gctx`, `gtimer`, `gproc`, `gmetric`, `gfsnotify`, `gstructs` |
| `database/` | `gdb` (ORM/query builder, driver-agnostic core), `gredis` (Redis client core) |
| `container/` | Concurrent-safe data structures: `garray`, `gmap`, `gset`, `gtree`, `glist`, `gqueue`, `gring`, `gpool`, `gtype`, `gvar` |
| `encoding/` | Codecs for JSON/XML/YAML/TOML/INI/Properties, base64, charsets, compression, hashes, HTML, URL |
| `text/` | `gstr`, `gregex` |
| `util/` | `gconv` (universal conversion — heavily used), `gvalid` (validation), `gutil`, `grand`, `guid`, `gtag`, `gmeta`, `gpage`, `gmode` |
| `crypto/` | `gaes`, `gdes`, `grsa`, `gmd5`, `gsha*`, `gcrc32` |
| `errors/` | `gerror` (stack-aware errors), `gcode` (error code registry) |
| `internal/` | Framework-internal helpers (do not import from outside the root module) |
| `test/gtest` | The framework's own testing helpers — used throughout the test suite |
Concrete database drivers and Redis adapters live under `contrib/drivers/` and `contrib/nosql/`; the `database/gdb` and `database/gredis` packages define the abstract layer.
# Common Commands
All commands run from the repository root unless noted.
## Build / lint / tidy
```bash
# Tidy every go.mod in the repo (root, cmd/gf, contrib/*) — strips // indirect and toolchain lines
make tidy
# Run the project's golangci-lint config (.golangci.yml)
make lint
# Equivalent: golangci-lint run -c .golangci.yml
```
`make tidy` invokes `.make_tidy.sh`, which `cd`s into every directory containing a `go.mod` (skipping `testdata/` and `examples/`) and runs `go mod tidy`. After editing imports in any module, run this from the repo root.
## Tests
Each Go module must be tested from inside its own directory because they are separate modules. The CI script (`.github/workflows/scripts/ci-main.sh`) iterates every `go.mod`:
```bash
# Build + race-enabled tests for the root module
go build ./...
go test ./... -count=1 -race
# Coverage (matches CI 'coverage' mode)
go test ./... -count=1 -race -coverprofile=coverage.out -covermode=atomic \
-coverpkg=./...,github.com/gogf/gf/...
# Run a single package's tests
go test -count=1 -race ./os/gcfg/...
# Run a single test by name
go test -count=1 -race -run TestCfg_Get ./os/gcfg/
# Test a contrib module — must cd in first (separate go.mod)
cd contrib/drivers/mysql && go test ./... -count=1 -race
```
Many tests (database drivers, registry clients, redis cluster, apollo/nacos config) require backing services. CI starts them via docker-compose files under `.github/workflows/{redis,apollo,nacos,consul}/`. Locally, use:
```bash
make docker # start the default local stack
make docker cmd=start svc=mysql # start a specific service
make docker cmd=stop svc=mysql
```
## CLI tool
```bash
cd cmd/gf && go run . <subcommand> # iterate on the gf CLI itself
```
# Architecture Notes Worth Knowing Up Front
- **The `frame/g` package is a facade, not a library.** It re-exports types and provides singleton accessors (`g.DB()`, `g.Server()`, `g.Cfg()`, `g.Log()`) backed by `frame/gins`. Examples in docs use `g.*` heavily; framework-internal code generally imports the underlying packages directly.
- **`util/gconv` is foundational.** Most public APIs accept `any` and use `gconv` for type coercion. When changing argument handling, search for `gconv.` usage to understand the conversion contract.
- **`gdb` is driver-agnostic.** The core in `database/gdb` exposes interfaces; concrete drivers (`contrib/drivers/mysql`, etc.) register themselves via `init()` when imported. The same model pattern applies to `gredis`, `gcfg` (apollo/nacos/polaris adapters), and `gsvc` (etcd/consul/nacos/polaris/zookeeper registries).
- **`internal/` is private.** Sub-packages (`intlog`, `instance`, `reflection`, `utils`, `json`, `command`) are not part of the public API surface — do not import them from outside the root module, and avoid leaking their types in exported signatures.
- **Tests use `gtest`, not stdlib `testing` directly.** `test/gtest` provides `gtest.C(t, func(t *gtest.T){...})` blocks, fluent assertions (`t.Assert`, `t.AssertNE`, `t.AssertNil`), and is the project-wide convention. Match this style when adding tests.
- **CI matrix.** Tests run on Go 1.23, 1.24, 1.25 across 386 and amd64. `contrib/*` only runs on the latest Go version (`LATEST_GO_VERSION` in `.github/workflows/ci-main.yml`). Code that requires the latest stdlib should live in `contrib/` or be guarded.
- **Lint config matters.** `.golangci.yml` enforces a 380-char line limit, function length up to 340 lines, custom import grouping (`gci` with `prefix(github.com/gogf/gf/v2)` ahead of `cmd`/`contrib`/`example`), `gofmt -s` with rewrites (`interface{}``any`, `ioutil.*``io`/`os`, `reflect.Ptr``reflect.Pointer`). Run `make lint` before pushing.
- **OpenSpec changes live under `openspec/changes/`** and drive every non-trivial change through the workflow defined below. The active iteration directory must be checked before starting work — see the Development Workflow Rules section.
# Karpathy Guidelines
**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment.
## 1. Think Before Coding
**Don't assume. Don't hide confusion. Surface tradeoffs.**
Before implementing:
- State your assumptions explicitly. If uncertain, ask.
- If multiple interpretations exist, present them - don't pick silently.
- If a simpler approach exists, say so. Push back when warranted.
- If something is unclear, stop. Name what's confusing. Ask.
## 2. Simplicity First
**Minimum code that solves the problem. Nothing speculative.**
- No features beyond what was asked.
- No abstractions for single-use code.
- No "flexibility" or "configurability" that wasn't requested.
- No error handling for impossible scenarios.
- If you write 200 lines and it could be 50, rewrite it.
Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.
## 3. Surgical Changes
**Touch only what you must. Clean up only your own mess.**
When editing existing code:
- Don't "improve" adjacent code, comments, or formatting.
- Don't refactor things that aren't broken.
- Match existing style, even if you'd do it differently.
- If you notice unrelated dead code, mention it - don't delete it.
When your changes create orphans:
- Remove imports/variables/functions that YOUR changes made unused.
- Don't remove pre-existing dead code unless asked.
The test: Every changed line should trace directly to the user's request.
## 4. Goal-Driven Execution
**Define success criteria. Loop until verified.**
Transform tasks into verifiable goals:
- "Add validation" → "Write tests for invalid inputs, then make them pass"
- "Fix the bug" → "Write a test that reproduces it, then make it pass"
- "Refactor X" → "Ensure tests pass before and after"
For multi-step tasks, state a brief plan:
```
1. [Step] → verify: [check]
2. [Step] → verify: [check]
3. [Step] → verify: [check]
```
Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.
# Documentation Writing Rules
Technical documentation such as `README.md` must follow `.agents/instructions/markdown-format.instructions.md`.
- All directory-level primary documentation files in the repository must use the English `README.md` and provide a matching Chinese mirror in `README.zh_CN.md`.
- When adding a new directory documentation file, create both `README.md` and `README.zh_CN.md` in the same change. Maintaining only one language version is not allowed.
# Development Workflow Rules
This project follows `SDD` and uses the `OpenSpec` tool to drive implementation. Change records are stored under `openspec/changes/`. Each change includes `proposal.md`, `design.md`, `specs/`, and `tasks.md`.
**Execution workflow**:
1. Use the `/opsx:explore` slash command at `.agents/prompts/opsx/explore.md` to conduct an exploratory discussion based on the requirement description, analyze the problem, design the solution, and assess risks.
2. Once the exploratory discussion finishes and the solution is clear, use the `/opsx:propose` slash command at `.agents/prompts/opsx/propose.md` to turn it into a formal `OpenSpec` change proposal. The command format is `/opsx:propose feature-name`, where `feature-name` is a descriptive name for the current change in `kebab-case`, such as `user-auth` or `data-export`. A new change directory will then be generated automatically under `openspec/changes`, containing incremental spec documents (`spec/`), the technical implementation plan (`design.md`), the proposal and rationale (`proposal.md`), and the implementation task list (`tasks.md`).
3. Then run the `/opsx:apply` slash command at `.agents/prompts/opsx/apply.md` to execute the items in `tasks.md` one by one, completing code changes, tests, and documentation updates. After the work is done, the `/gf-review` skill must be invoked for code and spec review.
4. When users report issues or improvement requests, the `/gf-feedback` skill must be used to fix and verify them, and the related `OpenSpec` documents must be updated. After the work is done, the `/gf-review` skill must be invoked for review.
5. After the user confirms that the current iteration is complete and has no remaining issues, run the `/opsx:archive` slash command at `.agents/prompts/opsx/archive.md` to archive the change. Before archiving, the `/gf-review` skill must be used for a full change review to ensure code quality and compliance with the spec.
**Key rules**:
- **An `OpenSpec` change is considered active until it is archived**: any change directory that still exists directly under `openspec/changes/` and has **not been moved to** `openspec/changes/archive/` is an active change. **Even if the change has completed all tasks and `openspec list --json` shows `status: complete`, it must still be treated as active until the archive step has been executed.**
- When a user reports a bug, defect, or improvement request in either Chinese or English, and there is an active `OpenSpec` change in the project, the `gf-feedback` skill must be used. **Unless the user explicitly asks to create a new change, the feedback must always be appended to the current active iteration, even if it is unrelated to the main feature of that iteration**, so that everything can be managed and archived together.
- The `/gf-review` review skill is triggered automatically after `/opsx:apply` completes, after `/opsx:feedback` completes, and before `/opsx:archive`.
- During development tasks executed with tools such as `Claude Code` or `Codex CLI`, if the work can be parallelized effectively with `SubAgent` and doing so would clearly improve efficiency, that option must be evaluated first and adopted whenever appropriate. Only skip `SubAgent` when the task is strongly dependent on serial context, the split cost is too high, or it introduces obvious collaboration risk.
- When creating new iteration documents, the content of `proposal.md`, `design.md`, `tasks.md`, and the incremental specs must be written in English.
# Code Development Rules
- All source code must include comments, such as package comments, file comments, method comments for both public and private methods, constant comments, variable comments, and comments for key logic.
- **All submitted code changes must include unit tests**: every submitted code change must add or update focused unit tests that directly cover the affected logic and expected behavior of the changed code path, and the coverage for newly added code must stay at or above 80%; 90% or above is the preferred target when feasible.
- **Do not hardcode string literals with enum semantics in backend implementation code**: values that represent statuses, types, stages, actions, execution modes, sort directions, filter operators, or any other enum-like semantics must be managed through Go named types and constants. Writing raw string literals directly in business branching, comparisons, assignments, or persistence logic is forbidden.
- **Do not ignore any `error` return value**: every call that may return an `error` must be handled explicitly. Do not use patterns such as `_ = someFunc()`, `_, _ = someFunc()`, or direct calls that discard returned errors. In business flows, errors should be returned explicitly or converted before returning; in initialization, startup, or other critical non-recoverable paths, they should `panic`; in tests and cleanup paths, they must still be asserted, logged, or otherwise handled explicitly rather than silently ignored.
- **Do not use stand-alone assignments like `_ = var` to mask unused parameters or local variables**: this placeholder pattern has no business meaning and creates misleading signals about whether the variable was supposed to participate in the logic. Prefer deleting unused variables. If a parameter must be kept to satisfy an interface signature or callback contract, use the blank identifier directly in the function signature, such as `func(ctx context.Context, _ gdb.TX) error`, or omit an unused receiver name instead of adding one-line statements like `_ = tx`, `_ = req`, or `_ = ctx` in the function body.
- **File header comment rules**:
- Every `Go` source file must include a file-purpose comment at the top of the file. Component-level comments should appear in the component's main file, meaning the file with the same name as the component, such as `plugin.go`, `config.go`, or `file.go`.
- In a main file, the component comment must be placed immediately before the `package xxx` declaration with no blank line in between. For example:
```go
// Package plugin implements plugin manifest discovery, lifecycle orchestration,
// governance metadata synchronization, and host integration for LinaPro plugins.
package plugin
```
- Other implementation files must keep only file comments that describe the responsibility of the current file, such as `plugin_xxx.go` or `config_xxx.go`. There must be one blank line between the file comment and `package xxx`, and non-main files must not duplicate component-level descriptions.
- **Variable Declarations**: When defining multiple variables, use a `var` block to group them for better alignment and readability:
```go
// Good - aligned and clean
var (
authSvc *auth.Service
bizCtxSvc *bizctx.Service
k8sSvc *svcK8s.Service
notebookSvc *notebook.Service
middlewareSvc *middleware.Service
)
// Avoid - scattered declarations
authSvc := auth.New()
bizCtxSvc := bizctx.New()
k8sSvc := svcK8s.New()
```
Apply this pattern when you have 3 or more related variable declarations in the same scope.

View File

@ -1,231 +0,0 @@
# go list 性能优化 - 完成报告
**日期**2026-01-09
**优化目标**:减少 `go list` 调用次数,提升依赖分析性能
**优化结果**:✅ 从 3 次调用减少到 2 次调用 (-33%)
---
## 问题分析
### 原始问题
`cmddep_analyzer.go``loadPackages()` 方法中存在 **3 次 `go list` 调用**
1. `go list -json %s` (行 158)
- 目标:获取指定的包信息
- 问题:只获取主包,不含依赖信息
2. `go list -json -deps %s` (行 179)
- 目标:获取指定包及其所有依赖
- 问题:和第一次调用冗余,且可能因时间差而导致数据不一致
3. `go list -json -m all` (行 198)
- 目标:获取所有模块信息(包括在 go.mod 中但代码未使用的模块)
- 问题:第三次调用导致性能开销
### 性能影响
- **频繁I/O**:每次 `go list` 都涉及 Go 工具链的启动和包元数据扫描
- **时间累积**:大型项目中每次调用可能耗时 200-500ms3 次调用总耗时可达 1-1.5s
- **不一致风险**:连续调用可能因依赖版本变更而返回不同结果
---
## 优化方案
### 关键优化点
**优化前的调用顺序**
```
调用1: go list -json %s (主包)
调用2: go list -json -deps %s (主包+依赖)
调用3: go list -json -m all (所有模块)
```
**优化后的调用顺序**
```
调用1: go list -json -m all (所有模块) - 快速
↓ 用模块信息预填充 packages 集合
调用2: go list -json -deps %s (主包+依赖) - 覆盖/补充包信息
```
### 具体改进
1. **取消第一次调用**
- 原因:`go list -json -deps` 已包含主包信息,第一次调用冗余
- 效果:减少 1 次调用 (-33%)
2. **调整模块加载时机**
- 原因:模块信息加载应先执行,为包信息加载做准备
- 优势:支持 go.mod 中声明但未在代码中直接使用的模块出现在依赖图中
3. **优化错误处理**
- 模块加载失败不中断:`if err != nil { moduleResult = "" }`
- 保证即使模块加载失败,包加载仍能继续
---
## 实现细节
### 改动代码 (cmddep_analyzer.go)
```go
// loadPackages loads package information using go list with optimized approach.
// OPTIMIZATION: Reduced from 3 separate go list calls to 2 efficient calls:
// Previously:
// 1. go list -json %s (target packages only)
// 2. go list -json -deps %s (with dependencies)
// 3. go list -json -m all (all modules)
// Now (optimized):
// 1. go list -json -m all (all modules - fast, definitive)
// 2. go list -json -deps ./... (all packages with dependencies)
func (a *analyzer) loadPackages(ctx context.Context, pkgPath string) error {
// First, load module information - fast, provides metadata
moduleCmd := "go list -json -m all"
moduleResult, err := gproc.ShellExec(ctx, moduleCmd)
if err != nil {
moduleResult = "" // Module loading is optional
}
// Parse modules and pre-populate packages
if moduleResult != "" {
// ... decode modules ...
}
// Second, load package information with dependencies
cmd := fmt.Sprintf("go list -json -deps %s", pkgPath)
result, err := gproc.ShellExec(ctx, cmd)
if err != nil {
// ... error handling ...
}
// Parse packages
// ... decode packages ...
return nil
}
```
---
## 验证结果
### 编译检查
✅ 编译成功,无编译错误
### Lint 检查
✅ 无 lint 警告或错误
### 向后兼容性
**完全兼容**
- `loadPackages()` 方法签名不变
- 返回结果(`a.packages` 数据结构)不变
- 所有调用者代码无需修改
### 功能正确性
✅ 功能保持一致
- 获取相同的包和模块信息
- 建立相同的依赖关系图
- 支持所有原有的过滤和遍历操作
---
## 性能指标
### 理论改进
| 指标 | 优化前 | 优化后 | 改进 |
|------|------|------|------|
| **go list 调用数** | 3 次 | 2 次 | -33% |
| **预期执行时间** | ~600-1500ms | ~400-1000ms | -33% |
### 说明
- 假设每次调用 200-500ms
- 模块加载(`go list -m all`)通常最快,因为不需要扫描代码
- 包依赖加载(`go list -deps`)取决于项目复杂度
---
## 设计决策
### 为什么是 2 次而不是 1 次?
虽然设计目标是"1 次调用",但实际上 2 次调用是更合理的方案:
**原因**
1. `go list -deps %s``go list -m all`**命令标志组合不兼容**
- `-deps` 要求指定包/模块作为分析起点
- `-m` 要求以模块视图操作
- 两者不能在同一命令中有效结合
2. 模块加载和包加载的 **职责不同**
- 模块加载:获取 go.mod 声明的完整依赖
- 包加载:获取代码中实际使用的包
- 两者信息互补
3. **错误隔离**的好处
- 模块加载失败不影响包加载
- 提高系统鲁棒性
---
## 后续优化机会
### 1. 缓存层 (未来版本)
```go
// 缓存 go list 结果,支持增量更新
type PackageCache struct {
modules map[string]bool // 缓存模块清单
packages map[string]*goPackage // 缓存包信息
checksum string // go.mod 校验和
}
```
### 2. 并行加载 (未来版本)
```go
// 并行执行两次 go list 调用
go func() { moduleResult = shell_exec(moduleCmd) }()
result = shell_exec(packageCmd) // 同时执行
// 等待两者完成...
```
### 3. 按需加载 (未来版本)
- 支持渐进式加载(只分析指定包及其直接依赖)
- 支持深度控制(避免加载整个传递依赖树)
---
## 代码变更统计
| 指标 | 值 |
|------|-----|
| 修改文件 | 1 (`cmddep_analyzer.go`) |
| 修改行数 | ~70 行 |
| 删除行数 | 50+ 行 |
| 净增加 | ~20 行 |
| 编译错误 | 0 |
| Lint 警告 | 0 |
| 测试通过 | ✅ |
---
## 总结
**性能优化完成** - 成功将 `go list` 调用从 3 次减少到 2 次,提升了依赖分析性能并改善了代码清晰度。
### 主要成就
- ✅ 减少 1/3 的 go list 调用
- ✅ 改进代码结构(模块优先加载)
- ✅ 增强错误隔离(模块加载失败不影响包加载)
- ✅ 保持 100% 向后兼容
- ✅ 零性能退化
### 建议
- 立即合并此优化
- 后续考虑实现缓存和并行加载进一步改进
---
**完成日期**2026-01-09
**优化者**AI Assistant
**状态**:✅ 完成并验证

View File

@ -1,263 +0,0 @@
# 修复报告 - MainModuleOnly 参数无效问题
**日期**2026-01-09
**优先级**:🔴 高 (功能缺陷)
**状态**:✅ 已修复
---
## 问题描述
`--main-only` (仅主模块) 参数在代码中定义但从未实际被使用,导致该参数完全无效。
### 表现
- 用户使用 `gf dep --main-only` 时,仍然显示所有包(包括子模块的包)
- 参数被解析,但在过滤逻辑中被忽略
### 根本原因
虽然有定义 `MainModuleOnly` 字段在 `FilterOptions` 中,但:
1. `ShouldInclude()` 方法从未检查这个参数
2. `PackageInfo` 没有记录包是否属于主模块的信息
3. 虽然有 `isMainModulePackage()` 方法可以判断,但它不被调用
---
## 修复方案
### 改动 1: 扩展 `PackageInfo` 结构
**文件**`cmddep_analyzer.go` (L51-60)
```go
type PackageInfo struct {
ImportPath string // Full import path
ModulePath string // Module path
Kind PackageKind // Package classification
Tier int // Package tier
Imports []string // Direct imports
IsStdLib bool // Standard library marker
IsModuleRoot bool // Is this the root package of its module
IsMainModule bool // ← NEW: Is this package from the main module
}
```
**原因**:需要在包信息中记录"是否属于主模块",以便在过滤时使用。
### 改动 2: 更新 `buildPackageStore()` 方法
**文件**`cmddep_analyzer.go` (L636-653)
```go
func (a *analyzer) buildPackageStore() *PackageStore {
store := newPackageStore(a.modulePrefix)
for path, goPkg := range a.packages {
pkgInfo := &PackageInfo{
ImportPath: path,
ModulePath: goPkg.Module.Path,
IsStdLib: goPkg.Standard,
Imports: goPkg.Imports,
IsMainModule: a.isMainModulePackage(path), // ← NEW
}
pkgInfo.Kind = store.identifyPackageKind(pkgInfo)
store.packages[path] = pkgInfo
}
return store
}
```
**原因**:在构建 `PackageInfo` 时调用 `isMainModulePackage()` 来填充 `IsMainModule` 字段。
### 改动 3: 修复 `ShouldInclude()` 方法
**文件**`cmddep_analyzer.go` (L325-346)
```go
func (opts *FilterOptions) ShouldInclude(pkg *PackageInfo) bool {
// ← NEW: Check main module filter first
if opts.MainModuleOnly && !pkg.IsMainModule {
return false
}
// Filter by kind
switch pkg.Kind {
case KindStdLib:
if !opts.IncludeStdLib {
return false
}
case KindInternal:
if !opts.IncludeInternal {
return false
}
case KindExternal:
if !opts.IncludeExternal {
return false
}
}
return true
}
```
**原因**:在过滤逻辑中实际检查 `MainModuleOnly` 参数。
---
## 影响范围
### 受影响的功能
- ✅ 命令行 `gf dep --main-only` 命令
- ✅ Web UI "Main module only" 复选框
- ✅ HTTP API `?main=true` 参数
### 受影响的输出格式
- ✅ Tree 格式
- ✅ List 格式
- ✅ JSON 格式
- ✅ Mermaid 格式
- ✅ Dot 格式
- ✅ Reverse 格式
- ✅ Group 格式
---
## 验证结果
### 编译检查
✅ 编译成功,无编译错误
### Lint 检查
✅ 无 lint 警告或错误
### 向后兼容性
**完全兼容**
- 所有现有代码无需修改
- API 签名不变
### 功能正确性
✅ 现在可以正确过滤子模块的包
---
## 使用示例
### 命令行
```bash
# 仅显示主模块的包
gf dep --main-only
# 结合其他参数
gf dep --external --main-only
```
### Web UI
- 勾选 "Main module only" 复选框来过滤掉子模块
### HTTP API
```
GET /api/packages?main=true
GET /api/tree?main=true
```
---
## 技术细节
### `isMainModulePackage()` 工作原理
位于 `cmddep_analyzer.go` (L381-408)
```go
func (a *analyzer) isMainModulePackage(pkg string) bool {
// 没有模块前缀,认为所有包都在主模块中
if a.modulePrefix == "" {
return true
}
// 包不在模块范围内
if !gstr.HasPrefix(pkg, a.modulePrefix) {
return false
}
// 移除模块前缀得到相对路径
relativePath := gstr.TrimLeft(pkg[len(a.modulePrefix):], "/")
if relativePath == "" {
return true // 这是模块根本身
}
// 检查是否有子 go.mod 文件(表示子模块)
parts := gstr.Split(relativePath, "/")
for i := len(parts); i > 0; i-- {
subPath := gstr.Join(parts[:i], "/")
if subPath != "" && gfile.Exists(subPath+"/go.mod") {
return false // 找到了子模块
}
}
return true // 这是主模块的一部分
}
```
**工作流程**
1. 验证包在模块范围内
2. 检查包相对路径中是否存在 `go.mod` 文件
3. 如果存在子 `go.mod`,说明这是子模块,返回 `false`
4. 否则是主模块的一部分,返回 `true`
---
## 相关代码位置
| 组件 | 文件 | 行号 | 用途 |
|------|------|------|------|
| PackageInfo | cmddep_analyzer.go | L51-60 | 数据模型 |
| FilterOptions | cmddep_analyzer.go | L62-77 | 过滤参数 |
| ShouldInclude() | cmddep_analyzer.go | L323-346 | 过滤决策 |
| buildPackageStore() | cmddep_analyzer.go | L636-653 | 数据构建 |
| isMainModulePackage() | cmddep_analyzer.go | L381-408 | 主模块检测 |
---
## 测试建议
### 手动测试
```bash
# 创建有子模块的项目或使用现有项目
cd /path/to/project/with/submodule
# 测试不带参数
gf dep --tree
# 测试只显示主模块
gf dep --tree --main-only
# 验证结果应该显著减少(子模块包被过滤)
```
### 自动测试
建议添加单元测试验证:
- `MainModuleOnly=true``ShouldInclude()` 正确返回 `false` 对于非主模块包
- `buildPackageStore()` 正确设置 `IsMainModule` 字段
- 各种输出格式都正确应用过滤
---
## 总结
**功能修复完成**
| 项 | 状态 |
|----|------|
| **编译** | ✅ 成功 |
| **Lint** | ✅ 无错误 |
| **功能** | ✅ 正常 |
| **兼容性** | ✅ 100% |
现在 `--main-only` 参数可以正确过滤掉子模块的包。
---
**完成日期**2026-01-09
**修复者**AI Assistant
**状态**:✅ 完成并验证

View File

@ -52,31 +52,6 @@ tag:
git push origin $$newVersion; \
echo "Tag $$newVersion created and pushed successfully!"
# update submodules
.PHONY: subup
subup:
@set -e; \
echo "Updating submodules..."; \
git submodule init;\
git submodule update;
# update and commit submodules
.PHONY: subsync
subsync: subup
@set -e; \
echo "";\
cd examples; \
echo "Checking for changes..."; \
if git diff-index --quiet HEAD --; then \
echo "No changes to commit"; \
else \
echo "Found changes, committing..."; \
git add -A; \
git commit -m "examples update"; \
git push origin; \
fi; \
cd ..;
# manage docker services for local development
# usage: make docker or make docker cmd=start svc=mysql
.PHONY: docker

View File

@ -1,7 +1,7 @@
English | [简体中文](README.zh_CN.MD)
<div align=center>
<img src="https://goframe.org/img/logo_full.png" width="300" alt="goframe gf logo"/>
<img src="https://goframe.org/img/logo_full.png" width="300" alt="goframe logo"/>
[![Go Reference](https://pkg.go.dev/badge/github.com/gogf/gf/v2.svg)](https://pkg.go.dev/github.com/gogf/gf/v2)
[![GoFrame CI](https://github.com/gogf/gf/actions/workflows/ci-main.yml/badge.svg)](https://github.com/gogf/gf/actions/workflows/ci-main.yml)
@ -19,6 +19,7 @@ English | [简体中文](README.zh_CN.MD)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/gogf/gf?style=flat)](https://github.com/gogf/gf/issues?q=is%3Aissue+is%3Aclosed)
![Stars](https://img.shields.io/github/stars/gogf/gf?style=flat)
![Forks](https://img.shields.io/github/forks/gogf/gf?style=flat)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/gogf/gf)
</div>
@ -35,7 +36,7 @@ go get -u github.com/gogf/gf/v2
- Official Site: [https://goframe.org](https://goframe.org)
- Official Site(en): [https://goframe.org/en](https://goframe.org/en)
- 国内镜像: [https://goframe.org.cn](https://goframe.org.cn)
- Mirror Site: [Github Pages](https://pages.goframe.org)
- Mirror Site: [https://pages.goframe.org](https://pages.goframe.org)
- Mirror Site: [Offline Docs](https://github.com/gogf/goframe.org-pdf?tab=readme-ov-file#%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC)
- GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
- Doc Source: [https://github.com/gogf/gf-site](https://github.com/gogf/gf-site)
@ -45,7 +46,7 @@ go get -u github.com/gogf/gf/v2
💖 [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) 💖
<a href="https://github.com/gogf/gf/graphs/contributors">
<img src="https://goframe.org/img/contributors.svg?version=v2.9.8" alt="goframe contributors"/>
<img src="https://goframe.org/img/contributors.svg?version=v2.10.0" alt="goframe contributors"/>
</a>
## License

View File

@ -1,7 +1,7 @@
[English](README.MD) | 简体中文
<div align=center>
<img src="https://goframe.org/img/logo_full.png" width="300" alt="goframe gf logo"/>
<img src="https://goframe.org/img/logo_full.png" width="300" alt="goframe logo"/>
[![Go Reference](https://pkg.go.dev/badge/github.com/gogf/gf/v2.svg)](https://pkg.go.dev/github.com/gogf/gf/v2)
[![GoFrame CI](https://github.com/gogf/gf/actions/workflows/ci-main.yml/badge.svg)](https://github.com/gogf/gf/actions/workflows/ci-main.yml)
@ -19,10 +19,11 @@
[![GitHub closed issues](https://img.shields.io/github/issues-closed/gogf/gf?style=flat)](https://github.com/gogf/gf/issues?q=is%3Aissue+is%3Aclosed)
![Stars](https://img.shields.io/github/stars/gogf/gf?style=flat)
![Forks](https://img.shields.io/github/forks/gogf/gf?style=flat)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/gogf/gf)
</div>
强大的框架,为了更快、更轻松、更高效的项目开发。
强大的框架,为了更快、更轻松、更高效的项目开发。
## 安装
@ -35,7 +36,7 @@ go get -u github.com/gogf/gf/v2
- 官方网站: [https://goframe.org](https://goframe.org)
- 官方网站(en): [https://goframe.org/en](https://goframe.org/en)
- 国内镜像: [https://goframe.org.cn](https://goframe.org.cn)
- 镜像网站: [Github Pages](https://pages.goframe.org)
- 镜像网站: [https://pages.goframe.org](https://pages.goframe.org)
- 镜像网站: [离线文档](https://github.com/gogf/goframe.org-pdf?tab=readme-ov-file#%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC)
- Go包文档: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)
- 文档源码: [https://github.com/gogf/gf-site](https://github.com/gogf/gf-site)
@ -45,9 +46,9 @@ go get -u github.com/gogf/gf/v2
💖 [感谢所有使 GoFrame 成为可能的贡献者](https://github.com/gogf/gf/graphs/contributors) 💖
<a href="https://github.com/gogf/gf/graphs/contributors">
<img src="https://goframe.org/img/contributors.svg?version=v2.9.5" alt="goframe contributors"/>
<img src="https://goframe.org/img/contributors.svg?version=v2.10.0" alt="goframe contributors"/>
</a>
## 许可证
`GoFrame` 采用 [MIT License](LICENSE) 许可100% 免费和开源,永久保持
`GoFrame` 采用 [MIT License](LICENSE) 许可100%开源和免费

View File

@ -22,7 +22,6 @@ import (
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/cmddep"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/allyes"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
@ -90,7 +89,7 @@ func GetCommand(ctx context.Context) (*Command, error) {
cmd.Install,
cmd.Version,
cmd.Doc,
cmddep.Dep,
cmd.CfgEditor,
)
if err != nil {
return nil, err

View File

@ -3,13 +3,13 @@ module github.com/gogf/gf/cmd/gf/v2
go 1.23.0
require (
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0
github.com/gogf/gf/v2 v2.10.0
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f
github.com/olekukonko/tablewriter v1.1.0
github.com/schollz/progressbar/v3 v3.15.0

View File

@ -46,20 +46,20 @@ github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiU
github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8 h1:L72OB2HPuZSHtJ2ipBzI+62rGGDRdwYjequ1v+zctpg=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.9.8/go.mod h1:D0UySg70Bd264F5AScYmz1Hl8vjzlUJ7YvqBJc5OFbo=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8 h1:DT5zHfo9/VkbJ+TF7kUasvv4dbU5uctoj+JGbrzgdYE=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.9.8/go.mod h1:cDd91Zd8LxFF+xxOflRRqw0WTTCpAJ0nf0KKRA+nvTE=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8 h1:XZ4Ya/50xpjf81+4genr33iJXR2dxJmqYKxGyXlLRqA=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.9.8/go.mod h1:wtm2NJb/L3CbDOmyUc7TsOpWHTCMakg1QRG7B/oKrRs=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8 h1:ZrqABJsUnhNDz8VAem1XXONBTywl6r+GHQH05i+4W1g=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.9.8/go.mod h1:YTFyeVk2Rgu/JMUhFxkjYzWaBc+yZ6wAvY54XVZoNko=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8 h1:Dc227FD1uf9nNBPFEjMEgIoAJbAgeYeNrOrjviDgPzY=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.9.8/go.mod h1:o3EpB4Ti3+x/axzRMJg2k7TrLiWZiSTxP0v64LBkk5k=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8 h1:LHEhzsBfIo8xHvOUuLDQW1q7Qix1vnBabH/iivCRghs=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.9.8/go.mod h1:SX6dRONaJGafzCoMIrn8CkRM4fIvtmJRt/aYclUHy3Q=
github.com/gogf/gf/v2 v2.9.8 h1:El0HwksTzeRk0DQV4Lh7S9DbsIwKInhHSHGcH7qJumM=
github.com/gogf/gf/v2 v2.9.8/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0 h1:9PTchr92xIJej4tq5c+HOHSU7LGOHr3YfD7tuf23LW4=
github.com/gogf/gf/contrib/drivers/clickhouse/v2 v2.10.0/go.mod h1:eKtLMs9uccxFvmoKOUCRQ/Se3nxhzEZwF0Ir13qbk5g=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0 h1:mBs6XpNM34IdZPZv4Kv3LA8yhP2UisbONMLfnQVFvKM=
github.com/gogf/gf/contrib/drivers/mssql/v2 v2.10.0/go.mod h1:mChbF9FrmiYMSE2rG3zdxI/oSTwaHsR5KbINAgt3KcY=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0 h1:UvqxwinkelKxwdwnKUfdy51/ls4RL7MCeJqAZOVAy0I=
github.com/gogf/gf/contrib/drivers/mysql/v2 v2.10.0/go.mod h1:6v7oGBF9wv59WERJIOJxXmLhkUcxwON3tPYW3AZ7wbY=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0 h1:MvhoMaz8YYj4WJuYzKGDdzJYiieiYiqp0vjoOshfOF4=
github.com/gogf/gf/contrib/drivers/oracle/v2 v2.10.0/go.mod h1:vb2fx33RGhjhOaocOTEFvlEuBSGHss5S0lZ4sS3XK6E=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0 h1:39+jbTenm7KBj4hO2C8ANAxVHpX/7OuRDs1VcGC9ylA=
github.com/gogf/gf/contrib/drivers/pgsql/v2 v2.10.0/go.mod h1:B0s0fVzn0W220E8UTpSGzrrGKsop5KcB90twBeLCiz0=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0 h1:OyAH7Ls2c9Un7CJiAq7G6eY1jWIICRkN8C5SyM94rnY=
github.com/gogf/gf/contrib/drivers/sqlite/v2 v2.10.0/go.mod h1:fwhAMG0qZpeHbbP2JE78rJRfV7eBbu9jXkxTMM1lwyo=
github.com/gogf/gf/v2 v2.10.0 h1:rzDROlyqGMe/eM6dCalSR8dZOuMIdLhmxKSH1DGhbFs=
github.com/gogf/gf/v2 v2.10.0/go.mod h1:Svl1N+E8G/QshU2DUbh/3J/AJauqCgUnxHurXWR4Qx0=
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f h1:7xfXR/BhG3JDqO1s45n65Oyx9t4E/UqDOXep6jXdLCM=
github.com/gogf/selfupdate v0.0.0-20231215043001-5c48c528462f/go.mod h1:HnYoio6S7VaFJdryKcD/r9HgX+4QzYfr00XiXUo/xz0=
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=

View File

@ -0,0 +1,112 @@
# GoFrame Config Editor
A web-based visual configuration editor for GoFrame projects. It reads your `config.yaml` and provides an interactive UI to view, edit, and save configuration fields with type-aware inputs, validation, and i18n support.
## Quick Start
```bash
gf config # Start on port 8888, auto-detect config file
gf config -p 9000 # Use a custom port
gf config -f manifest/config/config.yaml # Specify config file path
```
The browser opens automatically at `http://127.0.0.1:<port>`.
## Features
### Supported Modules
| Module | Config Node | Description |
|--------|-------------|-------------|
| Server | `server` | HTTP server settings (address, timeouts, TLS, sessions, logging, PProf) |
| Database | `database` | Database connections (host, port, credentials, pool, timeouts) |
| Redis | `redis` | Redis connections (address, auth, pool, sentinel, cluster) |
| Logger | `logger` | Logging configuration (level, rotation, output) |
| Viewer | `viewer` | Template engine settings (paths, delimiters, auto-encode) |
### UI Features
- **Type-aware inputs**: bool fields get toggle switches, duration fields get text input with placeholder hints, map/slice fields get JSON editors
- **Default value display**: each field shows its default value from struct tags
- **Validation**: fields with `v:"required"` tags are validated on blur
- **Modified tracking**: changed fields are marked with a blue indicator bar
- **Group collapse**: fields are organized by logical groups (Basic, Connection, Pool, etc.)
- **Search**: search fields by name, key, description, or type (supports Chinese)
- **i18n**: switch between English and Chinese field descriptions
- **Export format**: save as YAML, TOML, or JSON
- **Keyboard shortcut**: `Ctrl/Cmd + S` to save
### Config File Detection
When no `-f` flag is provided, the editor searches these paths in order:
1. `config.yaml` / `config.yml` / `config.toml` / `config.json`
2. `config/config.yaml` (and variants)
3. `manifest/config/config.yaml` (and variants)
4. `app.yaml` / `app.yml`
### Nested Config Support
GoFrame stores database and redis configs under group names:
```yaml
database:
default:
host: 127.0.0.1
port: 3306
redis:
default:
address: 127.0.0.1:6379
```
The editor correctly reads and writes these nested structures.
## Architecture
```
cmd/gf/internal/cmd/
├── cmd_config.go # CLI command + REST API handlers
├── resources/
│ ├── templates/index.html # Vue 3 + Tailwind CSS SPA
│ ├── static/vue.global.prod.js # Vue 3 runtime
│ ├── static/tailwind.min.css # Tailwind CSS
│ └── i18n/{en,zh-CN}.yaml # Field descriptions
os/gcfg/
├── gcfg_schema.go # Schema registry (FieldSchema, ModuleSchema, SchemaRegistry)
└── gcfg_z_unit_schema_test.go # Unit tests
```
### API Endpoints
| Method | Path | Description |
|--------|------|-------------|
| GET | `/api/schemas` | Returns all registered module schemas (fields, types, defaults, rules) |
| GET | `/api/config` | Returns current config values from file |
| POST | `/api/config/validate` | Validates config values against schema rules |
| POST | `/api/config/save` | Saves config to file (preserves YAML comments) |
| GET | `/api/i18n/:lang` | Returns i18n translations for the given language |
### Struct Tags
Configuration field metadata is extracted from struct tags:
| Tag | Purpose | Example |
|-----|---------|---------|
| `json` | YAML/JSON key | `json:"address"` |
| `d` | Default value | `d:":0"` |
| `v` | Validation rule (gvalid) | `v:"required"` |
| `dc` | Description + i18n key | `dc:"Server address\|i18n:config.server.address"` |
## Development
### Building
```bash
go build ./cmd/gf/...
```
### Testing
```bash
go test -count=1 -v ./os/gcfg/... -run TestSchema
```

View File

@ -0,0 +1,575 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmd
import (
"context"
"embed"
"fmt"
"io/fs"
"net/http"
"os/exec"
"runtime"
"strconv"
"strings"
"time"
"gopkg.in/yaml.v3"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/database/gredis"
"github.com/gogf/gf/v2/encoding/gjson"
"github.com/gogf/gf/v2/encoding/gyaml"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/os/gcfg"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/os/glog"
"github.com/gogf/gf/v2/os/gview"
"github.com/gogf/gf/v2/util/gvalid"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
//go:embed resources/i18n/*.yaml
var i18nFS embed.FS
//go:embed resources/templates/index.html
var configEditorHTML string
//go:embed resources/static/*
var staticFS embed.FS
var (
// CfgEditor is the management object for `gf config` command.
CfgEditor = cCfgEditor{}
)
type cCfgEditor struct {
g.Meta `name:"config" brief:"start the configuration visual editor"`
}
type cCfgEditorInput struct {
g.Meta `name:"config" config:"gfcli.config"`
Port int `short:"p" name:"port" brief:"web server port" d:"8888"`
File string `short:"f" name:"file" brief:"configuration file path"`
}
type cCfgEditorOutput struct{}
func init() {
registerAllSchemas()
}
// registerAllSchemas registers configuration schemas for the five core modules.
func registerAllSchemas() {
// Server
gcfg.RegisterSchema("server", "server", ghttp.ServerConfig{}, map[string]string{
"Name": "Basic", "Address": "Basic", "HTTPSAddr": "Basic",
"HTTPSCertPath": "Basic", "HTTPSKeyPath": "Basic",
"ReadTimeout": "Basic", "WriteTimeout": "Basic", "IdleTimeout": "Basic",
"MaxHeaderBytes": "Basic", "KeepAlive": "Basic", "ServerAgent": "Basic",
"IndexFolder": "Static", "ServerRoot": "Static", "FileServerEnabled": "Static",
"CookieMaxAge": "Cookie", "CookiePath": "Cookie", "CookieDomain": "Cookie",
"CookieSameSite": "Cookie", "CookieSecure": "Cookie", "CookieHttpOnly": "Cookie",
"SessionIdName": "Session", "SessionMaxAge": "Session", "SessionPath": "Session",
"SessionCookieMaxAge": "Session", "SessionCookieOutput": "Session",
"LogPath": "Logging", "LogLevel": "Logging", "LogStdout": "Logging",
"ErrorStack": "Logging", "ErrorLogEnabled": "Logging", "ErrorLogPattern": "Logging",
"AccessLogEnabled": "Logging", "AccessLogPattern": "Logging",
"PProfEnabled": "PProf", "PProfPattern": "PProf",
"OpenApiPath": "API", "SwaggerPath": "API", "SwaggerUITemplate": "API",
"Graceful": "Graceful", "GracefulTimeout": "Graceful", "GracefulShutdownTimeout": "Graceful",
"ClientMaxBodySize": "Other", "FormParsingMemory": "Other",
"NameToUriType": "Other", "RouteOverWrite": "Other", "DumpRouterMap": "Other",
"Endpoints": "Other", "Rewrites": "Other", "IndexFiles": "Other", "SearchPaths": "Other",
"StaticPaths": "Other", "Listeners": "Other",
})
// Database
gcfg.RegisterSchema("database", "database", gdb.ConfigNode{}, map[string]string{
"Host": "Connection", "Port": "Connection", "User": "Connection",
"Pass": "Connection", "Name": "Connection", "Type": "Connection",
"Link": "Connection", "Extra": "Connection", "Protocol": "Connection",
"Charset": "Connection", "Timezone": "Connection", "Namespace": "Connection",
"MaxIdleConnCount": "Pool", "MaxOpenConnCount": "Pool",
"MaxConnLifeTime": "Pool", "MaxIdleConnTime": "Pool",
"Role": "Role", "Debug": "Role", "Prefix": "Role", "DryRun": "Role", "Weight": "Role",
"QueryTimeout": "Timeout", "ExecTimeout": "Timeout",
"TranTimeout": "Timeout", "PrepareTimeout": "Timeout",
"CreatedAt": "AutoTimestamp", "UpdatedAt": "AutoTimestamp",
"DeletedAt": "AutoTimestamp", "TimeMaintainDisabled": "AutoTimestamp",
})
// Redis
gcfg.RegisterSchema("redis", "redis", gredis.Config{}, map[string]string{
"Address": "Connection", "Db": "Connection", "User": "Connection",
"Pass": "Connection", "Protocol": "Connection",
"MinIdle": "Pool", "MaxIdle": "Pool", "MaxActive": "Pool",
"MaxConnLifetime": "Pool", "IdleTimeout": "Pool", "WaitTimeout": "Pool",
"DialTimeout": "Timeout", "ReadTimeout": "Timeout", "WriteTimeout": "Timeout",
"MasterName": "Sentinel", "SentinelUser": "Sentinel", "SentinelPass": "Sentinel",
"TLS": "Security", "TLSSkipVerify": "Security",
"SlaveOnly": "Security", "Cluster": "Security",
})
// Logger
gcfg.RegisterSchema("logger", "logger", glog.Config{}, map[string]string{
"Flags": "Basic", "TimeFormat": "Basic", "Path": "Basic",
"File": "Basic", "Level": "Basic", "Prefix": "Basic",
"HeaderPrint": "Output", "StdoutPrint": "Output", "LevelPrint": "Output",
"StdoutColorDisabled": "Output", "WriterColorEnable": "Output",
"StSkip": "Stack", "StStatus": "Stack", "StFilter": "Stack",
"RotateSize": "Rotate", "RotateExpire": "Rotate",
"RotateBackupLimit": "Rotate", "RotateBackupExpire": "Rotate",
"RotateBackupCompress": "Rotate", "RotateCheckInterval": "Rotate",
})
// Viewer
gcfg.RegisterSchema("viewer", "viewer", gview.Config{}, map[string]string{
"Paths": "Basic", "Data": "Basic", "DefaultFile": "Basic",
"Delimiters": "Basic", "AutoEncode": "Basic",
})
}
// Index starts the config editor web server.
func (c cCfgEditor) Index(ctx context.Context, in cCfgEditorInput) (out *cCfgEditorOutput, err error) {
mlog.Printf("[ConfigEditor] Starting with port=%d, file=%q", in.Port, in.File)
// Verify embedded i18n files are accessible.
for _, lang := range []string{"en", "zh-CN"} {
path := "resources/i18n/" + lang + ".yaml"
if data, e := i18nFS.ReadFile(path); e != nil {
mlog.Printf("[ConfigEditor] WARNING: embedded i18n file %q not found: %v", path, e)
} else {
mlog.Printf("[ConfigEditor] Embedded i18n file %q loaded, size=%d bytes", path, len(data))
}
}
s := g.Server("gf-config-editor")
s.SetPort(in.Port)
s.SetDumpRouterMap(false)
// API endpoints.
s.Group("/api", func(group *ghttp.RouterGroup) {
group.GET("/schemas", apiGetSchemas)
group.GET("/config", apiGetConfig(in.File))
group.POST("/config/validate", apiValidateConfig)
group.POST("/config/save", apiSaveConfig)
group.GET("/i18n/:lang", apiGetI18n)
})
// Serve embedded static files.
s.BindHandler("/static/*", func(r *ghttp.Request) {
filePath := strings.TrimPrefix(r.URL.Path, "/static/")
data, err := fs.ReadFile(staticFS, "resources/static/"+filePath)
if err != nil {
r.Response.WriteStatus(http.StatusNotFound)
return
}
if strings.HasSuffix(filePath, ".js") {
r.Response.Header().Set("Content-Type", "application/javascript; charset=utf-8")
} else if strings.HasSuffix(filePath, ".css") {
r.Response.Header().Set("Content-Type", "text/css; charset=utf-8")
}
r.Response.Header().Set("Cache-Control", "public, max-age=86400")
r.Response.Write(data)
})
// Serve the embedded UI.
s.BindHandler("/", func(r *ghttp.Request) {
r.Response.WriteHeader(http.StatusOK)
r.Response.Header().Set("Content-Type", "text/html; charset=utf-8")
r.Response.Write(configEditorHTML)
})
addr := fmt.Sprintf("http://127.0.0.1:%d", in.Port)
mlog.Printf("[ConfigEditor] GoFrame Config Editor starting at %s", addr)
go func() {
time.Sleep(500 * time.Millisecond)
if err := openBrowser(addr); err != nil {
mlog.Printf("[ConfigEditor] WARNING: failed to open browser: %v", err)
}
}()
s.Run()
return
}
// apiGetSchemas returns all registered module schemas.
func apiGetSchemas(r *ghttp.Request) {
schemas := gcfg.GetAllSchemas()
r.Response.WriteJsonExit(g.Map{
"code": 0,
"data": schemas,
})
}
// apiGetConfig returns the current configuration values.
func apiGetConfig(file string) func(r *ghttp.Request) {
return func(r *ghttp.Request) {
configFile := file
if configFile == "" {
searchPaths := []string{
"config.yaml", "config.yml", "config.toml", "config.json",
"config/config.yaml", "config/config.yml",
"config/config.toml", "config/config.json",
"manifest/config/config.yaml", "manifest/config/config.yml",
"manifest/config/config.toml", "manifest/config/config.json",
"app.yaml", "app.yml",
}
for _, name := range searchPaths {
if gfile.Exists(name) {
configFile = name
break
}
}
}
data := g.Map{}
filePath := ""
fileType := ""
if configFile != "" && gfile.Exists(configFile) {
filePath = gfile.RealPath(configFile)
fileType = gfile.ExtName(configFile)
content := gfile.GetBytes(configFile)
j, err := gjson.LoadContent(content)
if err != nil {
r.Response.WriteJsonExit(g.Map{
"code": 1,
"message": fmt.Sprintf("Failed to parse config file %q: %v", filePath, err),
})
return
}
data = j.Map()
}
r.Response.WriteJsonExit(g.Map{
"code": 0,
"data": g.Map{
"config": data,
"filePath": filePath,
"fileType": fileType,
},
})
}
}
// apiValidateConfig validates configuration values using gvalid.
func apiValidateConfig(r *ghttp.Request) {
var reqData struct {
Module string `json:"module"`
Values map[string]any `json:"values"`
}
if err := r.Parse(&reqData); err != nil {
r.Response.WriteJsonExit(g.Map{"code": 1, "message": err.Error()})
return
}
schema, ok := gcfg.GetSchema(reqData.Module)
if !ok {
r.Response.WriteJsonExit(g.Map{"code": 1, "message": fmt.Sprintf("module %q not found", reqData.Module)})
return
}
// Build validation rules from schema fields.
var rules []string
for _, field := range schema.Fields {
if field.Rule == "" {
continue
}
rule := field.JsonKey + "|" + field.Rule
rules = append(rules, rule)
}
if len(rules) > 0 {
if err := gvalid.New().Data(reqData.Values).Rules(rules).Run(r.Context()); err != nil {
// Parse validation errors into field-level messages.
validationErrors := make(map[string]string)
if vErr, ok := err.(gvalid.Error); ok {
for _, item := range vErr.Items() {
for field, ruleErrMap := range item {
for _, ruleErr := range ruleErrMap {
validationErrors[field] = ruleErr.Error()
break
}
}
}
} else {
validationErrors["_general"] = err.Error()
}
r.Response.WriteJsonExit(g.Map{
"code": 1,
"message": "Validation failed",
"errors": validationErrors,
})
return
}
}
r.Response.WriteJsonExit(g.Map{
"code": 0,
"message": "Valid",
})
}
// apiSaveConfig saves configuration to file.
func apiSaveConfig(r *ghttp.Request) {
var reqData struct {
Config map[string]any `json:"config"`
FilePath string `json:"filePath"`
FileType string `json:"fileType"`
}
if err := r.Parse(&reqData); err != nil {
r.Response.WriteJsonExit(g.Map{"code": 1, "message": err.Error()})
return
}
if reqData.FilePath == "" {
reqData.FilePath = "config.yaml"
reqData.FileType = "yaml"
}
var err error
switch reqData.FileType {
case "yaml", "yml":
err = saveYAMLPreservingComments(reqData.FilePath, reqData.Config)
default:
j := gjson.New(reqData.Config)
var content string
switch reqData.FileType {
case "toml":
content, err = j.ToTomlString()
case "json":
content, err = j.ToJsonIndentString()
case "ini":
content, err = j.ToIniString()
default:
content, err = j.ToYamlString()
}
if err == nil {
err = gfile.PutContents(reqData.FilePath, content)
}
}
if err != nil {
r.Response.WriteJsonExit(g.Map{"code": 1, "message": err.Error()})
return
}
r.Response.WriteJsonExit(g.Map{
"code": 0,
"message": "Configuration saved successfully",
"data": g.Map{
"filePath": gfile.RealPath(reqData.FilePath),
},
})
}
// saveYAMLPreservingComments writes the config map to a YAML file while preserving
// any existing comments in the file.
func saveYAMLPreservingComments(filePath string, newConfig map[string]any) error {
var (
docNode yaml.Node
indent = 2
)
if gfile.Exists(filePath) {
content := gfile.GetBytes(filePath)
indent = detectYAMLIndent(content)
if err := yaml.Unmarshal(content, &docNode); err != nil {
docNode = yaml.Node{}
}
}
if docNode.Kind == 0 {
docNode = yaml.Node{Kind: yaml.DocumentNode}
docNode.Content = []*yaml.Node{{Kind: yaml.MappingNode, Tag: "!!map"}}
} else if docNode.Kind == yaml.DocumentNode {
if len(docNode.Content) == 0 {
docNode.Content = []*yaml.Node{{Kind: yaml.MappingNode, Tag: "!!map"}}
} else if docNode.Content[0].Kind != yaml.MappingNode {
docNode.Content = []*yaml.Node{{Kind: yaml.MappingNode, Tag: "!!map"}}
}
}
applyMapToYAMLNode(docNode.Content[0], newConfig)
var buf strings.Builder
enc := yaml.NewEncoder(&buf)
enc.SetIndent(indent)
if err := enc.Encode(&docNode); err != nil {
return err
}
_ = enc.Close()
return gfile.PutContents(filePath, buf.String())
}
// detectYAMLIndent returns the number of spaces used for indentation in the YAML content.
func detectYAMLIndent(content []byte) int {
for _, line := range strings.Split(string(content), "\n") {
trimmed := strings.TrimLeft(line, " ")
if len(trimmed) == 0 || strings.HasPrefix(trimmed, "#") {
continue
}
spaces := len(line) - len(trimmed)
if spaces > 0 {
return spaces
}
}
return 2
}
// applyMapToYAMLNode recursively merges updates into an existing yaml.MappingNode,
// preserving comments and formatting style on nodes that already exist.
func applyMapToYAMLNode(mappingNode *yaml.Node, updates map[string]any) {
if mappingNode.Kind != yaml.MappingNode {
return
}
keyIndex := make(map[string]int)
for i := 0; i < len(mappingNode.Content)-1; i += 2 {
keyIndex[mappingNode.Content[i].Value] = i + 1
}
for key, value := range updates {
valIdx, exists := keyIndex[key]
if !exists {
keyNode := &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: key}
valNode := anyToYAMLNode(value)
mappingNode.Content = append(mappingNode.Content, keyNode, valNode)
keyIndex[key] = len(mappingNode.Content) - 1
} else {
existingVal := mappingNode.Content[valIdx]
updateYAMLNodeInPlace(existingVal, value)
}
}
}
// updateYAMLNodeInPlace updates the yaml.Node in place to reflect newValue
// while maximally preserving the original formatting style and comments.
func updateYAMLNodeInPlace(node *yaml.Node, newValue any) {
head, line, foot := node.HeadComment, node.LineComment, node.FootComment
switch v := newValue.(type) {
case map[string]any:
if node.Kind == yaml.MappingNode {
applyMapToYAMLNode(node, v)
return
}
*node = *anyToYAMLNode(v)
case []any:
if node.Kind == yaml.SequenceNode {
style := node.Style
newSeq := anyToYAMLNode(v)
*node = *newSeq
node.Style = style
} else {
*node = *anyToYAMLNode(v)
}
default:
newNode := anyToYAMLNode(v)
if node.Kind == yaml.ScalarNode && newNode.Kind == yaml.ScalarNode {
node.Value = newNode.Value
node.Tag = newNode.Tag
} else {
*node = *newNode
}
}
node.HeadComment, node.LineComment, node.FootComment = head, line, foot
}
// anyToYAMLNode converts a Go value to a yaml.Node.
func anyToYAMLNode(v any) *yaml.Node {
if v == nil {
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!null", Value: "null"}
}
switch val := v.(type) {
case map[string]any:
node := &yaml.Node{Kind: yaml.MappingNode, Tag: "!!map"}
for k, vv := range val {
keyNode := &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: k}
valNode := anyToYAMLNode(vv)
node.Content = append(node.Content, keyNode, valNode)
}
return node
case []any:
node := &yaml.Node{Kind: yaml.SequenceNode, Tag: "!!seq"}
for _, item := range val {
node.Content = append(node.Content, anyToYAMLNode(item))
}
return node
case bool:
s := "false"
if val {
s = "true"
}
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!bool", Value: s}
case int:
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!int", Value: strconv.Itoa(val)}
case int64:
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!int", Value: strconv.FormatInt(val, 10)}
case float64:
s := strconv.FormatFloat(val, 'f', -1, 64)
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!float", Value: s}
case string:
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: val}
default:
return &yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: fmt.Sprintf("%v", v)}
}
}
// apiGetI18n returns i18n translations for the given language.
func apiGetI18n(r *ghttp.Request) {
lang := r.Get("lang").String()
if lang == "" {
lang = "en"
}
fileName := lang + ".yaml"
filePath := "resources/i18n/" + fileName
content, err := i18nFS.ReadFile(filePath)
if err != nil {
r.Response.WriteJsonExit(g.Map{
"code": 0,
"data": g.Map{},
})
return
}
var translations map[string]string
if err = gyaml.DecodeTo(content, &translations); err != nil {
r.Response.WriteJsonExit(g.Map{
"code": 0,
"data": g.Map{},
})
return
}
r.Response.WriteJsonExit(g.Map{
"code": 0,
"data": translations,
})
}
// openBrowser opens the default browser to the given URL.
func openBrowser(url string) error {
var cmd *exec.Cmd
switch runtime.GOOS {
case "darwin":
cmd = exec.Command("open", url)
case "windows":
cmd = exec.Command("rundll32", "url.dll,FileProtocolHandler", url)
default:
cmd = exec.Command("xdg-open", url)
}
return cmd.Start()
}

View File

@ -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"),
})
})
}

View File

@ -238,3 +238,48 @@ func Test_Gen_Service_PackagesFilter(t *testing.T) {
t.Assert(files[0], dstFolder+filepath.FromSlash("/user.go"))
})
}
// https://github.com/gogf/gf/issues/4242
// Test that versioned imports and aliased imports are correctly preserved.
// The issue is that imports like "github.com/minio/minio-go/v7" were being
// incorrectly handled because the package name (minio) differs from
// the directory name (minio-go).
func Test_Issue4242(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
var (
path = gfile.Temp(guid.S())
dstFolder = path + filepath.FromSlash("/service")
srvFolder = gtest.DataPath("issue", "4242", "logic")
in = genservice.CGenServiceInput{
SrcFolder: srvFolder,
DstFolder: dstFolder,
DstFileNameCase: "Snake",
WatchFile: "",
StPattern: "",
Packages: nil,
ImportPrefix: "",
Clear: false,
}
)
err := gutil.FillStructWithDefault(&in)
t.AssertNil(err)
err = gfile.Mkdir(path)
t.AssertNil(err)
defer gfile.Remove(path)
_, err = genservice.CGenService{}.Service(ctx, in)
t.AssertNil(err)
// Test versioned imports
t.Assert(
gfile.GetContents(dstFolder+filepath.FromSlash("/issue_4242.go")),
gfile.GetContents(gtest.DataPath("issue", "4242", "service", "issue_4242.go")),
)
// Test aliased imports
t.Assert(
gfile.GetContents(dstFolder+filepath.FromSlash("/issue_4242_alias.go")),
gfile.GetContents(gtest.DataPath("issue", "4242", "service", "issue_4242_alias.go")),
)
})
}

View File

@ -1,140 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmddep
import (
"context"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/util/gtag"
"github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog"
)
var (
Dep = cDep{}
)
type cDep struct {
g.Meta `name:"dep" brief:"{cDepBrief}" eg:"{cDepEg}"`
}
const (
cDepBrief = `analyze and display Go package dependencies`
cDepEg = `
gf dep
gf dep ./...
gf dep ./internal/...
gf dep -f list
gf dep -f mermaid
gf dep -f mermaid -g
gf dep -f dot -d 5
gf dep -f json -d 0
gf dep -g
gf dep -r
gf dep -i=false
gf dep -e
gf dep -e -i=false
gf dep -M
gf dep -M -D
gf dep -s
gf dep -s -p 8080
gf dep ./internal/... -f tree -d 2
gf dep --external --group -f mermaid
gf dep --module --direct -f json
`
)
func init() {
gtag.Sets(g.MapStrStr{
`cDepBrief`: cDepBrief,
`cDepEg`: cDepEg,
})
}
// Input defines the input parameters for dep command.
type Input struct {
g.Meta `name:"dep"`
Package string `name:"PACKAGE" arg:"true" brief:"package path to analyze, default is ./..." d:"./..."`
Format string `name:"format" short:"f" brief:"output format: tree/list/mermaid/dot/json" d:"tree"`
Depth int `name:"depth" short:"d" brief:"dependency depth limit, 0 means unlimited" d:"3"`
Group bool `name:"group" short:"g" brief:"group by top-level directory" d:"false" orphan:"true"`
Internal bool `name:"internal" short:"i" brief:"show only internal packages" d:"true" orphan:"true"`
External bool `name:"external" short:"e" brief:"show external packages" d:"false" orphan:"true"`
Module bool `name:"module" short:"M" brief:"show module-level dependencies (from go.mod)" d:"false" orphan:"true"`
Direct bool `name:"direct" short:"D" brief:"show only direct dependencies (requires --module)" d:"false" orphan:"true"`
NoStd bool `name:"nostd" short:"n" brief:"exclude standard library" d:"true" orphan:"true"`
Reverse bool `name:"reverse" short:"r" brief:"show reverse dependencies" d:"false" orphan:"true"`
Serve bool `name:"serve" short:"s" brief:"start HTTP server to view dependencies" d:"false" orphan:"true"`
Port int `name:"port" short:"p" brief:"HTTP server port" d:"8888"`
}
// Output defines the output for dep command.
type Output struct{}
// Index is the main entry point for the dep command.
func (c cDep) Index(ctx context.Context, in Input) (out *Output, err error) {
analyzer := newAnalyzer()
// Detect module prefix from go.mod
analyzer.modulePrefix = analyzer.detectModulePrefix()
// Module-level analysis mode (uses go mod graph)
if in.Module {
if in.Serve {
// Load module graph for server mode
if err := analyzer.loadModuleGraph(ctx); err != nil {
mlog.Print("Warning: Failed to load module graph: " + err.Error())
}
return nil, analyzer.startServer(in)
}
// Load module graph
if err := analyzer.loadModuleGraph(ctx); err != nil {
return nil, err
}
// Generate module-level output
output := analyzer.generateModuleOutput(in)
mlog.Print(output)
return
}
// Package-level analysis mode (original behavior)
loadErr := analyzer.loadPackages(ctx, in.Package)
// Start HTTP server if requested
// In server mode, allow starting even without local Go module
// because users may want to analyze remote modules
if in.Serve {
if loadErr != nil {
mlog.Print("Warning: No local Go module found, you can analyze remote modules in the web UI")
}
return nil, analyzer.startServer(in)
}
// For non-server mode, return error if loading failed
if loadErr != nil {
return nil, loadErr
}
if len(analyzer.packages) == 0 {
mlog.Print("No packages found")
return
}
// Generate output based on format
var output string
if in.Reverse {
output = analyzer.generateReverse(in)
} else {
output = analyzer.generate(in)
}
mlog.Print(output)
return
}

File diff suppressed because it is too large Load Diff

View File

@ -1,107 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmddep
import (
"testing"
"github.com/gogf/gf/v2/test/gtest"
)
func TestExternalDependencyAnalysis(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
analyzer := newAnalyzer()
analyzer.modulePrefix = "github.com/gogf/gf/cmd/gf/v2"
analyzer.packages = map[string]*goPackage{
"github.com/other/package": {
ImportPath: "github.com/other/package",
Standard: false,
},
"github.com/gogf/gf/cmd/gf/v2/internal": {
ImportPath: "github.com/gogf/gf/cmd/gf/v2/internal",
Standard: false,
},
"fmt": {
ImportPath: "fmt",
Standard: true,
},
}
// Test using new FilterOptions system
in := Input{
Internal: false,
External: true,
NoStd: true,
}
opts := analyzer.convertInputToFilterOptions(in)
opts.Normalize(analyzer.modulePrefix)
store := analyzer.buildPackageStore()
// Test external package (should be included)
externalPkg, ok := store.packages["github.com/other/package"]
t.Assert(ok, true)
t.Assert(opts.ShouldInclude(externalPkg), true)
// Test internal package (should not be included)
internalPkg, ok := store.packages["github.com/gogf/gf/cmd/gf/v2/internal"]
t.Assert(ok, true)
t.Assert(opts.ShouldInclude(internalPkg), false)
// Test standard library (should not be included due to NoStd)
stdPkg, ok := store.packages["fmt"]
t.Assert(ok, true)
t.Assert(opts.ShouldInclude(stdPkg), false)
})
}
func TestExternalGrouping(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
analyzer := newAnalyzer()
// Test external group extraction using shortName
t.Assert(analyzer.shortName("github.com/user/repo", false), "github.com/user/repo")
t.Assert(analyzer.shortName("golang.org/x/tools", false), "golang.org/x/tools")
t.Assert(analyzer.shortName("fmt", false), "fmt")
t.Assert(analyzer.shortName("simple", false), "simple")
})
}
func TestDependencyStats(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
analyzer := newAnalyzer()
analyzer.modulePrefix = "github.com/gogf/gf/cmd/gf/v2"
// Add test packages
analyzer.packages = map[string]*goPackage{
"github.com/gogf/gf/cmd/gf/v2/internal": {
ImportPath: "github.com/gogf/gf/cmd/gf/v2/internal",
Standard: false,
},
"github.com/external/package": {
ImportPath: "github.com/external/package",
Standard: false,
},
"fmt": {
ImportPath: "fmt",
Standard: true,
},
}
in := Input{
Internal: true,
External: true,
NoStd: false,
}
stats := analyzer.getDependencyStats(in)
t.Assert(stats["total"], 3)
t.Assert(stats["internal"], 1)
t.Assert(stats["external"], 1)
t.Assert(stats["stdlib"], 1)
})
}

View File

@ -1,403 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmddep
import (
"encoding/json"
"fmt"
"sort"
"strings"
)
// generate creates output based on format.
func (a *analyzer) generate(in Input) string {
switch in.Format {
case "tree":
return a.generateTree(in)
case "list":
return a.generateList(in)
case "mermaid":
return a.generateMermaid(in)
case "dot":
return a.generateDot(in)
case "json":
return a.generateJSON(in)
default:
// Default to tree format
return a.generateTree(in)
}
}
// generateTree generates ASCII tree output using new traversal system.
func (a *analyzer) generateTree(in Input) string {
var sb strings.Builder
// Prepare options
opts := a.convertInputToFilterOptions(in)
opts.Normalize(a.modulePrefix)
// Add statistics header if showing external dependencies
if in.External {
stats := a.getDependencyStats(in)
sb.WriteString("Dependency Statistics:\n")
fmt.Fprintf(&sb, " Total packages: %v\n", stats["total"])
fmt.Fprintf(&sb, " Internal: %v\n", stats["internal"])
fmt.Fprintf(&sb, " External: %v\n", stats["external"])
fmt.Fprintf(&sb, " Standard library: %v\n", stats["stdlib"])
if groups, ok := stats["external_groups"].(map[string]int); ok && len(groups) > 0 {
sb.WriteString(" External groups:\n")
for group, count := range groups {
fmt.Fprintf(&sb, " %s: %d\n", group, count)
}
}
sb.WriteString("\nDependency Tree:\n")
}
// Build package store
store := a.buildPackageStore()
// Find root packages (packages that are not imported by any other package)
rootPkgs := a.findRootPackages()
// Create traversal context
ctx := &TraversalContext{
visited: make(map[string]bool),
options: opts,
store: store,
maxDepth: opts.Depth,
}
for _, pkgPath := range rootPkgs {
pkgInfo, ok := store.packages[pkgPath]
if !ok || !opts.ShouldInclude(pkgInfo) {
continue
}
shortName := a.shortName(pkgPath, in.Group)
sb.WriteString(shortName + "\n")
// Use new traversal system
a.printTreeNodeNew(&sb, pkgPath, "", in, ctx, 0)
}
return sb.String()
}
// findRootPackages finds packages that are not imported by any other internal package.
func (a *analyzer) findRootPackages() []string {
// Build a set of all imported packages
imported := make(map[string]bool)
for _, pkg := range a.packages {
for _, dep := range pkg.Imports {
imported[dep] = true
}
}
// Find packages that are not imported by others
roots := make([]string, 0)
for pkgPath := range a.packages {
if !imported[pkgPath] {
roots = append(roots, pkgPath)
}
}
// If no roots found (circular dependencies), use all packages
if len(roots) == 0 {
roots = a.getSortedPackages()
}
sort.Strings(roots)
return roots
}
// printTreeNodeNew prints tree node using new traversal system.
func (a *analyzer) printTreeNodeNew(sb *strings.Builder, pkgPath string, prefix string, in Input, ctx *TraversalContext, depth int) {
if ctx.maxDepth > 0 && depth >= ctx.maxDepth {
return
}
_, ok := ctx.store.packages[pkgPath]
if !ok {
return
}
// Get filtered dependencies
deps := ctx.GetDependencies(pkgPath)
sort.Strings(deps)
for i, dep := range deps {
// Check if already visited
if ctx.Visit(dep) {
continue
}
isLast := i == len(deps)-1
connector := "├── "
if isLast {
connector = "└── "
}
shortName := a.shortName(dep, in.Group)
sb.WriteString(prefix + connector + shortName + "\n")
newPrefix := prefix
if isLast {
newPrefix += " "
} else {
newPrefix += "│ "
}
// Recursively print dependencies
ctx.depth++
a.printTreeNodeNew(sb, dep, newPrefix, in, ctx, depth+1)
ctx.depth--
}
}
// generateList generates simple list output using new traversal system.
func (a *analyzer) generateList(in Input) string {
var sb strings.Builder
// Prepare options
opts := a.convertInputToFilterOptions(in)
opts.Normalize(a.modulePrefix)
// Add statistics header if showing external dependencies
if in.External {
stats := a.getDependencyStats(in)
sb.WriteString("# Dependency Statistics\n")
fmt.Fprintf(&sb, "# Total: %v, Internal: %v, External: %v, Stdlib: %v\n",
stats["total"], stats["internal"], stats["external"], stats["stdlib"])
sb.WriteString("\n")
}
// Build package store
store := a.buildPackageStore()
allDeps := make(map[string]bool)
// Collect dependencies from packages that should be included
for pkgPath, pkgInfo := range store.packages {
if !opts.ShouldInclude(pkgInfo) {
continue
}
// Get filtered dependencies for this package
for _, dep := range store.packages[pkgPath].Imports {
depInfo, ok := store.packages[dep]
if ok && opts.ShouldInclude(depInfo) {
allDeps[dep] = true
}
}
}
deps := make([]string, 0, len(allDeps))
for dep := range allDeps {
deps = append(deps, a.shortName(dep, in.Group))
}
sort.Strings(deps)
for _, dep := range deps {
sb.WriteString(dep + "\n")
}
return sb.String()
}
// generateMermaid generates Mermaid diagram output.
func (a *analyzer) generateMermaid(in Input) string {
var sb strings.Builder
sb.WriteString("```mermaid\n")
sb.WriteString("graph TD\n")
edges := a.collectEdges(in)
sortedEdges := make([]string, 0, len(edges))
for edge := range edges {
sortedEdges = append(sortedEdges, edge)
}
sort.Strings(sortedEdges)
for _, edge := range sortedEdges {
sb.WriteString(" " + edge + "\n")
}
sb.WriteString("```\n")
return sb.String()
}
// generateMermaidRaw generates Mermaid code without markdown wrapper.
func (a *analyzer) generateMermaidRaw(in Input) string {
var sb strings.Builder
sb.WriteString("graph TD\n")
edges := a.collectEdges(in)
sortedEdges := make([]string, 0, len(edges))
for edge := range edges {
sortedEdges = append(sortedEdges, edge)
}
sort.Strings(sortedEdges)
for _, edge := range sortedEdges {
sb.WriteString(" " + edge + "\n")
}
return sb.String()
}
// generateDot generates Graphviz DOT output.
func (a *analyzer) generateDot(in Input) string {
var sb strings.Builder
sb.WriteString("digraph deps {\n")
sb.WriteString(" rankdir=TB;\n")
sb.WriteString(" node [shape=box];\n")
edges := a.collectEdges(in)
sortedEdges := make([]string, 0, len(edges))
for edge := range edges {
sortedEdges = append(sortedEdges, edge)
}
sort.Strings(sortedEdges)
for _, edge := range sortedEdges {
parts := strings.Split(edge, " --> ")
if len(parts) == 2 {
fmt.Fprintf(&sb, " \"%s\" -> \"%s\";\n", parts[0], parts[1])
}
}
sb.WriteString("}\n")
return sb.String()
}
// generateJSON generates JSON output using new traversal system.
func (a *analyzer) generateJSON(in Input) string {
opts := a.convertInputToFilterOptions(in)
opts.Normalize(a.modulePrefix)
store := a.buildPackageStore()
result := make(map[string]any)
// Add dependency nodes
nodes := make([]*depNode, 0)
for _, pkgPath := range a.getSortedPackages() {
pkgInfo, ok := store.packages[pkgPath]
if !ok || !opts.ShouldInclude(pkgInfo) {
continue
}
pkg := a.packages[pkgPath]
a.visited = make(map[string]bool)
node := a.buildDepNode(pkg, in, 0)
nodes = append(nodes, node)
}
result["dependencies"] = nodes
// Add statistics
result["statistics"] = a.getDependencyStats(in)
// Add metadata
result["metadata"] = map[string]any{
"module": a.modulePrefix,
"format": in.Format,
"depth": in.Depth,
"group": in.Group,
"internal": in.Internal,
"external": in.External,
"nostd": in.NoStd,
}
data, err := json.MarshalIndent(result, "", " ")
if err != nil {
return fmt.Sprintf("Error: %v", err)
}
return string(data)
}
func (a *analyzer) buildDepNode(pkg *goPackage, in Input, depth int) *depNode {
opts := a.convertInputToFilterOptions(in)
opts.Normalize(a.modulePrefix)
store := a.buildPackageStore()
node := &depNode{
Package: a.shortName(pkg.ImportPath, in.Group),
}
if in.Depth > 0 && depth >= in.Depth {
return node
}
pkgInfo, ok := store.packages[pkg.ImportPath]
if !ok {
return node
}
// Track visited packages to avoid cycles
if !a.visited[pkg.ImportPath] {
a.visited[pkg.ImportPath] = true
for _, dep := range pkgInfo.Imports {
depInfo, ok := store.packages[dep]
if !ok || !opts.ShouldInclude(depInfo) {
continue
}
if depPkg, ok := a.packages[dep]; ok {
childNode := a.buildDepNode(depPkg, in, depth+1)
node.Dependencies = append(node.Dependencies, childNode)
} else {
node.Dependencies = append(node.Dependencies, &depNode{
Package: a.shortName(dep, in.Group),
})
}
}
}
return node
}
// generateReverse generates reverse dependency output using new system.
func (a *analyzer) generateReverse(in Input) string {
opts := a.convertInputToFilterOptions(in)
opts.Normalize(a.modulePrefix)
store := a.buildPackageStore()
// Build reverse dependency map
reverseDeps := make(map[string][]string)
for pkgPath, pkgInfo := range store.packages {
for _, dep := range pkgInfo.Imports {
depInfo, ok := store.packages[dep]
if ok && opts.ShouldInclude(depInfo) {
reverseDeps[dep] = append(reverseDeps[dep], pkgPath)
}
}
}
var sb strings.Builder
targets := a.getSortedPackages()
for _, target := range targets {
deps := reverseDeps[target]
if len(deps) == 0 {
continue
}
sort.Strings(deps)
shortTarget := a.shortName(target, in.Group)
if shortTarget == "" {
continue
}
fmt.Fprintf(&sb, "%s (used by %d packages):\n", shortTarget, len(deps))
for i, dep := range deps {
isLast := i == len(deps)-1
connector := "├── "
if isLast {
connector = "└── "
}
sb.WriteString(connector + a.shortName(dep, in.Group) + "\n")
}
sb.WriteString("\n")
}
return sb.String()
}

File diff suppressed because it is too large Load Diff

View File

@ -1,255 +0,0 @@
// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package cmddep
import (
"testing"
"github.com/gogf/gf/v2/os/gctx"
"github.com/gogf/gf/v2/test/gtest"
)
// Test data model creation and classification
func Test_PackageInfo_Creation(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
pkg := &PackageInfo{
ImportPath: "github.com/gogf/gf/v2/os/gfile",
ModulePath: "github.com/gogf/gf/v2",
Kind: KindInternal,
Tier: 2,
Imports: []string{"fmt", "os"},
IsStdLib: false,
IsModuleRoot: false,
}
t.Assert(pkg != nil, true)
t.Assert(pkg.Kind, KindInternal)
t.Assert(pkg.Tier, 2)
t.Assert(len(pkg.Imports), 2)
})
}
// Test FilterOptions normalization
func Test_FilterOptions_Normalize(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
opts := &FilterOptions{
IncludeInternal: false,
IncludeExternal: false,
IncludeStdLib: false,
}
opts.Normalize("github.com/gogf/gf/v2")
// After normalization, internal should be included by default
t.Assert(opts.IncludeInternal, true)
t.Assert(opts.IncludeExternal, false)
})
}
// Test ShouldInclude decision logic
func Test_FilterOptions_ShouldInclude(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
// Test internal package inclusion
opts := &FilterOptions{
IncludeInternal: true,
IncludeExternal: false,
IncludeStdLib: true,
}
internalPkg := &PackageInfo{
Kind: KindInternal,
IsStdLib: false,
}
externalPkg := &PackageInfo{
Kind: KindExternal,
IsStdLib: false,
}
stdlibPkg := &PackageInfo{
Kind: KindStdLib,
IsStdLib: true,
}
t.Assert(opts.ShouldInclude(internalPkg), true)
t.Assert(opts.ShouldInclude(externalPkg), false)
t.Assert(opts.ShouldInclude(stdlibPkg), true)
})
}
// Test TraversalContext Visit tracking
func Test_TraversalContext_Visit(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := &TraversalContext{
visited: make(map[string]bool),
}
// First visit should return false
t.Assert(ctx.Visit("pkg1"), false)
// Second visit should return true
t.Assert(ctx.Visit("pkg1"), true)
// New package should return false
t.Assert(ctx.Visit("pkg2"), false)
})
}
// Test guessModuleRoot function
func Test_GuessModuleRoot(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
tests := []struct {
input string
expect string
}{
{"github.com/gogf/gf", "github.com/gogf/gf"},
{"github.com/gogf/gf/v2", "github.com/gogf/gf/v2"},
{"github.com/gogf/gf/v2/os/gfile", "github.com/gogf/gf/v2"},
{"github.com/gogf/gf/v2/os", "github.com/gogf/gf/v2"},
}
for _, test := range tests {
result := guessModuleRoot(test.input)
t.AssertEQ(result, test.expect)
}
})
}
// Test input to filter options conversion
func Test_ConvertInputToFilterOptions(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
a := newAnalyzer()
input := Input{
Internal: true,
External: false,
NoStd: true,
Module: false,
Direct: false,
Depth: 3,
}
opts := a.convertInputToFilterOptions(input)
t.Assert(opts.IncludeInternal, true)
t.Assert(opts.IncludeExternal, false)
t.Assert(opts.IncludeStdLib, false) // NoStd=true means !IncludeStdLib
t.Assert(opts.Depth, 3)
})
}
func Test_Dep_Tree(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "tree",
Depth: 1,
Internal: true,
NoStd: true,
})
t.AssertNil(err)
})
}
func Test_Dep_List(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "list",
Depth: 1,
Internal: true,
NoStd: true,
})
t.AssertNil(err)
})
}
func Test_Dep_Mermaid(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "mermaid",
Depth: 1,
Internal: true,
NoStd: true,
})
t.AssertNil(err)
})
}
func Test_Dep_Dot(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "dot",
Depth: 1,
Internal: true,
NoStd: true,
})
t.AssertNil(err)
})
}
func Test_Dep_JSON(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "json",
Depth: 1,
Internal: true,
NoStd: true,
})
t.AssertNil(err)
})
}
func Test_Dep_Reverse(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "tree",
Depth: 1,
Internal: true,
NoStd: true,
Reverse: true,
})
t.AssertNil(err)
})
}
func Test_Dep_Group(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
_, err := Dep.Index(ctx, Input{
Package: "./",
Format: "mermaid",
Depth: 1,
Internal: true,
NoStd: true,
Group: true,
})
t.AssertNil(err)
})
}
func Test_ModuleLevel_Direct(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
ctx := gctx.New()
// Test module level with direct only
in := Input{
Module: true,
Direct: true,
Format: "list",
}
t.Logf("Input.Module: %v, Input.Direct: %v", in.Module, in.Direct)
_, err := Dep.Index(ctx, in)
t.AssertNil(err)
})
}

View File

@ -1,946 +0,0 @@
// Main Application Module
let currentZoom = 1;
let currentView = 'graph';
let currentLayout = 'TD';
let selectedPackage = null;
let allPackages = [];
let isRemoteMode = false;
let currentRemoteModule = '';
let packageListMode = 'tree'; // 'flat' or 'tree'
let expandedNodes = new Set(); // Track expanded tree nodes
// Pan and Zoom state
let panX = 0;
let panY = 0;
let isPanning = false;
let startPanX = 0;
let startPanY = 0;
let zoomIndicatorTimeout = null;
const MIN_ZOOM = 0.1;
const MAX_ZOOM = 10;
const ZOOM_STEP = 0.1;
// Theme Management
const theme = {
current: 'light',
init() {
const savedTheme = localStorage.getItem('dep-viewer-theme');
if (savedTheme) {
this.current = savedTheme;
} else {
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
this.current = 'dark';
}
}
this.apply();
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', (e) => {
if (!localStorage.getItem('dep-viewer-theme')) {
this.current = e.matches ? 'dark' : 'light';
this.apply();
}
});
const toggleBtn = document.getElementById('themeToggle');
if (toggleBtn) {
toggleBtn.addEventListener('click', () => this.toggle());
}
},
toggle() {
this.current = this.current === 'dark' ? 'light' : 'dark';
localStorage.setItem('dep-viewer-theme', this.current);
this.apply();
},
apply() {
if (this.current === 'dark') {
document.body.setAttribute('data-theme', 'dark');
} else {
document.body.removeAttribute('data-theme');
}
mermaid.initialize({
startOnLoad: false,
theme: this.current === 'dark' ? 'dark' : 'default',
maxEdges: 2000, // Increase edge limit for large dependency graphs
flowchart: {
useMaxWidth: false,
htmlLabels: true,
curve: 'basis'
}
});
if (currentView === 'graph') {
refresh();
}
}
};
// Initialize mermaid
mermaid.initialize({
startOnLoad: false,
theme: 'default',
maxEdges: 2000, // Increase edge limit for large dependency graphs
flowchart: {
useMaxWidth: false,
htmlLabels: true,
curve: 'basis'
}
});
// Initialize application
async function init() {
theme.init();
initPanZoom();
initRemoteModuleInput();
const hasLocalModule = await loadModuleName();
if (hasLocalModule) {
await loadPackages();
await refresh();
}
}
// Initialize remote module input
function initRemoteModuleInput() {
const input = document.getElementById('remoteModuleInput');
if (input) {
// Fetch versions when input loses focus or Enter is pressed
input.addEventListener('blur', fetchVersions);
input.addEventListener('keypress', (e) => {
if (e.key === 'Enter') {
fetchVersions();
}
});
}
}
// Fetch versions for a module from Go proxy
async function fetchVersions() {
const input = document.getElementById('remoteModuleInput');
const versionSelect = document.getElementById('versionSelect');
const spinner = document.getElementById('loadingSpinner');
let modulePath = input.value.trim();
// Remove http:// or https:// prefix if present
modulePath = modulePath.replace(/^https?:\/\//, '');
input.value = modulePath;
if (!modulePath) {
versionSelect.disabled = true;
versionSelect.innerHTML = `<option value="">${i18n.t('selectVersion')}</option>`;
return;
}
spinner.classList.remove('hidden');
versionSelect.disabled = true;
try {
const response = await fetch('/api/versions?module=' + encodeURIComponent(modulePath));
const data = await response.json();
if (data.error) {
versionSelect.innerHTML = `<option value="">${i18n.t('errorFetchVersions')}</option>`;
} else if (data.versions && data.versions.length > 0) {
versionSelect.innerHTML = data.versions.map((v, i) => {
const label = i === 0 ? `${v} (${i18n.t('latestVersion')})` : v;
return `<option value="${v}">${label}</option>`;
}).join('');
versionSelect.disabled = false;
} else {
versionSelect.innerHTML = `<option value="">${i18n.t('noVersions')}</option>`;
}
} catch (e) {
console.error('Failed to fetch versions:', e);
versionSelect.innerHTML = `<option value="">${i18n.t('errorFetchVersions')}</option>`;
} finally {
spinner.classList.add('hidden');
}
}
// Analyze remote module
async function analyzeRemoteModule() {
const input = document.getElementById('remoteModuleInput');
const versionSelect = document.getElementById('versionSelect');
const spinner = document.getElementById('loadingSpinner');
const analyzeBtn = document.getElementById('analyzeBtn');
let modulePath = input.value.trim();
// Remove http:// or https:// prefix if present
modulePath = modulePath.replace(/^https?:\/\//, '');
input.value = modulePath;
const version = versionSelect.value;
if (!modulePath) {
alert('Please enter a module path');
return;
}
spinner.classList.remove('hidden');
analyzeBtn.disabled = true;
analyzeBtn.textContent = i18n.t('analyzing');
try {
const url = `/api/analyze?module=${encodeURIComponent(modulePath)}${version ? '&version=' + encodeURIComponent(version) : ''}`;
const response = await fetch(url);
const data = await response.json();
if (data.error) {
alert(data.error);
return;
}
// Switch to remote mode
isRemoteMode = true;
currentRemoteModule = modulePath + (version ? '@' + version : '');
document.getElementById('moduleName').textContent = currentRemoteModule;
// Clear selection and reload
selectedPackage = null;
await loadPackages();
await refresh();
} catch (e) {
console.error('Failed to analyze module:', e);
alert(i18n.t('errorAnalyze'));
} finally {
spinner.classList.add('hidden');
analyzeBtn.disabled = false;
analyzeBtn.textContent = i18n.t('analyze');
}
}
// Reset to local module
async function resetToLocal() {
const spinner = document.getElementById('loadingSpinner');
spinner.classList.remove('hidden');
try {
await fetch('/api/reset');
isRemoteMode = false;
currentRemoteModule = '';
document.getElementById('remoteModuleInput').value = '';
document.getElementById('versionSelect').innerHTML = `<option value="">${i18n.t('selectVersion')}</option>`;
document.getElementById('versionSelect').disabled = true;
selectedPackage = null;
await loadModuleName();
await loadPackages();
await refresh();
} catch (e) {
console.error('Failed to reset:', e);
} finally {
spinner.classList.add('hidden');
}
}
// Initialize pan and zoom functionality
function initPanZoom() {
const viewport = document.getElementById('graphView');
if (!viewport) return;
// Mouse wheel zoom
viewport.addEventListener('wheel', (e) => {
if (currentView !== 'graph') return;
e.preventDefault();
const rect = viewport.getBoundingClientRect();
const mouseX = e.clientX - rect.left;
const mouseY = e.clientY - rect.top;
// Calculate zoom
const delta = e.deltaY > 0 ? -ZOOM_STEP : ZOOM_STEP;
const newZoom = Math.min(MAX_ZOOM, Math.max(MIN_ZOOM, currentZoom + delta * currentZoom));
if (newZoom !== currentZoom) {
// Zoom towards mouse position
const scale = newZoom / currentZoom;
panX = mouseX - (mouseX - panX) * scale;
panY = mouseY - (mouseY - panY) * scale;
currentZoom = newZoom;
applyTransform();
showZoomIndicator();
}
}, { passive: false });
// Pan with mouse drag
viewport.addEventListener('mousedown', (e) => {
if (currentView !== 'graph') return;
if (e.button !== 0) return; // Only left click
isPanning = true;
startPanX = e.clientX - panX;
startPanY = e.clientY - panY;
viewport.style.cursor = 'grabbing';
});
document.addEventListener('mousemove', (e) => {
if (!isPanning) return;
panX = e.clientX - startPanX;
panY = e.clientY - startPanY;
applyTransform();
});
document.addEventListener('mouseup', () => {
if (isPanning) {
isPanning = false;
const viewport = document.getElementById('graphViewport');
if (viewport) viewport.style.cursor = 'grab';
}
});
// Touch support for mobile
let lastTouchDistance = 0;
let lastTouchCenter = { x: 0, y: 0 };
viewport.addEventListener('touchstart', (e) => {
if (currentView !== 'graph') return;
if (e.touches.length === 1) {
isPanning = true;
startPanX = e.touches[0].clientX - panX;
startPanY = e.touches[0].clientY - panY;
} else if (e.touches.length === 2) {
isPanning = false;
lastTouchDistance = getTouchDistance(e.touches);
lastTouchCenter = getTouchCenter(e.touches);
}
}, { passive: true });
viewport.addEventListener('touchmove', (e) => {
if (currentView !== 'graph') return;
e.preventDefault();
if (e.touches.length === 1 && isPanning) {
panX = e.touches[0].clientX - startPanX;
panY = e.touches[0].clientY - startPanY;
applyTransform();
} else if (e.touches.length === 2) {
const distance = getTouchDistance(e.touches);
const center = getTouchCenter(e.touches);
if (lastTouchDistance > 0) {
const scale = distance / lastTouchDistance;
const newZoom = Math.min(MAX_ZOOM, Math.max(MIN_ZOOM, currentZoom * scale));
if (newZoom !== currentZoom) {
const rect = viewport.getBoundingClientRect();
const centerX = center.x - rect.left;
const centerY = center.y - rect.top;
const zoomScale = newZoom / currentZoom;
panX = centerX - (centerX - panX) * zoomScale;
panY = centerY - (centerY - panY) * zoomScale;
currentZoom = newZoom;
applyTransform();
showZoomIndicator();
}
}
lastTouchDistance = distance;
lastTouchCenter = center;
}
}, { passive: false });
viewport.addEventListener('touchend', () => {
isPanning = false;
lastTouchDistance = 0;
});
}
function getTouchDistance(touches) {
const dx = touches[0].clientX - touches[1].clientX;
const dy = touches[0].clientY - touches[1].clientY;
return Math.sqrt(dx * dx + dy * dy);
}
function getTouchCenter(touches) {
return {
x: (touches[0].clientX + touches[1].clientX) / 2,
y: (touches[0].clientY + touches[1].clientY) / 2
};
}
function applyTransform() {
const container = document.getElementById('mermaidContainer');
if (container) {
container.style.transform = `translate(${panX}px, ${panY}px) scale(${currentZoom})`;
}
}
function showZoomIndicator() {
const indicator = document.getElementById('zoomIndicator');
if (indicator) {
indicator.textContent = `${Math.round(currentZoom * 100)}%`;
indicator.classList.add('visible');
if (zoomIndicatorTimeout) {
clearTimeout(zoomIndicatorTimeout);
}
zoomIndicatorTimeout = setTimeout(() => {
indicator.classList.remove('visible');
}, 1500);
}
}
// Load module name from server
// Returns true if local module exists, false otherwise
async function loadModuleName() {
try {
const response = await fetch('/api/module');
const data = await response.json();
document.getElementById('moduleName').textContent = data.name || '';
// If no local module, set default value and auto-analyze
if (!data.name) {
const input = document.getElementById('remoteModuleInput');
if (input && !input.value) {
input.value = 'github.com/gogf/gf/v2';
// Fetch versions first, then auto-analyze
await fetchVersions();
analyzeRemoteModule();
}
return false;
}
return true;
} catch (e) {
console.error('Failed to load module name:', e);
return false;
}
}
// Load packages list
async function loadPackages() {
try {
const internal = document.getElementById('internal').checked;
const external = document.getElementById('external') ? document.getElementById('external').checked : false;
const moduleLevel = document.getElementById('moduleLevel') ? document.getElementById('moduleLevel').checked : false;
const directOnly = document.getElementById('directOnly') ? document.getElementById('directOnly').checked : false;
const response = await fetch(`/api/packages?internal=${internal}&external=${external}&module=${moduleLevel}&direct=${directOnly}`);
const data = await response.json();
// Handle new API response format with packages and statistics
if (data.packages && Array.isArray(data.packages)) {
allPackages = data.packages;
// Update statistics display if available
if (data.statistics) {
updateStatisticsDisplay(data.statistics);
}
} else if (Array.isArray(data)) {
// Fallback for old format
allPackages = data;
} else {
console.error('Unexpected API response format:', data);
allPackages = [];
}
document.getElementById('packageCount').textContent = allPackages.length;
renderPackageList(allPackages);
} catch (e) {
console.error('Failed to load packages:', e);
}
}
// Update statistics display
function updateStatisticsDisplay(statistics) {
if (statistics) {
document.getElementById('internalCount').textContent = statistics.internal || 0;
document.getElementById('externalCount').textContent = statistics.external || 0;
document.getElementById('stdlibCount').textContent = statistics.stdlib || 0;
// Update total count
const totalCount = statistics.total || (statistics.internal + statistics.external + statistics.stdlib);
document.getElementById('nodeCount').textContent = totalCount;
}
}
// Get package name from package object or string
function getPkgName(pkg) {
return typeof pkg === 'object' ? pkg.name : pkg;
}
// Set package list display mode
function setPackageListMode(mode) {
packageListMode = mode;
document.getElementById('modeFlat').classList.toggle('active', mode === 'flat');
document.getElementById('modeTree').classList.toggle('active', mode === 'tree');
const query = document.getElementById('searchInput').value.toLowerCase();
const filtered = query ? allPackages.filter(pkg => getPkgName(pkg).toLowerCase().includes(query)) : allPackages;
renderPackageList(filtered);
}
// Render package list in sidebar
function renderPackageList(packages) {
const list = document.getElementById('packageList');
if (packages.length === 0) {
list.innerHTML = '<div class="loading">' + i18n.t('noPackages') + '</div>';
return;
}
if (packageListMode === 'tree') {
renderPackageTree(packages, list);
} else {
renderPackageFlat(packages, list);
}
}
// Render flat package list
function renderPackageFlat(packages, container) {
container.innerHTML = packages.map(pkg => {
const name = getPkgName(pkg);
const isActive = name === selectedPackage ? ' active' : '';
const escaped = name.replace(/'/g, "\\'");
// Build stats display
let statsHtml = '';
if (typeof pkg === 'object') {
statsHtml = `<span class="pkg-stats-inline">
<span class="dep-count" title="${i18n.t('dependencies')}">→${pkg.depCount}</span>
<span class="used-count" title="${i18n.t('usedBy')}">←${pkg.usedByCount}</span>
</span>`;
}
return `<div class="package-item${isActive}" onclick="selectPackage('${escaped}')" title="${name}">
<span class="pkg-name-text">${name}</span>${statsHtml}
</div>`;
}).join('');
}
// Build tree structure from package paths
function buildPackageTree(packages) {
const root = { children: {}, packages: [] };
packages.forEach(pkg => {
const name = getPkgName(pkg);
const parts = name.split('/');
let current = root;
parts.forEach((part, index) => {
if (!current.children[part]) {
current.children[part] = { children: {}, packages: [], path: parts.slice(0, index + 1).join('/') };
}
current = current.children[part];
});
current.isPackage = true;
current.fullPath = name;
// Store stats if available
if (typeof pkg === 'object') {
current.depCount = pkg.depCount;
current.usedByCount = pkg.usedByCount;
}
});
return root;
}
// Render package tree
function renderPackageTree(packages, container) {
const tree = buildPackageTree(packages);
container.innerHTML = renderTreeNode(tree, '');
}
// Render a tree node recursively
function renderTreeNode(node, path) {
const children = Object.keys(node.children).sort();
if (children.length === 0) return '';
return children.map(name => {
const child = node.children[name];
const childPath = path ? `${path}/${name}` : name;
const hasChildren = Object.keys(child.children).length > 0;
const isExpanded = expandedNodes.has(childPath);
const isActive = child.fullPath === selectedPackage;
const isPackage = child.isPackage;
const toggleClass = hasChildren ? (isExpanded ? 'expanded' : '') : 'empty';
const activeClass = isActive ? ' active' : '';
const nameClass = isPackage ? ' package' : '';
const icon = isPackage ? '📦' : '📁';
// Build stats for packages
let statsHtml = '';
if (isPackage && child.depCount !== undefined) {
statsHtml = `<span class="pkg-stats-inline">
<span class="dep-count" title="${i18n.t('dependencies')}">→${child.depCount}</span>
<span class="used-count" title="${i18n.t('usedBy')}">←${child.usedByCount}</span>
</span>`;
}
let html = `
<div class="tree-node" data-path="${childPath}">
<div class="tree-node-header${activeClass}">
<span class="tree-node-toggle ${toggleClass}" onclick="handleToggleClick(event, '${childPath.replace(/'/g, "\\'")}', ${hasChildren})">▶</span>
<span class="tree-node-icon">${icon}</span>
<span class="tree-node-name${nameClass}" onclick="handleNameClick(event, '${childPath.replace(/'/g, "\\'")}', ${isPackage}, ${hasChildren})">${name}</span>
${statsHtml}
</div>`;
if (hasChildren) {
const childrenHtml = renderTreeNode(child, childPath);
html += `<div class="tree-node-children${isExpanded ? ' expanded' : ''}">${childrenHtml}</div>`;
}
html += '</div>';
return html;
}).join('');
}
// Handle toggle arrow click - expand/collapse
function handleToggleClick(event, path, hasChildren) {
event.stopPropagation();
if (hasChildren) {
toggleTreeNode(path);
}
}
// Handle name click - select package or toggle if folder
function handleNameClick(event, path, isPackage, hasChildren) {
event.stopPropagation();
if (isPackage) {
selectPackage(path);
} else if (hasChildren) {
toggleTreeNode(path);
}
}
// Toggle tree node expansion
function toggleTreeNode(path) {
if (expandedNodes.has(path)) {
expandedNodes.delete(path);
} else {
expandedNodes.add(path);
}
// Re-render with current filter
const query = document.getElementById('searchInput').value.toLowerCase();
const filtered = query ? allPackages.filter(pkg => getPkgName(pkg).toLowerCase().includes(query)) : allPackages;
renderPackageList(filtered);
}
// Filter packages by search query
function filterPackages() {
const query = document.getElementById('searchInput').value.toLowerCase();
const filtered = allPackages.filter(pkg => getPkgName(pkg).toLowerCase().includes(query));
renderPackageList(filtered);
}
// Select a package
async function selectPackage(pkg) {
selectedPackage = pkg;
// Update flat list items
document.querySelectorAll('.package-item').forEach(el => {
el.classList.toggle('active', el.textContent === pkg);
});
// Update tree items
document.querySelectorAll('.tree-node-header').forEach(el => {
const node = el.closest('.tree-node');
el.classList.toggle('active', node && node.dataset.path === pkg);
});
await refresh();
}
// Clear package selection
function clearSelection() {
selectedPackage = null;
document.querySelectorAll('.package-item').forEach(el => el.classList.remove('active'));
document.querySelectorAll('.tree-node-header').forEach(el => el.classList.remove('active'));
closePackageInfo();
refresh();
}
// Close package info sidebar
function closePackageInfo() {
document.getElementById('packageInfo').classList.remove('visible');
}
// Set layout direction
function setLayout(layout) {
currentLayout = layout;
document.getElementById('layoutTD').classList.toggle('active', layout === 'TD');
document.getElementById('layoutLR').classList.toggle('active', layout === 'LR');
refresh();
}
// Set view mode
function setView(view) {
currentView = view;
document.getElementById('btnGraph').classList.toggle('active', view === 'graph');
document.getElementById('btnTree').classList.toggle('active', view === 'tree');
document.getElementById('btnList').classList.toggle('active', view === 'list');
document.getElementById('zoomControls').classList.toggle('hidden', view !== 'graph');
document.getElementById('layoutGroup').classList.toggle('hidden', view !== 'graph');
refresh();
}
// Main refresh function
async function refresh() {
const depth = document.getElementById('depth').value;
const group = document.getElementById('group').checked;
const reverse = document.getElementById('reverse').checked;
const internal = document.getElementById('internal').checked;
const external = document.getElementById('external') ? document.getElementById('external').checked : false;
const moduleLevel = document.getElementById('moduleLevel') ? document.getElementById('moduleLevel').checked : false;
const directOnly = document.getElementById('directOnly') ? document.getElementById('directOnly').checked : false;
if (selectedPackage) {
await showPackageInfo(selectedPackage);
} else {
closePackageInfo();
}
if (currentView === 'graph') {
await refreshGraph(depth, group, reverse, internal, external, moduleLevel, directOnly);
} else if (currentView === 'tree') {
await refreshTree(depth, internal, external, moduleLevel, directOnly);
} else {
await refreshList(internal, external, moduleLevel, directOnly);
}
}
// Show package info panel
async function showPackageInfo(pkg) {
try {
const response = await fetch('/api/package?name=' + encodeURIComponent(pkg));
const info = await response.json();
const infoDiv = document.getElementById('packageInfo');
const contentDiv = document.getElementById('packageInfoContent');
infoDiv.classList.add('visible');
contentDiv.innerHTML = `
<span class="pkg-name" title="${info.name}">${info.name}</span>
<div class="pkg-stats">
<div class="pkg-stat">
<span class="pkg-stat-label">${i18n.t('dependencies')}:</span>
<span class="pkg-stat-value">${info.dependencies.length}</span>
</div>
<div class="pkg-stat">
<span class="pkg-stat-label">${i18n.t('usedBy')}:</span>
<span class="pkg-stat-value">${info.usedBy.length}</span>
</div>
</div>
`;
} catch (e) {
console.error('Failed to load package info:', e);
}
}
// Refresh graph view
async function refreshGraph(depth, group, reverse, internal, external, moduleLevel, directOnly) {
document.getElementById('graphView').classList.remove('hidden');
document.getElementById('textView').classList.add('hidden');
// Reset pan/zoom on refresh
currentZoom = 1;
panX = 0;
panY = 0;
applyTransform();
let url = `/api/graph?depth=${depth}&group=${group}&reverse=${reverse}&internal=${internal}`;
if (external !== undefined) {
url += `&external=${external}`;
}
if (moduleLevel !== undefined) {
url += `&module=${moduleLevel}`;
}
if (directOnly !== undefined) {
url += `&direct=${directOnly}`;
}
if (selectedPackage) {
url += '&package=' + encodeURIComponent(selectedPackage);
}
try {
const response = await fetch(url);
const data = await response.json();
document.getElementById('nodeCount').textContent = data.nodes.length;
document.getElementById('edgeCount').textContent = data.edges.length;
// Generate mermaid code
// Build node id to label map
const nodeLabels = {};
data.nodes.forEach(node => {
nodeLabels[node.id] = node.label;
});
// Use current layout direction
let mermaidCode = `graph ${currentLayout}\n`;
// First define all nodes with labels
data.nodes.forEach(node => {
mermaidCode += ` ${node.id}["${node.label}"]\n`;
});
// Then add edges
data.edges.forEach(edge => {
mermaidCode += ` ${edge.from} --> ${edge.to}\n`;
});
const container = document.getElementById('mermaidGraph');
container.innerHTML = mermaidCode;
container.removeAttribute('data-processed');
await mermaid.run({ nodes: [container] });
// Auto-fit if graph is large
setTimeout(() => {
autoFitGraph();
}, 100);
} catch (e) {
console.error('Failed to render graph:', e);
document.getElementById('mermaidGraph').innerHTML =
`<div class="loading">${i18n.t('renderError')}</div>`;
}
}
// Auto-fit graph to viewport
function autoFitGraph() {
const viewport = document.getElementById('graphView');
const svg = document.querySelector('.mermaid svg');
if (!viewport || !svg) return;
const viewportRect = viewport.getBoundingClientRect();
const svgRect = svg.getBoundingClientRect();
if (svgRect.width === 0 || svgRect.height === 0) return;
// Calculate scale to fit
const scaleX = (viewportRect.width - 40) / svgRect.width;
const scaleY = (viewportRect.height - 40) / svgRect.height;
const scale = Math.min(scaleX, scaleY, 1); // Don't zoom in beyond 100%
if (scale < 1) {
currentZoom = scale;
// Center the graph
panX = (viewportRect.width - svgRect.width * scale) / 2;
panY = 20;
applyTransform();
showZoomIndicator();
}
}
// Refresh tree view
async function refreshTree(depth, internal, external, moduleLevel, directOnly) {
document.getElementById('graphView').classList.add('hidden');
document.getElementById('textView').classList.remove('hidden');
let url = `/api/tree?depth=${depth}&internal=${internal}`;
if (external !== undefined) {
url += `&external=${external}`;
}
if (moduleLevel !== undefined) {
url += `&module=${moduleLevel}`;
}
if (directOnly !== undefined) {
url += `&direct=${directOnly}`;
}
if (selectedPackage) {
url += '&package=' + encodeURIComponent(selectedPackage);
}
try {
const response = await fetch(url);
const text = await response.text();
document.getElementById('textView').textContent = text;
const lines = text.split('\n').filter(l => l.trim());
document.getElementById('nodeCount').textContent = lines.length;
document.getElementById('edgeCount').textContent = '-';
} catch (e) {
console.error('Failed to load tree:', e);
}
}
// Refresh list view
async function refreshList(internal, external, moduleLevel, directOnly) {
document.getElementById('graphView').classList.add('hidden');
document.getElementById('textView').classList.remove('hidden');
let url = `/api/list?internal=${internal}`;
if (external !== undefined) {
url += `&external=${external}`;
}
if (moduleLevel !== undefined) {
url += `&module=${moduleLevel}`;
}
if (directOnly !== undefined) {
url += `&direct=${directOnly}`;
}
if (selectedPackage) {
url += '&package=' + encodeURIComponent(selectedPackage);
}
try {
const response = await fetch(url);
const text = await response.text();
document.getElementById('textView').textContent = text;
const lines = text.split('\n').filter(l => l.trim());
document.getElementById('nodeCount').textContent = lines.length;
document.getElementById('edgeCount').textContent = '-';
} catch (e) {
console.error('Failed to load list:', e);
}
}
// Zoom functions
function zoomIn() {
const viewport = document.getElementById('graphView');
if (!viewport) return;
const rect = viewport.getBoundingClientRect();
const centerX = rect.width / 2;
const centerY = rect.height / 2;
const newZoom = Math.min(MAX_ZOOM, currentZoom * 1.2);
const scale = newZoom / currentZoom;
panX = centerX - (centerX - panX) * scale;
panY = centerY - (centerY - panY) * scale;
currentZoom = newZoom;
applyTransform();
showZoomIndicator();
}
function zoomOut() {
const viewport = document.getElementById('graphView');
if (!viewport) return;
const rect = viewport.getBoundingClientRect();
const centerX = rect.width / 2;
const centerY = rect.height / 2;
const newZoom = Math.max(MIN_ZOOM, currentZoom / 1.2);
const scale = newZoom / currentZoom;
panX = centerX - (centerX - panX) * scale;
panY = centerY - (centerY - panY) * scale;
currentZoom = newZoom;
applyTransform();
showZoomIndicator();
}
function resetZoom() {
currentZoom = 1;
panX = 0;
panY = 0;
applyTransform();
showZoomIndicator();
}
function fitToScreen() {
autoFitGraph();
}
// Initialize when DOM is ready
document.addEventListener('DOMContentLoaded', init);

View File

@ -1,228 +0,0 @@
// Internationalization (i18n) Module
const i18n = {
currentLang: 'en',
translations: {
en: {
title: 'Go Package Dependencies',
pageTitle: 'Package Dependency Viewer',
currentModule: 'Current:',
remoteModuleLabel: 'Analyze Module:',
remoteModulePlaceholder: 'e.g. github.com/gogf/gf/v2',
selectVersion: 'Version',
analyze: 'Analyze',
resetLocal: 'Reset',
fetchingVersions: 'Fetching...',
analyzing: 'Analyzing...',
viewLabel: 'View:',
viewGraph: 'Graph',
viewTree: 'Tree',
viewList: 'List',
depthLabel: 'Depth:',
depthUnlimited: 'Unlimited',
reverseLabel: 'Reverse (show who uses)',
groupLabel: 'Group by directory',
internalLabel: 'Internal only',
externalLabel: 'External packages',
moduleLevelLabel: 'Module level',
directOnlyLabel: 'Direct only',
statsInternal: 'Internal',
statsExternal: 'External',
statsStdlib: 'Stdlib',
layoutLabel: 'Layout:',
layoutTD: 'Top-Down',
layoutLR: 'Left-Right',
showAll: 'Show All',
packagesTitle: 'Packages',
searchPlaceholder: 'Search packages...',
flatMode: 'Flat list',
treeMode: 'Tree view',
statsPackages: 'Packages',
statsDependencies: 'Dependencies',
dependencies: 'Dependencies',
usedBy: 'Used by',
noPackages: 'No packages found',
renderError: 'Unable to render graph. Try reducing depth or selecting a specific package.',
packageNotFound: 'Package not found',
zoomIn: 'Zoom in',
zoomOut: 'Zoom out',
fitToScreen: 'Fit to screen',
resetZoom: 'Reset zoom',
dragToMove: 'Drag to move, scroll to zoom',
noVersions: 'No versions found',
latestVersion: 'Latest',
errorFetchVersions: 'Failed to fetch versions',
errorAnalyze: 'Failed to analyze module',
packageDetails: 'Package Details',
viewGraphTooltip: 'Visualize dependencies as a directed graph',
viewTreeTooltip: 'Show dependencies in a hierarchical tree structure',
viewListTooltip: 'Display dependencies as a text list',
depthTooltip: 'Limit dependency traversal depth',
reverseTooltip: 'Show reverse dependencies (who uses the selected package)',
groupTooltip: 'Group packages by directory structure',
internalTooltip: 'Show only internal packages from current module',
externalTooltip: 'Include external dependency packages',
moduleLevelTooltip: 'Show module-level dependencies (from go.mod)',
directOnlyTooltip: 'Show only direct dependencies (requires module level)',
layoutTDTooltip: 'Top-down layout for dependency graph',
layoutLRTooltip: 'Left-right layout for dependency graph',
showAllTooltip: 'Clear package selection and show all packages',
analyzeTooltip: 'Analyze remote Go module dependencies',
resetTooltip: 'Reset to local module analysis',
themeTooltip: 'Toggle light/dark theme',
langTooltip: 'Select language',
flatModeTooltip: 'Flat list view',
treeModeTooltip: 'Tree view',
zoomInTooltip: 'Zoom in',
zoomOutTooltip: 'Zoom out',
fitToScreenTooltip: 'Fit to screen',
resetZoomTooltip: 'Reset zoom',
remoteModuleTooltip: 'Enter a remote Go module path to analyze',
versionSelectTooltip: 'Select module version (optional)',
searchTooltip: 'Search packages by name'
},
zh: {
title: 'Go 包依赖分析',
pageTitle: '包依赖查看器',
currentModule: '当前模块:',
remoteModuleLabel: '分析模块:',
remoteModulePlaceholder: '例如 github.com/gogf/gf/v2',
selectVersion: '版本',
analyze: '分析',
resetLocal: '重置',
fetchingVersions: '获取中...',
analyzing: '分析中...',
viewLabel: '视图:',
viewGraph: '图表',
viewTree: '树形',
viewList: '列表',
depthLabel: '深度:',
depthUnlimited: '无限制',
reverseLabel: '反向依赖 (谁引用了它)',
groupLabel: '按目录分组',
internalLabel: '仅内部包',
externalLabel: '外部依赖包',
moduleLevelLabel: '模块级别',
directOnlyLabel: '仅直接依赖',
statsInternal: '内部',
statsExternal: '外部',
statsStdlib: '标准库',
layoutLabel: '布局:',
layoutTD: '从上到下',
layoutLR: '从左到右',
showAll: '显示全部',
packagesTitle: '包列表',
searchPlaceholder: '搜索包...',
flatMode: '平铺列表',
treeMode: '目录树',
statsPackages: '包数量',
statsDependencies: '依赖数',
dependencies: '依赖',
usedBy: '被引用',
noPackages: '未找到包',
renderError: '无法渲染图表请尝试减少深度或选择特定的包',
packageNotFound: '未找到包',
zoomIn: '放大',
zoomOut: '缩小',
fitToScreen: '适应屏幕',
resetZoom: '重置缩放',
dragToMove: '拖拽移动滚轮缩放',
noVersions: '未找到版本',
latestVersion: '最新版本',
errorFetchVersions: '获取版本失败',
errorAnalyze: '分析模块失败',
packageDetails: '包详情',
viewGraphTooltip: '以有向图形式可视化依赖关系',
viewTreeTooltip: '以层次树结构显示依赖关系',
viewListTooltip: '以文本列表形式显示依赖关系',
depthTooltip: '限制依赖遍历的深度',
reverseTooltip: '显示反向依赖谁引用了选中的包',
groupTooltip: '按目录结构分组显示包',
internalTooltip: '仅显示当前模块的内部包',
externalTooltip: '包含外部依赖包',
moduleLevelTooltip: '显示模块级别依赖来自go.mod',
directOnlyTooltip: '仅显示直接依赖需要启用模块级别',
layoutTDTooltip: '依赖图从上到下布局',
layoutLRTooltip: '依赖图从左到右布局',
showAllTooltip: '清除包选择显示所有包',
analyzeTooltip: '分析远程Go模块依赖',
resetTooltip: '重置为本地模块分析',
themeTooltip: '切换明暗主题',
langTooltip: '选择语言',
flatModeTooltip: '平铺列表视图',
treeModeTooltip: '树形视图',
zoomInTooltip: '放大',
zoomOutTooltip: '缩小',
fitToScreenTooltip: '适应屏幕',
resetZoomTooltip: '重置缩放',
remoteModuleTooltip: '输入远程Go模块路径进行分析',
versionSelectTooltip: '选择模块版本可选',
searchTooltip: '按名称搜索包'
}
},
init() {
// Load saved language preference
const savedLang = localStorage.getItem('dep-viewer-lang');
if (savedLang && this.translations[savedLang]) {
this.currentLang = savedLang;
} else {
// Detect browser language
const browserLang = navigator.language.toLowerCase();
if (browserLang.startsWith('zh')) {
this.currentLang = 'zh';
}
}
// Set select value
const langSelect = document.getElementById('langSelect');
if (langSelect) {
langSelect.value = this.currentLang;
langSelect.addEventListener('change', (e) => {
this.setLanguage(e.target.value);
});
}
this.applyTranslations();
},
setLanguage(lang) {
if (this.translations[lang]) {
this.currentLang = lang;
localStorage.setItem('dep-viewer-lang', lang);
this.applyTranslations();
}
},
t(key) {
return this.translations[this.currentLang][key] || this.translations['en'][key] || key;
},
applyTranslations() {
// Update elements with data-i18n attribute
document.querySelectorAll('[data-i18n]').forEach(el => {
const key = el.getAttribute('data-i18n');
el.textContent = this.t(key);
});
// Update placeholders
document.querySelectorAll('[data-i18n-placeholder]').forEach(el => {
const key = el.getAttribute('data-i18n-placeholder');
el.placeholder = this.t(key);
});
// Update title attributes
document.querySelectorAll('[data-i18n-title]').forEach(el => {
const key = el.getAttribute('data-i18n-title');
el.title = this.t(key);
});
// Update page title
document.title = this.t('title');
}
};
// Initialize i18n when DOM is ready
document.addEventListener('DOMContentLoaded', () => {
i18n.init();
});

View File

@ -1,161 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title data-i18n="title">Go Package Dependencies</title>
<link rel="stylesheet" href="/static/style.css">
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
</head>
<body>
<div class="header">
<div class="header-left">
<h1 data-i18n="pageTitle">Package Dependency Viewer</h1>
<div class="module-info">
<span data-i18n="currentModule">Current:</span>
<span class="module" id="moduleName"></span>
</div>
</div>
<div class="header-center">
<div class="remote-input-group">
<label for="remoteModuleInput" data-i18n="remoteModuleLabel">Module:</label>
<input type="text" id="remoteModuleInput" data-i18n-placeholder="remoteModulePlaceholder" placeholder="e.g. github.com/gogf/gf/v2" data-i18n-title="remoteModuleTooltip">
<select id="versionSelect" disabled data-i18n-title="versionSelectTooltip">
<option value="" data-i18n="selectVersion">Select version</option>
</select>
<button class="btn btn-sm" id="analyzeBtn" onclick="analyzeRemoteModule()" data-i18n="analyze" data-i18n-title="analyzeTooltip">Analyze</button>
<button class="btn btn-sm btn-secondary" id="resetBtn" onclick="resetToLocal()" data-i18n="resetLocal" data-i18n-title="resetTooltip">Reset</button>
<span class="loading-spinner hidden" id="loadingSpinner"></span>
</div>
</div>
<div class="header-right">
<div class="theme-switch">
<button class="icon-btn" id="themeToggle" data-i18n-title="themeTooltip">
<span class="icon-sun"></span>
<span class="icon-moon">🌙</span>
</button>
</div>
<div class="lang-switch">
<select id="langSelect" data-i18n-title="langTooltip">
<option value="en">English</option>
<option value="zh">中文</option>
</select>
</div>
</div>
</div>
<div class="controls">
<div class="control-group">
<label data-i18n="viewLabel">View:</label>
<div class="btn-group">
<button class="btn active" id="btnGraph" onclick="setView('graph')" data-i18n="viewGraph" data-i18n-title="viewGraphTooltip">Graph</button>
<button class="btn" id="btnTree" onclick="setView('tree')" data-i18n="viewTree" data-i18n-title="viewTreeTooltip">Tree</button>
<button class="btn" id="btnList" onclick="setView('list')" data-i18n="viewList" data-i18n-title="viewListTooltip">List</button>
</div>
</div>
<div class="control-group">
<label data-i18n="depthLabel">Depth:</label>
<select id="depth" onchange="refresh()" data-i18n-title="depthTooltip">
<option value="1">1</option>
<option value="2">2</option>
<option value="3" selected>3</option>
<option value="5">5</option>
<option value="0" data-i18n="depthUnlimited">Unlimited</option>
</select>
</div>
<div class="control-group">
<input type="checkbox" id="reverse" onchange="refresh()" data-i18n-title="reverseTooltip">
<label for="reverse" data-i18n="reverseLabel">Reverse (show who uses)</label>
</div>
<div class="control-group">
<input type="checkbox" id="group" onchange="refresh()" data-i18n-title="groupTooltip">
<label for="group" data-i18n="groupLabel">Group by directory</label>
</div>
<div class="control-group">
<input type="checkbox" id="internal" checked onchange="refresh()" data-i18n-title="internalTooltip">
<label for="internal" data-i18n="internalLabel">Internal only</label>
</div>
<div class="control-group">
<input type="checkbox" id="external" onchange="refresh()" data-i18n-title="externalTooltip">
<label for="external" data-i18n="externalLabel">External packages</label>
</div>
<div class="control-group">
<input type="checkbox" id="moduleLevel" onchange="refresh()" data-i18n-title="moduleLevelTooltip">
<label for="moduleLevel" data-i18n="moduleLevelLabel">Module level</label>
</div>
<div class="control-group">
<input type="checkbox" id="directOnly" onchange="refresh()" data-i18n-title="directOnlyTooltip">
<label for="directOnly" data-i18n="directOnlyLabel">Direct only</label>
</div>
<div class="control-group graph-only" id="layoutGroup">
<label data-i18n="layoutLabel">Layout:</label>
<div class="btn-group">
<button class="btn active" id="layoutTD" onclick="setLayout('TD')" data-i18n="layoutTD" data-i18n-title="layoutTDTooltip">Top-Down</button>
<button class="btn" id="layoutLR" onclick="setLayout('LR')" data-i18n="layoutLR" data-i18n-title="layoutLRTooltip">Left-Right</button>
</div>
</div>
<button class="btn btn-secondary" onclick="clearSelection()" data-i18n="showAll" data-i18n-title="showAllTooltip">Show All</button>
</div>
<div class="main-content">
<div class="sidebar">
<div class="sidebar-header">
<div class="sidebar-title">
<h3 data-i18n="packagesTitle">Packages</h3>
<span class="count" id="packageCount">0</span>
</div>
<div class="sidebar-mode">
<button class="mode-btn" id="modeFlat" onclick="setPackageListMode('flat')" data-i18n-title="flatModeTooltip"></button>
<button class="mode-btn active" id="modeTree" onclick="setPackageListMode('tree')" data-i18n-title="treeModeTooltip">🌲</button>
</div>
</div>
<div class="search-box">
<input type="text" id="searchInput" data-i18n-placeholder="searchPlaceholder" placeholder="Search packages..." oninput="filterPackages()" data-i18n-title="searchTooltip">
</div>
<div class="package-list" id="packageList"></div>
</div>
<div class="content-area">
<div class="stats">
<div class="stat-card">
<div class="value" id="nodeCount">0</div>
<div class="label" data-i18n="statsPackages">Packages</div>
</div>
<div class="stat-card">
<div class="value" id="edgeCount">0</div>
<div class="label" data-i18n="statsDependencies">Dependencies</div>
</div>
<div class="stat-card">
<div class="value" id="internalCount">0</div>
<div class="label" data-i18n="statsInternal">Internal</div>
</div>
<div class="stat-card">
<div class="value" id="externalCount">0</div>
<div class="label" data-i18n="statsExternal">External</div>
</div>
<div class="stat-card">
<div class="value" id="stdlibCount">0</div>
<div class="label" data-i18n="statsStdlib">Stdlib</div>
</div>
<div class="package-info" id="packageInfo">
<div class="package-info-content" id="packageInfoContent"></div>
</div>
</div>
<div class="graph-container" id="graphContainer">
<div id="graphView" class="graph-viewport">
<div class="mermaid-container" id="mermaidContainer">
<div class="mermaid" id="mermaidGraph"></div>
</div>
<div class="zoom-indicator" id="zoomIndicator">100%</div>
</div>
<div id="textView" class="text-output hidden"></div>
</div>
</div>
</div>
<div class="zoom-controls" id="zoomControls">
<button class="zoom-btn" onclick="zoomIn()" data-i18n-title="zoomInTooltip">+</button>
<button class="zoom-btn" onclick="zoomOut()" data-i18n-title="zoomOutTooltip"></button>
<button class="zoom-btn" onclick="fitToScreen()" data-i18n-title="fitToScreenTooltip"></button>
<button class="zoom-btn" onclick="resetZoom()" data-i18n-title="resetZoomTooltip"></button>
</div>
<script src="/static/i18n.js"></script>
<script src="/static/app.js"></script>
</body>
</html>

View File

@ -1,811 +0,0 @@
/* CSS Variables for Theming */
:root {
/* Light Theme (Default) */
--bg-primary: #f8fafc;
--bg-secondary: #ffffff;
--bg-tertiary: #f1f5f9;
--bg-hover: #e2e8f0;
--text-primary: #1e293b;
--text-secondary: #475569;
--text-muted: #94a3b8;
--border-color: #e2e8f0;
--accent-color: #3b82f6;
--accent-hover: #2563eb;
--accent-light: #dbeafe;
--success-color: #10b981;
--card-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
--input-bg: #ffffff;
--input-border: #cbd5e1;
}
[data-theme="dark"] {
--bg-primary: #0f172a;
--bg-secondary: #1e293b;
--bg-tertiary: #334155;
--bg-hover: #475569;
--text-primary: #f1f5f9;
--text-secondary: #cbd5e1;
--text-muted: #64748b;
--border-color: #334155;
--accent-color: #60a5fa;
--accent-hover: #3b82f6;
--accent-light: #1e3a5f;
--success-color: #34d399;
--card-shadow: 0 1px 3px rgba(0, 0, 0, 0.3);
--input-bg: #1e293b;
--input-border: #475569;
}
/* Reset & Base */
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
html, body {
height: 100%;
overflow: hidden;
}
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
background: var(--bg-primary);
color: var(--text-primary);
display: flex;
flex-direction: column;
transition: background-color 0.3s, color 0.3s;
}
/* Header */
.header {
background: var(--bg-secondary);
padding: 12px 24px;
border-bottom: 1px solid var(--border-color);
display: flex;
justify-content: space-between;
align-items: center;
gap: 20px;
box-shadow: var(--card-shadow);
flex-shrink: 0;
}
.header-left {
flex-shrink: 0;
}
.header-left h1 {
font-size: 18px;
font-weight: 600;
color: var(--text-primary);
}
.header-left .module-info {
display: flex;
align-items: center;
gap: 6px;
color: var(--text-muted);
font-size: 12px;
margin-top: 2px;
}
.header-left .module {
color: var(--accent-color);
font-weight: 500;
max-width: 200px;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
/* Header Center - Remote Module Input */
.header-center {
flex: 1;
display: flex;
justify-content: center;
}
.remote-input-group {
display: flex;
align-items: center;
gap: 8px;
}
.remote-input-group input[type="text"] {
width: 320px;
background: var(--input-bg);
border: 1px solid var(--input-border);
color: var(--text-primary);
padding: 6px 12px;
border-radius: 6px;
font-size: 13px;
transition: border-color 0.2s;
}
.remote-input-group input[type="text"]:focus {
outline: none;
border-color: var(--accent-color);
}
.remote-input-group select {
width: 160px;
background: var(--input-bg);
border: 1px solid var(--input-border);
color: var(--text-primary);
padding: 6px 10px;
border-radius: 6px;
font-size: 13px;
cursor: pointer;
}
.remote-input-group select:disabled {
opacity: 0.6;
cursor: not-allowed;
}
.btn-sm {
padding: 6px 12px;
font-size: 12px;
}
.loading-spinner {
width: 18px;
height: 18px;
border: 2px solid var(--border-color);
border-top-color: var(--accent-color);
border-radius: 50%;
animation: spin 0.8s linear infinite;
}
@keyframes spin {
to { transform: rotate(360deg); }
}
.header-right {
display: flex;
align-items: center;
gap: 12px;
}
.icon-btn {
background: var(--bg-tertiary);
border: 1px solid var(--border-color);
border-radius: 8px;
padding: 8px 12px;
cursor: pointer;
font-size: 16px;
transition: all 0.2s;
}
.icon-btn:hover {
background: var(--bg-hover);
}
.icon-sun, .icon-moon {
display: none;
}
body:not([data-theme="dark"]) .icon-moon {
display: inline;
}
[data-theme="dark"] .icon-sun {
display: inline;
}
.lang-switch select {
background: var(--bg-tertiary);
border: 1px solid var(--border-color);
color: var(--text-primary);
padding: 8px 12px;
border-radius: 8px;
font-size: 13px;
cursor: pointer;
}
/* Controls */
.controls {
background: var(--bg-secondary);
padding: 12px 24px;
display: flex;
gap: 20px;
flex-wrap: wrap;
align-items: center;
border-bottom: 1px solid var(--border-color);
}
.control-group {
display: flex;
align-items: center;
gap: 8px;
}
.control-group label {
font-size: 13px;
color: var(--text-secondary);
font-weight: 500;
}
.control-group select {
background: var(--input-bg);
border: 1px solid var(--input-border);
color: var(--text-primary);
padding: 6px 12px;
border-radius: 6px;
font-size: 13px;
cursor: pointer;
}
.control-group input[type="checkbox"] {
width: 16px;
height: 16px;
accent-color: var(--accent-color);
}
/* Buttons */
.btn {
background: var(--accent-color);
color: white;
border: none;
padding: 8px 16px;
border-radius: 6px;
cursor: pointer;
font-size: 13px;
font-weight: 500;
transition: all 0.2s;
}
.btn:hover {
background: var(--accent-hover);
}
.btn.active {
background: var(--accent-color);
box-shadow: 0 0 0 2px var(--accent-light);
}
.btn-secondary {
background: var(--bg-tertiary);
color: var(--text-primary);
border: 1px solid var(--border-color);
}
.btn-secondary:hover {
background: var(--bg-hover);
}
.btn-group {
display: flex;
gap: 0;
}
.btn-group .btn {
border-radius: 0;
border-right: 1px solid rgba(255, 255, 255, 0.2);
}
.btn-group .btn:first-child {
border-radius: 6px 0 0 6px;
}
.btn-group .btn:last-child {
border-radius: 0 6px 6px 0;
border-right: none;
}
.btn-group .btn:not(.active) {
background: var(--bg-tertiary);
color: var(--text-primary);
}
.btn-group .btn:not(.active):hover {
background: var(--bg-hover);
}
/* Main Content */
.main-content {
display: flex;
flex: 1;
overflow: hidden;
min-height: 0; /* Important for flex children to respect overflow */
}
/* Sidebar */
.sidebar {
width: 280px;
min-width: 280px;
background: var(--bg-secondary);
border-right: 1px solid var(--border-color);
display: flex;
flex-direction: column;
overflow: hidden;
height: 100%; /* Ensure sidebar takes full height */
}
.sidebar-header {
padding: 10px 16px;
border-bottom: 1px solid var(--border-color);
display: flex;
justify-content: space-between;
align-items: center;
flex-shrink: 0; /* Prevent shrinking */
}
.sidebar-title {
display: flex;
align-items: center;
gap: 8px;
}
.sidebar-title h3 {
font-size: 14px;
font-weight: 600;
color: var(--text-secondary);
}
.sidebar-title .count {
background: var(--accent-color);
color: white;
padding: 2px 10px;
border-radius: 12px;
font-size: 12px;
font-weight: 500;
}
.sidebar-mode {
display: flex;
gap: 4px;
}
.mode-btn {
width: 28px;
height: 28px;
border: 1px solid var(--border-color);
background: var(--bg-tertiary);
border-radius: 6px;
cursor: pointer;
font-size: 12px;
display: flex;
align-items: center;
justify-content: center;
transition: all 0.2s;
}
.mode-btn:hover {
background: var(--bg-hover);
}
.mode-btn.active {
background: var(--accent-color);
border-color: var(--accent-color);
color: white;
}
.search-box {
padding: 12px 16px;
border-bottom: 1px solid var(--border-color);
flex-shrink: 0; /* Prevent shrinking */
}
.search-box input {
width: 100%;
background: var(--input-bg);
border: 1px solid var(--input-border);
color: var(--text-primary);
padding: 10px 14px;
border-radius: 8px;
font-size: 13px;
transition: border-color 0.2s;
}
.search-box input:focus {
outline: none;
border-color: var(--accent-color);
}
.search-box input::placeholder {
color: var(--text-muted);
}
.package-list {
flex: 1;
overflow-y: auto;
overflow-x: hidden;
padding: 8px 0;
min-height: 0; /* Important for flex overflow to work */
}
.package-item {
padding: 10px 16px;
cursor: pointer;
font-size: 13px;
color: var(--text-secondary);
border-left: 3px solid transparent;
transition: all 0.15s;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
display: flex;
justify-content: space-between;
align-items: center;
}
.package-item .pkg-name-text {
overflow: hidden;
text-overflow: ellipsis;
flex: 1;
min-width: 0;
}
.pkg-stats-inline {
display: flex;
gap: 6px;
font-size: 11px;
margin-left: 8px;
flex-shrink: 0;
}
.pkg-stats-inline .dep-count {
color: var(--accent-color);
opacity: 0.8;
}
.pkg-stats-inline .used-count {
color: #10b981;
opacity: 0.8;
}
.package-item:hover {
background: var(--bg-hover);
color: var(--text-primary);
}
.package-item.active {
background: var(--accent-light);
border-left-color: var(--accent-color);
color: var(--accent-color);
font-weight: 500;
}
/* Tree View Styles */
.tree-node {
user-select: none;
}
.tree-node-header {
display: flex;
align-items: center;
padding: 6px 12px;
cursor: pointer;
font-size: 13px;
color: var(--text-secondary);
transition: all 0.15s;
}
.tree-node-header .pkg-stats-inline {
margin-left: auto;
padding-left: 8px;
}
.tree-node-header:hover {
background: var(--bg-hover);
color: var(--text-primary);
}
.tree-node-toggle {
width: 20px;
height: 20px;
display: flex;
align-items: center;
justify-content: center;
margin-right: 2px;
font-size: 10px;
color: var(--text-muted);
transition: transform 0.2s;
cursor: pointer;
border-radius: 4px;
}
.tree-node-toggle:hover {
background: var(--bg-hover);
color: var(--text-primary);
}
.tree-node-toggle.expanded {
transform: rotate(90deg);
}
.tree-node-toggle.empty {
visibility: hidden;
}
.tree-node-icon {
margin-right: 6px;
font-size: 12px;
}
.tree-node-name {
flex: 1;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
cursor: pointer;
padding: 2px 4px;
border-radius: 4px;
}
.tree-node-name:hover {
background: var(--bg-hover);
}
.tree-node-name.package {
color: var(--accent-color);
}
.tree-node-children {
padding-left: 16px;
display: none;
}
.tree-node-children.expanded {
display: block;
}
.tree-node-header.active {
background: var(--accent-light);
color: var(--accent-color);
}
.tree-node-header.active .tree-node-name {
font-weight: 500;
}
/* Content Area */
.content-area {
flex: 1;
display: flex;
flex-direction: column;
overflow: hidden;
}
/* Stats */
.stats {
display: flex;
align-items: center;
gap: 16px;
padding: 12px 24px;
background: var(--bg-secondary);
border-bottom: 1px solid var(--border-color);
}
.stat-card {
background: var(--bg-tertiary);
padding: 10px 20px;
border-radius: 10px;
text-align: center;
min-width: 90px;
}
.stat-card .value {
font-size: 20px;
font-weight: 700;
color: var(--accent-color);
}
.stat-card .label {
font-size: 11px;
color: var(--text-muted);
margin-top: 2px;
text-transform: uppercase;
letter-spacing: 0.5px;
}
/* Package Info - in stats bar */
.package-info {
display: none;
align-items: center;
gap: 16px;
background: var(--bg-tertiary);
padding: 8px 16px;
border-radius: 10px;
}
.package-info.visible {
display: flex;
}
.package-info-content {
display: flex;
align-items: center;
gap: 20px;
}
.package-info-content .pkg-name {
font-size: 14px;
font-weight: 600;
color: var(--accent-color);
max-width: 300px;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.package-info-content .pkg-stats {
display: flex;
gap: 16px;
}
.package-info-content .pkg-stat {
display: flex;
align-items: center;
gap: 6px;
font-size: 13px;
}
.package-info-content .pkg-stat-label {
color: var(--text-muted);
}
.package-info-content .pkg-stat-value {
color: var(--text-primary);
font-weight: 600;
}
/* Graph Container */
.graph-container {
flex: 1;
padding: 24px;
overflow: hidden;
background: var(--bg-primary);
position: relative;
display: flex;
flex-direction: column;
min-height: 0; /* Important for flex overflow */
}
.graph-viewport {
flex: 1;
width: 100%;
overflow: hidden;
position: relative;
cursor: grab;
min-height: 0; /* Important for flex overflow */
}
.graph-viewport:active {
cursor: grabbing;
}
.mermaid-container {
display: inline-block;
min-width: 100%;
min-height: 100%;
transform-origin: 0 0;
transition: none;
}
.mermaid {
display: inline-block;
padding: 20px;
}
.mermaid svg {
display: block;
max-width: none !important;
height: auto;
}
.zoom-indicator {
position: absolute;
bottom: 16px;
left: 16px;
background: var(--bg-secondary);
border: 1px solid var(--border-color);
padding: 6px 12px;
border-radius: 6px;
font-size: 12px;
color: var(--text-secondary);
box-shadow: var(--card-shadow);
pointer-events: none;
opacity: 0;
transition: opacity 0.3s;
}
.zoom-indicator.visible {
opacity: 1;
}
.text-output {
flex: 1;
background: var(--bg-secondary);
border: 1px solid var(--border-color);
border-radius: 10px;
padding: 20px;
font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', 'Consolas', monospace;
font-size: 13px;
line-height: 1.7;
white-space: pre;
overflow: auto;
min-height: 0; /* Important for flex overflow */
color: var(--text-primary);
}
/* Zoom Controls */
.zoom-controls {
position: fixed;
bottom: 24px;
right: 24px;
display: flex;
gap: 8px;
}
.zoom-btn {
width: 40px;
height: 40px;
border-radius: 10px;
background: var(--bg-secondary);
color: var(--text-primary);
border: 1px solid var(--border-color);
font-size: 18px;
cursor: pointer;
display: flex;
align-items: center;
justify-content: center;
transition: all 0.2s;
box-shadow: var(--card-shadow);
}
.zoom-btn:hover {
background: var(--accent-color);
color: white;
border-color: var(--accent-color);
}
/* Utility Classes */
.hidden {
display: none !important;
}
.loading {
display: flex;
align-items: center;
justify-content: center;
height: 200px;
color: var(--text-muted);
font-size: 14px;
}
/* Scrollbar Styling */
::-webkit-scrollbar {
width: 8px;
height: 8px;
}
::-webkit-scrollbar-track {
background: var(--bg-tertiary);
}
::-webkit-scrollbar-thumb {
background: var(--text-muted);
border-radius: 4px;
}
::-webkit-scrollbar-thumb:hover {
background: var(--text-secondary);
}
/* Responsive */
@media (max-width: 768px) {
.sidebar {
width: 220px;
}
.controls {
padding: 10px 16px;
gap: 12px;
}
.header {
padding: 12px 16px;
}
}

View File

@ -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"`

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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 {

View File

@ -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) {

View File

@ -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,

View File

@ -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")
})
}

View File

@ -12,7 +12,6 @@ import (
"github.com/gogf/gf/v2/container/garray"
"github.com/gogf/gf/v2/container/gmap"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/text/gregex"
"github.com/gogf/gf/v2/text/gstr"
@ -37,21 +36,14 @@ func (c CGenService) calculateImportedItems(
}
for _, item := range pkgItems {
alias := item.Alias
// If the alias is _, it means that the package is not generated.
if alias == "_" {
// Skip anonymous imports
if item.Alias == "_" {
mlog.Debugf(`ignore anonymous package: %s`, item.RawImport)
continue
}
// If the alias is empty, it will use the package name as the alias.
if alias == "" {
alias = gfile.Basename(gstr.Trim(item.Path, `"`))
}
if !gstr.Contains(allFuncParamType.String(), alias) {
mlog.Debugf(`ignore unused package: %s`, item.RawImport)
continue
}
// Keep all imports, let gofmt clean up unused ones.
// We cannot accurately infer package name from import path
// (e.g., path "minio-go" but package name is "minio").
srcImportedPackages.Add(item.RawImport)
}
return nil

View File

@ -0,0 +1,137 @@
# GoFrame Configuration Field Descriptions - English
# Used by the config visual editor for field descriptions
# Server Module
config.server.name: "Service name for registry and discovery"
config.server.address: "Server listening address like ':port' or 'ip:port', multiple addresses joined with ','"
config.server.httpsAddr: "HTTPS listening address, multiple addresses joined with ','"
config.server.endpoints: "Custom endpoints for service register, uses Address if empty"
config.server.httpsCertPath: "HTTPS certification file path"
config.server.httpsKeyPath: "HTTPS key file path"
config.server.readTimeout: "HTTP read timeout duration for entire request including body"
config.server.writeTimeout: "HTTP write timeout duration for response"
config.server.idleTimeout: "HTTP idle timeout for keep-alive connections"
config.server.maxHeaderBytes: "Maximum number of bytes for parsing request header (default 10KB)"
config.server.keepAlive: "Enable HTTP keep-alive connections"
config.server.serverAgent: "Server agent string in HTTP response header"
config.server.rewrites: "URI rewrite rules map"
config.server.indexFiles: "Index files for static folder"
config.server.indexFolder: "Allow listing sub-files when requesting folder"
config.server.serverRoot: "Root directory for static file service"
config.server.searchPaths: "Additional searching directories for static service"
config.server.fileServerEnabled: "Global switch for static file service"
config.server.cookieMaxAge: "Maximum TTL for cookie items"
config.server.cookiePath: "Cookie path, also affects session id storage"
config.server.cookieDomain: "Cookie domain, also affects session id storage"
config.server.cookieSameSite: "Cookie SameSite property"
config.server.cookieSecure: "Cookie Secure flag"
config.server.cookieHttpOnly: "Cookie HttpOnly flag"
config.server.sessionIdName: "Session ID name in cookie"
config.server.sessionMaxAge: "Maximum TTL for session items"
config.server.sessionPath: "Session file storage directory path"
config.server.sessionCookieMaxAge: "Cookie TTL for session id (0 = expires with browser)"
config.server.sessionCookieOutput: "Automatically output session id to cookie"
config.server.logPath: "Directory path for storing log files"
config.server.logLevel: "Logging level (all, debug, info, notice, warning, error, critical)"
config.server.logStdout: "Output log content to stdout"
config.server.errorStack: "Log stack trace on error"
config.server.errorLogEnabled: "Enable error log to files"
config.server.errorLogPattern: "Error log file name pattern"
config.server.accessLogEnabled: "Enable access log to files"
config.server.accessLogPattern: "Access log file name pattern"
config.server.pprofEnabled: "Enable PProf feature for performance profiling"
config.server.pprofPattern: "PProf service route pattern"
config.server.openapiPath: "OpenApi specification file path"
config.server.swaggerPath: "Swagger UI route path"
config.server.swaggerUITemplate: "Custom Swagger UI HTML template"
config.server.graceful: "Enable graceful reload for all servers"
config.server.gracefulTimeout: "Maximum survival time (seconds) of parent process during graceful reload"
config.server.gracefulShutdownTimeout: "Maximum time (seconds) before stopping server during shutdown"
config.server.clientMaxBodySize: "Maximum client request body size in bytes (default 8MB)"
config.server.formParsingMemory: "Maximum memory buffer for parsing multimedia forms (default 1MB)"
config.server.nameToUriType: "Method name to URI conversion type (0=default, 1=fullname, 2=alllower, 3=camel)"
config.server.routeOverWrite: "Allow overwriting duplicate routes"
config.server.dumpRouterMap: "Dump router map on server start"
# Database Module
config.database.host: "Database server address (IP or domain)"
config.database.port: "Database server port number"
config.database.user: "Authentication username"
config.database.pass: "Authentication password"
config.database.name: "Default database name"
config.database.type: "Database type (mysql, pgsql, sqlite, mssql, oracle, clickhouse, dm)"
config.database.link: "Custom connection string combining all config"
config.database.extra: "Additional options for third-party drivers"
config.database.role: "Node role in master-slave setup (master/slave)"
config.database.debug: "Enable debug mode for logging"
config.database.prefix: "Table name prefix"
config.database.dryRun: "Simulation mode: execute SELECT only, skip INSERT/UPDATE/DELETE"
config.database.weight: "Node weight for load balancing"
config.database.charset: "Character set for database operations"
config.database.protocol: "Network protocol for connection"
config.database.timezone: "Time zone for timestamp interpretation"
config.database.namespace: "Schema namespace (e.g., PostgreSQL schema)"
config.database.maxIdle: "Maximum idle connections in pool"
config.database.maxOpen: "Maximum open connections (0=unlimited)"
config.database.maxLifeTime: "Maximum connection lifetime"
config.database.maxIdleTime: "Maximum connection idle time before close"
config.database.queryTimeout: "DQL (SELECT) query timeout"
config.database.execTimeout: "DML (INSERT/UPDATE/DELETE) execution timeout"
config.database.tranTimeout: "Transaction block timeout"
config.database.prepareTimeout: "Prepare statement timeout"
config.database.createdAt: "Auto timestamp field name for record creation"
config.database.updatedAt: "Auto timestamp field name for record update"
config.database.deletedAt: "Auto timestamp field name for soft delete"
config.database.timeMaintainDisabled: "Disable automatic time maintenance"
# Redis Module
config.redis.address: "Redis server address, multiple addresses joined with ',' for cluster"
config.redis.db: "Redis database index (0-15)"
config.redis.user: "Username for AUTH (Redis 6.0+)"
config.redis.pass: "Password for AUTH"
config.redis.sentinelUser: "Username for Sentinel AUTH"
config.redis.sentinelPass: "Password for Sentinel AUTH"
config.redis.minIdle: "Minimum idle connections in pool"
config.redis.maxIdle: "Maximum idle connections in pool"
config.redis.maxActive: "Maximum active connections (0=unlimited)"
config.redis.maxConnLifetime: "Maximum connection lifetime"
config.redis.idleTimeout: "Idle connection timeout"
config.redis.waitTimeout: "Wait timeout for connection from pool"
config.redis.dialTimeout: "Dial connection timeout for TCP"
config.redis.readTimeout: "Read timeout for TCP"
config.redis.writeTimeout: "Write timeout for TCP"
config.redis.masterName: "Master name for Redis Sentinel mode"
config.redis.tls: "Enable TLS connection"
config.redis.tlsSkipVerify: "Skip TLS server name verification"
config.redis.slaveOnly: "Route all commands to slave read-only nodes"
config.redis.cluster: "Enable cluster mode"
config.redis.protocol: "RESP protocol version (2 or 3)"
# Logger Module
config.logger.flags: "Extra flags for logging output features"
config.logger.timeFormat: "Logging time format pattern"
config.logger.path: "Logging directory path for file output"
config.logger.file: "Log file name pattern (supports datetime like {Y-m-d})"
config.logger.level: "Output level bitmask (DEBU=16, INFO=32, NOTI=64, WARN=128, ERRO=256, CRIT=512, ALL=992)"
config.logger.prefix: "Prefix string for every log entry"
config.logger.headerPrint: "Print log header"
config.logger.stdoutPrint: "Output log to stdout"
config.logger.levelPrint: "Print level string in log"
config.logger.stSkip: "Stack skip count from end point"
config.logger.stStatus: "Stack trace status (1=enabled, 0=disabled)"
config.logger.stFilter: "Stack string filter pattern"
config.logger.rotateSize: "Rotate log file when size exceeds (bytes, 0=disabled)"
config.logger.rotateExpire: "Rotate log file when mtime exceeds this duration"
config.logger.rotateBackupLimit: "Maximum rotated backup files (0=no limit)"
config.logger.rotateBackupExpire: "Rotated backup file expiration"
config.logger.rotateBackupCompress: "Gzip compression level for backup (0=no compression)"
config.logger.rotateCheckInterval: "Async rotate check interval"
config.logger.stdoutColorDisabled: "Disable color output to stdout"
config.logger.writerColorEnable: "Enable color output to writer"
# Viewer Module
config.viewer.paths: "Template search paths"
config.viewer.data: "Global template variables"
config.viewer.defaultFile: "Default template file for parsing"
config.viewer.delimiters: "Custom template delimiters (left, right)"
config.viewer.autoEncode: "Auto HTML encode for XSS safety"

View File

@ -0,0 +1,137 @@
# GoFrame 配置字段描述 - 中文
# 用于配置可视化编辑器的字段描述
# Server 模块
config.server.name: "服务名称,用于服务注册与发现"
config.server.address: "服务监听地址,格式如 ':端口' 或 'IP:端口',多个地址用 ',' 分隔"
config.server.httpsAddr: "HTTPS 监听地址,多个地址用 ',' 分隔"
config.server.endpoints: "自定义服务注册端点,为空则使用 Address"
config.server.httpsCertPath: "HTTPS 证书文件路径"
config.server.httpsKeyPath: "HTTPS 密钥文件路径"
config.server.readTimeout: "HTTP 请求读取超时时间(包含请求体)"
config.server.writeTimeout: "HTTP 响应写入超时时间"
config.server.idleTimeout: "HTTP 空闲连接超时时间"
config.server.maxHeaderBytes: "请求头最大字节数(默认 10KB"
config.server.keepAlive: "是否启用 HTTP Keep-Alive"
config.server.serverAgent: "HTTP 响应头中的 Server 字段值"
config.server.rewrites: "URI 重写规则映射"
config.server.indexFiles: "静态文件夹的索引文件列表"
config.server.indexFolder: "是否允许列出文件夹内容"
config.server.serverRoot: "静态文件服务根目录"
config.server.searchPaths: "静态文件服务的额外搜索路径"
config.server.fileServerEnabled: "静态文件服务全局开关"
config.server.cookieMaxAge: "Cookie 最大存活时间"
config.server.cookiePath: "Cookie 路径,也影响 Session ID 存储"
config.server.cookieDomain: "Cookie 域名,也影响 Session ID 存储"
config.server.cookieSameSite: "Cookie SameSite 属性"
config.server.cookieSecure: "Cookie Secure 标记"
config.server.cookieHttpOnly: "Cookie HttpOnly 标记"
config.server.sessionIdName: "Session ID 在 Cookie 中的名称"
config.server.sessionMaxAge: "Session 最大存活时间"
config.server.sessionPath: "Session 文件存储目录"
config.server.sessionCookieMaxAge: "Session ID Cookie 存活时间0 表示随浏览器关闭)"
config.server.sessionCookieOutput: "是否自动将 Session ID 输出到 Cookie"
config.server.logPath: "日志文件存储目录"
config.server.logLevel: "日志级别all, debug, info, notice, warning, error, critical"
config.server.logStdout: "是否将日志输出到标准输出"
config.server.errorStack: "错误日志是否记录堆栈信息"
config.server.errorLogEnabled: "是否启用错误日志文件"
config.server.errorLogPattern: "错误日志文件名模式"
config.server.accessLogEnabled: "是否启用访问日志文件"
config.server.accessLogPattern: "访问日志文件名模式"
config.server.pprofEnabled: "是否启用 PProf 性能分析"
config.server.pprofPattern: "PProf 路由模式"
config.server.openapiPath: "OpenApi 规范文件路径"
config.server.swaggerPath: "Swagger UI 路由路径"
config.server.swaggerUITemplate: "自定义 Swagger UI 模板"
config.server.graceful: "是否启用优雅重载"
config.server.gracefulTimeout: "优雅重载时父进程最大存活时间(秒)"
config.server.gracefulShutdownTimeout: "优雅关闭时最大等待时间(秒)"
config.server.clientMaxBodySize: "客户端请求体最大字节数(默认 8MB"
config.server.formParsingMemory: "表单解析最大内存缓冲(默认 1MB"
config.server.nameToUriType: "方法名转 URI 类型0=默认, 1=全名, 2=全小写, 3=驼峰)"
config.server.routeOverWrite: "是否允许覆盖重复路由"
config.server.dumpRouterMap: "服务启动时是否打印路由表"
# Database 数据库模块
config.database.host: "数据库服务器地址IP 或域名)"
config.database.port: "数据库服务器端口号"
config.database.user: "数据库认证用户名"
config.database.pass: "数据库认证密码"
config.database.name: "默认数据库名称"
config.database.type: "数据库类型mysql, pgsql, sqlite, mssql, oracle, clickhouse, dm"
config.database.link: "自定义连接字符串(包含所有配置信息)"
config.database.extra: "第三方驱动的额外配置选项"
config.database.role: "主从架构中的节点角色master/slave"
config.database.debug: "是否启用调试模式"
config.database.prefix: "数据表名称前缀"
config.database.dryRun: "模拟模式:仅执行 SELECT跳过增删改操作"
config.database.weight: "负载均衡权重"
config.database.charset: "数据库字符集"
config.database.protocol: "网络连接协议"
config.database.timezone: "时区设置"
config.database.namespace: "Schema 命名空间(如 PostgreSQL 的 schema"
config.database.maxIdle: "连接池最大空闲连接数"
config.database.maxOpen: "连接池最大连接数0 表示无限制)"
config.database.maxLifeTime: "连接最大生存时间"
config.database.maxIdleTime: "连接最大空闲时间"
config.database.queryTimeout: "查询操作SELECT超时时间"
config.database.execTimeout: "执行操作INSERT/UPDATE/DELETE超时时间"
config.database.tranTimeout: "事务块超时时间"
config.database.prepareTimeout: "预处理语句超时时间"
config.database.createdAt: "自动创建时间戳字段名"
config.database.updatedAt: "自动更新时间戳字段名"
config.database.deletedAt: "软删除时间戳字段名"
config.database.timeMaintainDisabled: "是否禁用自动时间维护"
# Redis 模块
config.redis.address: "Redis 服务器地址,集群模式下多个地址用 ',' 分隔"
config.redis.db: "Redis 数据库索引0-15"
config.redis.user: "认证用户名Redis 6.0+ 支持)"
config.redis.pass: "认证密码"
config.redis.sentinelUser: "哨兵认证用户名"
config.redis.sentinelPass: "哨兵认证密码"
config.redis.minIdle: "连接池最小空闲连接数"
config.redis.maxIdle: "连接池最大空闲连接数"
config.redis.maxActive: "最大活跃连接数0 表示无限制)"
config.redis.maxConnLifetime: "连接最大生存时间"
config.redis.idleTimeout: "空闲连接超时时间"
config.redis.waitTimeout: "从连接池获取连接的等待超时"
config.redis.dialTimeout: "TCP 连接拨号超时"
config.redis.readTimeout: "TCP 读取超时"
config.redis.writeTimeout: "TCP 写入超时"
config.redis.masterName: "Redis 哨兵模式下的主节点名称"
config.redis.tls: "是否启用 TLS 加密连接"
config.redis.tlsSkipVerify: "是否跳过 TLS 服务器名称验证"
config.redis.slaveOnly: "是否将所有命令路由到从节点"
config.redis.cluster: "是否启用集群模式"
config.redis.protocol: "RESP 协议版本2 或 3"
# Logger 日志模块
config.logger.flags: "额外的日志输出特性标志"
config.logger.timeFormat: "日志时间格式"
config.logger.path: "日志文件目录路径"
config.logger.file: "日志文件名模式(支持日期变量如 {Y-m-d}"
config.logger.level: "日志级别位掩码DEBU=16, INFO=32, NOTI=64, WARN=128, ERRO=256, CRIT=512, ALL=992"
config.logger.prefix: "日志内容前缀字符串"
config.logger.headerPrint: "是否打印日志头部"
config.logger.stdoutPrint: "是否输出到标准输出"
config.logger.levelPrint: "是否在日志中打印级别字符串"
config.logger.stSkip: "堆栈跳过层数"
config.logger.stStatus: "堆栈跟踪状态1=启用, 0=禁用)"
config.logger.stFilter: "堆栈字符串过滤模式"
config.logger.rotateSize: "日志文件滚动大小字节0 表示不滚动)"
config.logger.rotateExpire: "日志文件滚动时间间隔"
config.logger.rotateBackupLimit: "滚动备份文件最大数量0 表示不限制)"
config.logger.rotateBackupExpire: "滚动备份文件过期时间"
config.logger.rotateBackupCompress: "备份文件 Gzip 压缩级别0 表示不压缩)"
config.logger.rotateCheckInterval: "异步滚动检查间隔"
config.logger.stdoutColorDisabled: "是否禁用标准输出颜色"
config.logger.writerColorEnable: "是否启用 Writer 颜色输出"
# Viewer 模板引擎模块
config.viewer.paths: "模板文件搜索路径"
config.viewer.data: "全局模板变量"
config.viewer.defaultFile: "默认解析模板文件"
config.viewer.delimiters: "自定义模板分隔符(左, 右)"
config.viewer.autoEncode: "是否自动 HTML 编码以防 XSS"

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,881 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>GoFrame Config Editor</title>
<script src="/static/vue.global.prod.js"></script>
<link href="/static/tailwind.min.css" rel="stylesheet">
<!-- <script src="https://unpkg.com/vue@3.3.4/dist/vue.global.prod.js"></script>
<link href="https://cdnjs.cloudflare.com/ajax/libs/tailwindcss/2.2.19/tailwind.min.css" rel="stylesheet"> -->
<style>
:root {
--primary: #2563EB;
--primary-light: #3B82F6;
--primary-dark: #1E40AF;
--primary-glow: rgba(37, 99, 235, 0.15);
--bg-sidebar: #0F172A;
--bg-sidebar-hover: #1E293B;
--bg-content: #F1F5F9;
--bg-card: #FFFFFF;
--text-primary: #0F172A;
--text-secondary: #64748B;
--text-light: #F1F5F9;
--text-muted: #94A3B8;
--success: #10B981;
--danger: #EF4444;
--warning: #F59E0B;
--accent: #6366F1;
--border: #E2E8F0;
--border-light: #F1F5F9;
--sidebar-width: 260px;
--header-height: 60px;
--footer-height: 36px;
}
* { box-sizing: border-box; margin: 0; padding: 0; }
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'PingFang SC', 'Microsoft YaHei', sans-serif;
background: var(--bg-content);
color: var(--text-primary);
-webkit-font-smoothing: antialiased;
}
::-webkit-scrollbar { width: 5px; height: 5px; }
::-webkit-scrollbar-track { background: transparent; }
::-webkit-scrollbar-thumb { background: #CBD5E1; border-radius: 10px; }
.sidebar-scroll::-webkit-scrollbar-thumb { background: rgba(148, 163, 184, 0.3); }
@keyframes fadeInUp { from { opacity: 0; transform: translateY(12px); } to { opacity: 1; transform: translateY(0); } }
@keyframes fadeIn { from { opacity: 0; } to { opacity: 1; } }
@keyframes slideInLeft { from { transform: translateX(-8px); opacity: 0; } to { transform: translateX(0); opacity: 1; } }
@keyframes saveAnim { 0% { transform: scale(1); } 30% { transform: scale(0.95); } 60% { transform: scale(1.02); } 100% { transform: scale(1); } }
@keyframes checkmark { 0% { stroke-dashoffset: 24; } 100% { stroke-dashoffset: 0; } }
@keyframes shimmer { 0% { background-position: -200% 0; } 100% { background-position: 200% 0; } }
@keyframes pulseGlow { 0%, 100% { box-shadow: 0 0 0 0 var(--primary-glow); } 50% { box-shadow: 0 0 0 8px transparent; } }
.fade-in-up { animation: fadeInUp 0.4s cubic-bezier(0.22, 1, 0.36, 1); }
.fade-in { animation: fadeIn 0.3s ease-out; }
.slide-in-left { animation: slideInLeft 0.25s cubic-bezier(0.22, 1, 0.36, 1); }
.save-anim { animation: saveAnim 0.4s cubic-bezier(0.22, 1, 0.36, 1); }
.glass { background: rgba(255, 255, 255, 0.8); backdrop-filter: blur(12px); }
.glass-dark { background: rgba(15, 23, 42, 0.85); backdrop-filter: blur(12px); }
.field-input {
transition: all 0.2s cubic-bezier(0.22, 1, 0.36, 1);
border: 1.5px solid var(--border);
background: #FAFBFC;
font-family: 'Courier New', Consolas, monospace;
font-size: 13px;
}
.field-input:hover { border-color: #CBD5E1; background: #FFFFFF; }
.field-input:focus { border-color: var(--primary); box-shadow: 0 0 0 3px var(--primary-glow); outline: none; background: #FFFFFF; }
.field-input.has-error { border-color: var(--danger); box-shadow: 0 0 0 3px rgba(239, 68, 68, 0.15); }
.toggle-switch { position: relative; width: 48px; height: 26px; flex-shrink: 0; }
.toggle-switch input { opacity: 0; width: 0; height: 0; position: absolute; }
.toggle-slider {
position: absolute; cursor: pointer; inset: 0;
background: #CBD5E1; border-radius: 26px;
transition: all 0.3s cubic-bezier(0.22, 1, 0.36, 1);
}
.toggle-slider:before {
content: ""; position: absolute;
height: 20px; width: 20px; left: 3px; bottom: 3px;
background: white; border-radius: 50%;
transition: all 0.3s cubic-bezier(0.22, 1, 0.36, 1);
box-shadow: 0 1px 3px rgba(0,0,0,0.15);
}
input:checked + .toggle-slider { background: var(--primary); }
input:checked + .toggle-slider:before { transform: translateX(22px); }
.modified-bar {
width: 3px; border-radius: 0 2px 2px 0;
background: linear-gradient(180deg, var(--primary), var(--accent));
position: absolute; left: 0; top: 8px; bottom: 8px;
transition: all 0.3s cubic-bezier(0.22, 1, 0.36, 1);
}
.tooltip-wrap { position: relative; }
.tooltip-wrap .tip-text {
visibility: hidden; opacity: 0;
background: var(--bg-sidebar); color: var(--text-light);
padding: 8px 14px; border-radius: 8px; font-size: 12px;
line-height: 1.5;
position: absolute; z-index: 100; bottom: calc(100% + 8px);
left: 50%; transform: translateX(-50%) translateY(4px);
white-space: normal; max-width: 280px; min-width: 120px;
transition: all 0.2s cubic-bezier(0.22, 1, 0.36, 1);
pointer-events: none;
box-shadow: 0 8px 24px rgba(0,0,0,0.15);
}
.tooltip-wrap .tip-text::after {
content: ''; position: absolute; top: 100%; left: 50%;
transform: translateX(-50%);
border: 6px solid transparent; border-top-color: var(--bg-sidebar);
}
.tooltip-wrap:hover .tip-text { visibility: visible; opacity: 1; transform: translateX(-50%) translateY(0); }
.group-card {
transition: border-color 0.25s cubic-bezier(0.22, 1, 0.36, 1), box-shadow 0.25s cubic-bezier(0.22, 1, 0.36, 1);
border: 1px solid var(--border);
border-radius: 12px;
}
.group-card:hover { border-color: #CBD5E1; box-shadow: 0 4px 16px rgba(0,0,0,0.04); }
.field-row { transition: all 0.2s ease; position: relative; }
.field-row:hover { background: rgba(37, 99, 235, 0.02); }
.module-item {
transition: all 0.2s cubic-bezier(0.22, 1, 0.36, 1);
position: relative; overflow: hidden;
}
.module-item::before {
content: ''; position: absolute; inset: 0;
background: linear-gradient(135deg, rgba(37, 99, 235, 0.1), rgba(99, 102, 241, 0.05));
opacity: 0; transition: opacity 0.2s ease;
}
.module-item:hover::before { opacity: 1; }
.module-item.active {
background: linear-gradient(135deg, #2563EB, #4F46E5);
box-shadow: 0 4px 12px rgba(37, 99, 235, 0.3);
}
.module-item.active::before { opacity: 0; }
.type-badge { font-family: 'Courier New', Consolas, monospace; font-size: 11px; letter-spacing: 0.3px; }
.btn-save { background: linear-gradient(135deg, #2563EB, #4F46E5); transition: all 0.3s cubic-bezier(0.22, 1, 0.36, 1); }
.btn-save:hover { background: linear-gradient(135deg, #1D4ED8, #4338CA); box-shadow: 0 4px 12px rgba(37, 99, 235, 0.35); transform: translateY(-1px); }
.btn-save.saved { background: linear-gradient(135deg, #10B981, #059669); box-shadow: 0 4px 12px rgba(16, 185, 129, 0.35); }
.toast {
position: fixed; top: 20px; right: 20px; z-index: 200;
padding: 14px 20px; border-radius: 12px;
font-size: 14px; font-weight: 500;
box-shadow: 0 8px 32px rgba(0,0,0,0.12);
transform: translateX(120%);
transition: transform 0.4s cubic-bezier(0.22, 1, 0.36, 1);
}
.toast.show { transform: translateX(0); }
.toast.success { background: linear-gradient(135deg, #10B981, #059669); color: white; }
.toast.error { background: linear-gradient(135deg, #EF4444, #DC2626); color: white; }
.skeleton {
background: linear-gradient(90deg, #E2E8F0 25%, #F1F5F9 50%, #E2E8F0 75%);
background-size: 200% 100%; animation: shimmer 1.5s infinite; border-radius: 6px;
}
.status-dot { position: relative; }
.status-dot::after {
content: ''; position: absolute; inset: -3px;
border-radius: 50%; border: 2px solid currentColor;
opacity: 0; animation: pulseGlow 2s ease-in-out infinite;
}
</style>
</head>
<body>
<div id="app">
<div :class="['toast', toast.type, toast.show ? 'show' : '']">
<div class="flex items-center space-x-2">
<svg v-if="toast.type==='success'" class="w-5 h-5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 13l4 4L19 7"/></svg>
<svg v-else class="w-5 h-5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z"/></svg>
<span>{{ toast.message }}</span>
</div>
</div>
<header class="fixed top-0 left-0 right-0 glass z-50" style="height: var(--header-height); border-bottom: 1px solid rgba(226, 232, 240, 0.8);">
<div class="h-full flex items-center justify-between px-6">
<div class="flex items-center space-x-4">
<div class="flex items-center space-x-3">
<div class="w-9 h-9 rounded-xl flex items-center justify-center" style="background: linear-gradient(135deg, #2563EB, #4F46E5); box-shadow: 0 2px 8px rgba(37, 99, 235, 0.3);">
<svg class="w-5 h-5 text-white" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 15v-4H7l5-7v4h4l-5 7z"/></svg>
</div>
<div>
<h1 class="text-base font-semibold leading-tight" style="color: var(--text-primary);">GoFrame</h1>
<p class="text-xs" style="color: var(--text-muted);">Config Editor</p>
</div>
</div>
<div class="h-6 w-px bg-gray-200 mx-1"></div>
<span class="text-xs font-medium px-2.5 py-1 rounded-full" style="background: linear-gradient(135deg, rgba(37, 99, 235, 0.08), rgba(99, 102, 241, 0.08)); color: var(--primary);">v1.0</span>
</div>
<div class="flex items-center space-x-3">
<div class="relative">
<input v-model="searchQuery" type="text"
:placeholder="lang==='zh-CN' ? '搜索字段...' : 'Search fields...'"
class="w-48 text-sm pl-9 pr-3 py-2 rounded-lg border border-gray-200 bg-gray-50 focus:bg-white focus:border-blue-400 focus:ring-2 focus:ring-blue-100 outline-none transition-all">
<svg class="absolute left-3 top-2.5 w-4 h-4 text-gray-400" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"/></svg>
</div>
<div class="flex items-center bg-gray-100 rounded-lg p-0.5" style="border: 1px solid var(--border);">
<button @click="switchLang('en')" :class="['px-3 py-1.5 rounded-md text-xs font-semibold tracking-wide transition-all', lang==='en' ? 'bg-white shadow-sm text-blue-600' : 'text-gray-500 hover:text-gray-700']">EN</button>
<button @click="switchLang('zh-CN')" :class="['px-3 py-1.5 rounded-md text-xs font-semibold tracking-wide transition-all', lang==='zh-CN' ? 'bg-white shadow-sm text-blue-600' : 'text-gray-500 hover:text-gray-700']">中文</button>
</div>
<div class="relative">
<select v-model="exportFormat" class="appearance-none text-sm font-medium border border-gray-200 rounded-lg pl-3 pr-8 py-2 bg-white hover:border-gray-300 focus:ring-2 focus:ring-blue-100 focus:border-blue-400 outline-none transition-all cursor-pointer" style="color: var(--text-primary);">
<option value="yaml">YAML</option>
<option value="toml">TOML</option>
<option value="json">JSON</option>
</select>
<svg class="absolute right-2.5 top-3 w-3.5 h-3.5 text-gray-400 pointer-events-none" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 9l-7 7-7-7"/></svg>
</div>
<button @click="saveConfig" :class="['btn-save flex items-center space-x-2 px-5 py-2 rounded-lg text-sm font-semibold text-white', saving ? 'saved save-anim' : '']" :disabled="saving">
<svg v-if="!saving" class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8 7H5a2 2 0 00-2 2v9a2 2 0 002 2h14a2 2 0 002-2V9a2 2 0 00-2-2h-3m-1 4l-3 3m0 0l-3-3m3 3V4"/></svg>
<svg v-else class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2.5" d="M5 13l4 4L19 7" style="stroke-dasharray: 24; animation: checkmark 0.4s ease forwards;"/></svg>
<span>{{ saving ? (lang==='zh-CN'?'已保存':'Saved!') : (lang==='zh-CN'?'保存配置':'Save') }}</span>
</button>
</div>
</div>
</header>
<div class="flex" style="padding-top: var(--header-height);">
<aside class="fixed left-0 bottom-0 sidebar-scroll overflow-y-auto" style="top: var(--header-height); width: var(--sidebar-width); background: var(--bg-sidebar); padding-bottom: var(--footer-height);">
<div class="px-5 pt-5 pb-3">
<div class="text-xs font-bold uppercase tracking-widest" style="color: #475569;">
{{ lang==='zh-CN' ? '配置模块' : 'MODULES' }}
</div>
</div>
<div class="px-3 space-y-1">
<div v-for="(schema, idx) in schemas" :key="schema.name" :style="{ animationDelay: idx * 50 + 'ms' }" class="fade-in">
<button @click="selectModule(schema.name)"
:class="['module-item w-full flex items-center justify-between px-3 py-3 rounded-xl text-sm font-medium', activeModule===schema.name ? 'active text-white' : 'text-gray-400 hover:text-gray-200']">
<div class="flex items-center space-x-3 relative z-10">
<span class="w-9 h-9 rounded-lg flex items-center justify-center text-base"
:style="{ background: activeModule===schema.name ? 'rgba(255,255,255,0.18)' : 'rgba(255,255,255,0.04)', boxShadow: activeModule===schema.name ? 'inset 0 1px 0 rgba(255,255,255,0.1)' : 'none' }">
{{ moduleIcons[schema.name] }}
</span>
<span class="relative z-10">{{ formatModuleName(schema.name) }}</span>
</div>
<div class="flex items-center space-x-2 relative z-10">
<span v-if="getModuleModifiedCount(schema.name) > 0" class="flex items-center justify-center w-5 h-5 rounded-full text-xs font-bold" style="background: rgba(37, 99, 235, 0.2); color: #93C5FD;">
{{ getModuleModifiedCount(schema.name) }}
</span>
<span class="text-xs opacity-50">{{ schema.fields.length }}</span>
</div>
</button>
<div v-show="activeModule===schema.name" class="ml-4 mt-1 mb-2 space-y-0.5 slide-in-left">
<button v-for="group in schema.groups" :key="group"
@click="scrollToGroup(group)"
:class="['w-full text-left flex items-center space-x-2 px-3 py-1.5 rounded-lg text-xs transition-all relative', activeGroup===group ? 'text-blue-400' : 'text-gray-600 hover:text-gray-400']">
<span class="w-1.5 h-1.5 rounded-full" :style="{ background: groupHasModified(schema, group) ? '#3B82F6' : activeGroup===group ? '#3B82F6' : '#334155' }"></span>
<span>{{ group }}</span>
<span class="ml-auto text-xs opacity-40">{{ getGroupFieldCount(schema, group) }}</span>
</button>
</div>
</div>
</div>
<div class="px-5 py-4 mt-4" style="border-top: 1px solid rgba(255,255,255,0.05);">
<div class="text-xs" style="color: #475569;">
<div class="flex items-center space-x-2 mb-1">
<span class="w-2 h-2 rounded-full bg-green-500"></span>
<span>{{ schemas.length }} {{ lang==='zh-CN' ? '个模块已加载' : 'modules loaded' }}</span>
</div>
<div class="flex items-center space-x-2">
<span class="w-2 h-2 rounded-full" :class="modifiedCount > 0 ? 'bg-blue-500' : 'bg-gray-600'"></span>
<span>{{ modifiedCount }} {{ lang==='zh-CN' ? '处修改' : 'changes' }}</span>
</div>
</div>
</div>
</aside>
<main class="flex-1 min-h-screen" style="margin-left: var(--sidebar-width); padding-bottom: calc(var(--footer-height) + 24px);">
<div v-if="loading" class="p-6">
<div class="max-w-4xl mx-auto space-y-4">
<div class="skeleton h-10 w-64 mb-6"></div>
<div v-for="i in 3" :key="i" class="bg-white rounded-xl border p-6 space-y-4">
<div class="skeleton h-6 w-40"></div>
<div v-for="j in 4" :key="j" class="flex items-center space-x-4">
<div class="skeleton h-4 w-32"></div>
<div class="skeleton h-9 flex-1"></div>
</div>
</div>
</div>
</div>
<div v-else-if="!currentSchema" class="flex items-center justify-center h-64">
<div class="text-center">
<div class="w-16 h-16 mx-auto mb-4 rounded-2xl flex items-center justify-center" style="background: linear-gradient(135deg, rgba(37,99,235,0.08), rgba(99,102,241,0.08));">
<svg class="w-8 h-8" style="color: var(--primary);" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" d="M10.325 4.317c.426-1.756 2.924-1.756 3.35 0a1.724 1.724 0 002.573 1.066c1.543-.94 3.31.826 2.37 2.37a1.724 1.724 0 001.066 2.573c1.756.426 1.756 2.924 0 3.35a1.724 1.724 0 00-1.066 2.573c.94 1.543-.826 3.31-2.37 2.37a1.724 1.724 0 00-2.573 1.066c-.426 1.756-2.924 1.756-3.35 0a1.724 1.724 0 00-2.573-1.066c-1.543.94-3.31-.826-2.37-2.37a1.724 1.724 0 00-1.066-2.573c-1.756-.426-1.756-2.924 0-3.35a1.724 1.724 0 001.066-2.573c-.94-1.543.826-3.31 2.37-2.37.996.608 2.296.07 2.572-1.065z"/><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" d="M15 12a3 3 0 11-6 0 3 3 0 016 0z"/></svg>
</div>
<p class="text-sm font-medium" style="color: var(--text-secondary);">{{ lang==='zh-CN' ? '请从左侧选择一个配置模块' : 'Select a module from the sidebar' }}</p>
</div>
</div>
<div v-else class="p-6">
<div class="max-w-4xl mx-auto">
<div class="mb-6 fade-in-up">
<div class="flex items-center space-x-3 mb-2">
<span class="text-2xl">{{ moduleIcons[currentSchema.name] }}</span>
<h1 class="text-2xl font-bold" style="color: var(--text-primary);">
{{ formatModuleName(currentSchema.name) }}
<span class="text-lg font-normal" style="color: var(--text-muted);">{{ lang==='zh-CN' ? '配置' : 'Configuration' }}</span>
</h1>
</div>
<div class="flex items-center space-x-4 text-sm" style="color: var(--text-secondary);">
<span class="flex items-center space-x-1.5">
<svg class="w-4 h-4" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h7"/></svg>
<span>{{ filteredFieldCount }} {{ lang==='zh-CN' ? '个字段' : 'fields' }}</span>
</span>
<span class="flex items-center space-x-1">
<span style="color: var(--text-muted);">{{ lang==='zh-CN' ? '配置节点' : 'Node' }}:</span>
<code class="px-2 py-0.5 rounded-md text-xs font-mono" style="background: rgba(37,99,235,0.06); color: var(--primary);">{{ currentSchema.configNode }}</code>
</span>
</div>
<!-- 配置组选择器 -->
<div v-if="showConfigGroupSelector" class="mt-4 flex items-center space-x-3">
<span class="text-sm font-medium" style="color: var(--text-secondary);">
{{ lang==='zh-CN' ? '配置组' : 'Config Group' }}:
</span>
<div class="flex items-center bg-gray-100 rounded-lg p-0.5" style="border: 1px solid var(--border);">
<button v-for="group in configGroups" :key="group"
@click="selectConfigGroup(group)"
:class="['px-3 py-1.5 rounded-md text-xs font-semibold tracking-wide transition-all', activeConfigGroup===group ? 'bg-white shadow-sm text-blue-600' : 'text-gray-500 hover:text-gray-700']">
{{ group }}
</button>
</div>
<span v-if="activeConfigGroup" class="text-xs px-2 py-0.5 rounded-full" style="background: rgba(37,99,235,0.08); color: var(--primary);">
{{ activeConfigGroup }}
</span>
</div>
</div>
<div v-for="(group, gIdx) in currentSchema.groups" :key="group" :id="'group-'+group"
:style="{ animationDelay: gIdx * 60 + 'ms' }"
class="group-card bg-white mb-4 overflow-hidden fade-in-up"
v-show="getFilteredGroupFields(group).length > 0">
<button @click="toggleGroup(group)"
class="w-full flex items-center justify-between px-6 py-4 hover:bg-gray-50 transition-colors group">
<div class="flex items-center space-x-3">
<div class="w-8 h-8 rounded-lg flex items-center justify-center transition-colors"
:style="{ background: expandedGroups[group] ? 'linear-gradient(135deg, rgba(37,99,235,0.1), rgba(99,102,241,0.1))' : '#F8FAFC' }">
<svg :class="['w-4 h-4 transition-all duration-300', expandedGroups[group] ? '' : '-rotate-90']"
:style="{ color: expandedGroups[group] ? 'var(--primary)' : 'var(--text-muted)' }"
fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 9l-7 7-7-7"/></svg>
</div>
<h2 class="text-sm font-semibold tracking-wide" style="color: var(--text-primary);">{{ group }}</h2>
<span class="text-xs font-medium px-2 py-0.5 rounded-full" style="background: var(--border-light); color: var(--text-muted);">{{ getFilteredGroupFields(group).length }}</span>
<span v-if="groupHasModified(currentSchema, group)" class="flex items-center space-x-1 text-xs font-medium px-2 py-0.5 rounded-full" style="background: var(--primary-glow); color: var(--primary);">
<span class="w-1.5 h-1.5 rounded-full bg-blue-500"></span>
<span>{{ lang==='zh-CN' ? '已修改' : 'Modified' }}</span>
</span>
</div>
<div class="flex items-center space-x-2">
<span v-if="groupHasModified(currentSchema, group)" @click.stop="resetGroup(group)"
class="opacity-0 group-hover:opacity-100 text-xs px-2.5 py-1 rounded-md hover:bg-red-50 transition-all cursor-pointer select-none" style="color: var(--danger);">
{{ lang==='zh-CN' ? '重置分组' : 'Reset Group' }}
</span>
</div>
</button>
<div v-if="expandedGroups[group]" class="border-t" style="border-color: var(--border-light);">
<div v-for="(field, fIdx) in getFilteredGroupFields(group)" :key="field.jsonKey"
:style="{ animationDelay: fIdx * 30 + 'ms' }"
class="field-row px-6 py-4 border-b last:border-0 fade-in" style="border-color: var(--border-light);">
<div v-if="isModified(field)" class="modified-bar"></div>
<div class="flex items-start gap-4">
<div class="flex-1 min-w-0">
<div class="flex items-center flex-wrap gap-2 mb-1">
<span class="text-sm font-semibold" style="color: var(--text-primary);">{{ field.name }}</span>
<code class="text-xs font-mono px-1.5 py-0.5 rounded" style="background: #F1F5F9; color: var(--text-secondary);">{{ field.jsonKey }}</code>
<span :class="['type-badge px-1.5 py-0.5 rounded', typeColorClass(field.type)]">{{ field.type }}</span>
<span v-if="field.rule" class="type-badge px-1.5 py-0.5 rounded" style="background: rgba(245, 158, 11, 0.08); color: #D97706;">{{ field.rule }}</span>
</div>
<p class="text-xs leading-relaxed" style="color: var(--text-secondary);">{{ getFieldDescription(field) }}</p>
<div v-if="field.default" class="flex items-center mt-1.5 text-xs" style="color: var(--text-muted);">
<span>{{ lang==='zh-CN' ? '默认' : 'Default' }}:</span>
<code class="ml-1 font-mono px-1.5 py-0.5 rounded" style="background: #F8FAFC; color: var(--text-secondary);">{{ field.default }}</code>
</div>
</div>
<div class="flex items-center gap-2 flex-shrink-0" style="width: 280px;">
<template v-if="field.type === 'bool'">
<div class="flex items-center space-x-3 w-full justify-end">
<span class="text-xs font-medium" :style="{ color: getFieldValue(field) ? 'var(--primary)' : 'var(--text-muted)' }">
{{ getFieldValue(field) ? (lang==='zh-CN'?'开启':'ON') : (lang==='zh-CN'?'关闭':'OFF') }}
</span>
<label class="toggle-switch">
<input type="checkbox" :checked="getFieldValue(field)" @change="setFieldValue(field, $event.target.checked)">
<span class="toggle-slider"></span>
</label>
</div>
</template>
<template v-else-if="field.type === 'duration'">
<input type="text"
:value="getFieldValue(field) !== undefined ? getFieldValue(field) : ''"
@input="setFieldValue(field, $event.target.value)"
@blur="validateField(field)"
:placeholder="field.default || 'e.g. 30s, 1m, 1h'"
class="field-input w-full text-sm px-3 py-2 rounded-lg">
</template>
<template v-else-if="field.type === 'int' || field.type === 'float'">
<input type="number"
:value="getFieldValue(field) !== undefined ? getFieldValue(field) : ''"
@input="setFieldValue(field, $event.target.value)"
@blur="validateField(field)"
:placeholder="field.default || '0'"
class="field-input w-full text-sm px-3 py-2 rounded-lg">
</template>
<template v-else-if="field.type === 'map' || field.type.startsWith('[]')">
<textarea
:value="getFieldValue(field) !== undefined ? JSON.stringify(getFieldValue(field), null, 2) : ''"
@input="setJSONFieldValue(field, $event.target.value)"
@blur="validateField(field)"
:placeholder="field.default || (field.type === 'map' ? '{key: value}' : '[item1, item2]')"
rows="2"
class="field-input w-full text-sm px-3 py-2 rounded-lg resize-y"
style="min-height: 36px;"></textarea>
</template>
<template v-else>
<input type="text"
:value="getFieldValue(field) !== undefined ? getFieldValue(field) : ''"
@input="setFieldValue(field, $event.target.value)"
@blur="validateField(field)"
:placeholder="field.default || ''"
class="field-input w-full text-sm px-3 py-2 rounded-lg">
</template>
<button v-if="isModified(field)" @click="resetField(field)"
class="tooltip-wrap p-2 rounded-lg hover:bg-red-50 transition-all flex-shrink-0 group">
<svg class="w-4 h-4 transition-colors" style="color: var(--text-muted);" fill="none" stroke="currentColor" viewBox="0 0 24 24">
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 4v5h.582m15.356 2A8.001 8.001 0 004.582 9m0 0H9m11 11v-5h-.581m0 0a8.003 8.003 0 01-15.357-2m15.357 2H15"/>
</svg>
<span class="tip-text">{{ lang==='zh-CN' ? '恢复默认值' : 'Reset to default' }}</span>
</button>
</div>
</div>
<div v-if="fieldErrors[activeModule+'.'+field.jsonKey]" class="mt-2 flex items-center space-x-1.5 text-xs" style="color: var(--danger);">
<svg class="w-3.5 h-3.5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z"/></svg>
<span>{{ fieldErrors[activeModule+'.'+field.jsonKey] }}</span>
</div>
</div>
</div>
</div>
<div v-if="searchQuery && filteredFieldCount === 0" class="text-center py-12">
<svg class="w-12 h-12 mx-auto mb-3" style="color: var(--text-muted);" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"/></svg>
<p class="text-sm font-medium" style="color: var(--text-secondary);">
{{ lang==='zh-CN' ? '没有找到匹配的字段' : 'No matching fields found' }}
</p>
</div>
</div>
</div>
</main>
</div>
<footer class="fixed bottom-0 left-0 right-0 glass flex items-center justify-between px-6 text-xs z-40"
style="height: var(--footer-height); border-top: 1px solid rgba(226, 232, 240, 0.8); color: var(--text-secondary);">
<div class="flex items-center space-x-4">
<span v-if="configFilePath" class="flex items-center space-x-1.5">
<svg class="w-3.5 h-3.5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3 7v10a2 2 0 002 2h14a2 2 0 002-2V9a2 2 0 00-2-2h-6l-2-2H5a2 2 0 00-2 2z"/></svg>
<span class="font-mono">{{ configFilePath }}</span>
</span>
<span v-else class="flex items-center space-x-1.5" style="color: var(--text-muted);">
<svg class="w-3.5 h-3.5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z"/></svg>
<span>{{ lang==='zh-CN' ? '未加载配置文件' : 'No config file loaded' }}</span>
</span>
</div>
<div class="flex items-center space-x-4">
<span v-if="modifiedCount > 0" class="flex items-center space-x-1.5 font-medium" style="color: var(--primary);">
<span class="w-1.5 h-1.5 rounded-full bg-blue-500 status-dot"></span>
<span>{{ modifiedCount }} {{ lang==='zh-CN' ? '处修改' : 'change(s)' }}</span>
</span>
<span v-if="lastSaved" class="flex items-center space-x-1.5" style="color: var(--success);">
<svg class="w-3.5 h-3.5" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 13l4 4L19 7"/></svg>
<span>{{ lang==='zh-CN' ? '已保存' : 'Saved' }} {{ lastSaved }}</span>
</span>
<span class="font-mono opacity-60">GoFrame Config Editor v1.0</span>
</div>
</footer>
</div>
<script>
const { createApp, ref, computed, onMounted, reactive, nextTick } = Vue;
createApp({
setup() {
const schemas = ref([]);
const activeModule = ref('');
const activeGroup = ref('');
const activeConfigGroup = ref(''); // 当前选择的配置组,如 "default", "cache", "disk"
const lang = ref('en');
const i18nData = ref({});
const configData = ref({});
const editedValues = reactive({});
const fieldErrors = reactive({});
const expandedGroups = reactive({});
const loading = ref(true);
const saving = ref(false);
const configFilePath = ref('');
const configFileType = ref('yaml');
const exportFormat = ref('yaml');
const lastSaved = ref('');
const searchQuery = ref('');
const toast = reactive({ show: false, type: 'success', message: '' });
const moduleIcons = { server: '\u{1F310}', database: '\u{1F5C4}', redis: '\u26A1', logger: '\u{1F4DD}', viewer: '\u{1F3A8}' };
const currentSchema = computed(() => schemas.value.find(s => s.name === activeModule.value));
// 计算当前模块的配置组列表
const configGroups = computed(() => {
if (!currentSchema.value || !configData.value) return [];
const moduleData = configData.value[currentSchema.value.configNode];
if (!moduleData || typeof moduleData !== 'object') return [];
// 获取所有配置组名称(排除非对象类型的键)
const groups = [];
for (const key of Object.keys(moduleData)) {
const val = moduleData[key];
if (val && typeof val === 'object') {
groups.push(key);
}
}
return groups.sort();
});
// 判断是否需要显示配置组选择器(有多个配置组时才显示)
const showConfigGroupSelector = computed(() => configGroups.value.length > 1);
const modifiedCount = computed(() => Object.keys(editedValues).length);
const filteredFieldCount = computed(() => {
if (!currentSchema.value) return 0;
if (!searchQuery.value) return currentSchema.value.fields.length;
return currentSchema.value.fields.filter(f => matchSearch(f)).length;
});
function showToast(type, message) {
toast.type = type; toast.message = message; toast.show = true;
setTimeout(() => { toast.show = false; }, 3000);
}
function formatModuleName(name) { return name.charAt(0).toUpperCase() + name.slice(1); }
function matchSearch(field) {
if (!searchQuery.value) return true;
const q = searchQuery.value.toLowerCase();
const desc = lang.value !== 'en' && field.i18nKey && i18nData.value[field.i18nKey]
? i18nData.value[field.i18nKey] : (field.description || '');
return field.name.toLowerCase().includes(q) ||
field.jsonKey.toLowerCase().includes(q) ||
desc.toLowerCase().includes(q) ||
field.type.toLowerCase().includes(q);
}
function selectModule(name) {
activeModule.value = name;
activeConfigGroup.value = ''; // 切换模块时重置配置组选择
const schema = schemas.value.find(s => s.name === name);
if (schema) {
schema.groups.forEach(g => { if (!(g in expandedGroups)) expandedGroups[g] = true; });
}
// 自动选择第一个配置组
nextTick(() => {
if (configGroups.value.length > 0) {
activeConfigGroup.value = configGroups.value[0];
}
});
}
// 选择配置组
function selectConfigGroup(groupName) {
activeConfigGroup.value = groupName;
}
function toggleGroup(group) { expandedGroups[group] = !expandedGroups[group]; }
function scrollToGroup(group) {
activeGroup.value = group;
expandedGroups[group] = true;
nextTick(() => {
const el = document.getElementById('group-' + group);
if (el) el.scrollIntoView({ behavior: 'smooth', block: 'start' });
});
}
function getGroupFields(group) {
if (!currentSchema.value) return [];
return currentSchema.value.fields.filter(f => f.group === group);
}
function getFilteredGroupFields(group) { return getGroupFields(group).filter(f => matchSearch(f)); }
function getGroupFieldCount(schema, group) { return schema.fields.filter(f => f.group === group).length; }
// findValueInObj returns the value for key from obj using a case-insensitive match.
function findValueInObj(obj, key) {
if (!obj || typeof obj !== 'object') return undefined;
if (key in obj) return obj[key];
const lk = key.toLowerCase();
for (const k of Object.keys(obj)) {
if (k.toLowerCase() === lk) return obj[k];
}
return undefined;
}
// resolveConfigValue finds the actual config value for a field,
// handling nested structures like database.default.host and redis.default.address.
function resolveConfigValue(moduleData, field) {
if (!moduleData) return undefined;
const key = field.jsonKey;
// 如果选择了配置组,直接从该组获取值
if (activeConfigGroup.value && moduleData[activeConfigGroup.value]) {
const groupData = moduleData[activeConfigGroup.value];
// 处理数组形式(如 database.default 是数组)
if (Array.isArray(groupData) && groupData.length > 0) {
return findValueInObj(groupData[0], key);
}
// 处理对象形式(如 redis.default 是对象)
if (typeof groupData === 'object') {
return findValueInObj(groupData, key);
}
}
// 1. Direct lookup.
const direct = findValueInObj(moduleData, key);
if (direct !== undefined) return direct;
// 2. Nested group lookup — GoFrame stores database/redis configs under
// group names like "default", e.g. database.default.host.
for (const groupKey of Object.keys(moduleData)) {
const groupVal = moduleData[groupKey];
if (!groupVal || typeof groupVal !== 'object') continue;
// Object form: { host: "...", port: "..." }
if (!Array.isArray(groupVal)) {
const nested = findValueInObj(groupVal, key);
if (nested !== undefined) return nested;
}
// Array form: [{ host: "...", port: "..." }] — take first element.
if (Array.isArray(groupVal) && groupVal.length > 0) {
const nested = findValueInObj(groupVal[0], key);
if (nested !== undefined) return nested;
}
}
return undefined;
}
function getFieldValue(field) {
const key = activeModule.value + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '') + field.jsonKey;
if (key in editedValues) return editedValues[key];
if (!currentSchema.value) return undefined;
const moduleData = configData.value[currentSchema.value.configNode];
return resolveConfigValue(moduleData, field);
}
function setFieldValue(field, value) {
const key = activeModule.value + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '') + field.jsonKey;
editedValues[key] = value;
delete fieldErrors[key];
}
function setJSONFieldValue(field, rawValue) {
const key = activeModule.value + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '') + field.jsonKey;
try {
editedValues[key] = JSON.parse(rawValue);
delete fieldErrors[key];
} catch (e) {
if (rawValue.trim() === '') {
delete editedValues[key];
delete fieldErrors[key];
} else {
fieldErrors[key] = lang.value === 'zh-CN' ? '无效的 JSON 格式' : 'Invalid JSON format';
}
}
}
function resetField(field) {
const key = activeModule.value + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '') + field.jsonKey;
delete editedValues[key];
delete fieldErrors[key];
}
function resetGroup(group) { getGroupFields(group).forEach(f => resetField(f)); }
function isModified(field) {
const key = activeModule.value + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '') + field.jsonKey;
return key in editedValues;
}
function groupHasModified(schema, group) {
const prefix = schema.name + '.' + (activeConfigGroup.value ? activeConfigGroup.value + '.' : '');
return schema.fields.filter(f => f.group === group).some(f => (prefix + f.jsonKey) in editedValues);
}
function getModuleModifiedCount(moduleName) {
return Object.keys(editedValues).filter(k => k.startsWith(moduleName + '.')).length;
}
function getFieldDescription(field) {
if (lang.value !== 'en' && field.i18nKey && i18nData.value[field.i18nKey]) {
return i18nData.value[field.i18nKey];
}
return field.description || '';
}
function typeColorClass(type) {
const map = { 'string': 'bg-green-50 text-green-700', 'int': 'bg-blue-50 text-blue-700',
'bool': 'bg-purple-50 text-purple-700', 'duration': 'bg-amber-50 text-amber-700',
'float': 'bg-indigo-50 text-indigo-700', 'map': 'bg-pink-50 text-pink-700' };
if (type.startsWith('[]')) return 'bg-orange-50 text-orange-700';
return map[type] || 'bg-gray-100 text-gray-600';
}
function validateField(field) {
const key = activeModule.value + '.' + field.jsonKey;
const value = getFieldValue(field);
if (field.rule && field.rule.includes('required') && (!value || value === '')) {
fieldErrors[key] = (lang.value === 'zh-CN' ? '此字段为必填项' : 'This field is required');
return;
}
delete fieldErrors[key];
}
async function switchLang(newLang) {
lang.value = newLang;
if (newLang !== 'en') {
try {
const res = await fetch('/api/i18n/' + newLang);
const json = await res.json();
if (json.code === 0) i18nData.value = json.data || {};
} catch (e) { console.error('Failed to load i18n', e); }
}
}
// setNestedValue updates fieldKey inside moduleData in-place,
// handling nested structures like database.default.host and redis.default.address.
function setNestedValue(moduleData, fieldKey, value) {
const lk = fieldKey.toLowerCase();
// 1. Direct update.
for (const k of Object.keys(moduleData)) {
if (k.toLowerCase() === lk) { moduleData[k] = value; return true; }
}
// 2. Look inside nested group objects.
for (const groupKey of Object.keys(moduleData)) {
const groupVal = moduleData[groupKey];
if (!groupVal || typeof groupVal !== 'object') continue;
if (!Array.isArray(groupVal)) {
for (const k of Object.keys(groupVal)) {
if (k.toLowerCase() === lk) { groupVal[k] = value; return true; }
}
}
if (Array.isArray(groupVal) && groupVal.length > 0) {
for (const k of Object.keys(groupVal[0])) {
if (k.toLowerCase() === lk) { groupVal[0][k] = value; return true; }
}
}
}
return false;
}
// 获取指定模块的配置组列表
function configGroupsForModule(moduleName) {
const schema = schemas.value.find(s => s.name === moduleName);
if (!schema || !configData.value) return [];
const moduleData = configData.value[schema.configNode];
if (!moduleData || typeof moduleData !== 'object') return [];
const groups = [];
for (const key of Object.keys(moduleData)) {
const val = moduleData[key];
if (val && typeof val === 'object') {
groups.push(key);
}
}
return groups;
}
async function saveConfig() {
const merged = JSON.parse(JSON.stringify(configData.value || {}));
for (const [key, value] of Object.entries(editedValues)) {
const parts = key.split('.');
const moduleName = parts[0];
const schema = schemas.value.find(s => s.name === moduleName);
if (!schema) continue;
const configNode = schema.configNode;
if (!merged[configNode]) merged[configNode] = {};
// 检查是否有配置组(如 redis.cache.address 中的 cache
const configGroups = configGroupsForModule(moduleName);
if (configGroups.length > 0 && parts.length >= 3) {
// 格式: module.configGroup.fieldKey
const groupName = parts[1];
const fieldKey = parts.slice(2).join('.');
if (!merged[configNode][groupName]) {
merged[configNode][groupName] = {};
}
const groupData = merged[configNode][groupName];
if (Array.isArray(groupData) && groupData.length > 0) {
groupData[0][fieldKey] = value;
} else if (typeof groupData === 'object') {
groupData[fieldKey] = value;
}
} else {
// 格式: module.fieldKey无配置组
const fieldKey = parts.slice(1).join('.');
if (!setNestedValue(merged[configNode], fieldKey, value)) {
merged[configNode][fieldKey] = value;
}
}
}
saving.value = true;
try {
const res = await fetch('/api/config/save', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
config: merged,
filePath: configFilePath.value || '',
fileType: exportFormat.value,
})
});
const json = await res.json();
if (json.code === 0) {
lastSaved.value = new Date().toLocaleTimeString();
if (json.data && json.data.filePath) configFilePath.value = json.data.filePath;
showToast('success', lang.value === 'zh-CN' ? '配置保存成功' : 'Configuration saved successfully');
} else {
showToast('error', (lang.value === 'zh-CN' ? '保存失败: ' : 'Save failed: ') + json.message);
}
} catch (e) {
showToast('error', (lang.value === 'zh-CN' ? '保存错误: ' : 'Save error: ') + e.message);
}
setTimeout(() => { saving.value = false; }, 2000);
}
document.addEventListener('keydown', (e) => {
if ((e.ctrlKey || e.metaKey) && e.key === 's') {
e.preventDefault();
if (!saving.value) saveConfig();
}
});
onMounted(async () => {
try {
const [schemaRes, cfgRes] = await Promise.all([
fetch('/api/schemas'),
fetch('/api/config')
]);
const schemaJson = await schemaRes.json();
if (schemaJson.code === 0) {
schemas.value = schemaJson.data || [];
if (schemas.value.length > 0) selectModule(schemas.value[0].name);
}
const cfgJson = await cfgRes.json();
if (cfgJson.code === 0 && cfgJson.data) {
configData.value = cfgJson.data.config || {};
configFilePath.value = cfgJson.data.filePath || '';
configFileType.value = cfgJson.data.fileType || 'yaml';
exportFormat.value = cfgJson.data.fileType || 'yaml';
}
} catch (e) {
console.error('Failed to load data', e);
showToast('error', 'Failed to load configuration data');
}
loading.value = false;
});
return {
schemas, activeModule, activeGroup, activeConfigGroup, lang, i18nData, configData,
editedValues, fieldErrors, expandedGroups, loading, saving, configFilePath,
configFileType, exportFormat, lastSaved, moduleIcons, searchQuery,
toast, currentSchema, modifiedCount, filteredFieldCount,
configGroups, showConfigGroupSelector,
showToast, formatModuleName, matchSearch,
selectModule, selectConfigGroup, toggleGroup, scrollToGroup,
getGroupFields, getFilteredGroupFields, getGroupFieldCount,
getFieldValue, setFieldValue, setJSONFieldValue, resetField, resetGroup,
isModified, groupHasModified, getModuleModifiedCount,
getFieldDescription, typeColorClass, validateField,
switchLang, saveConfig,
};
}
}).mount('#app');
</script>
</body>
</html>

View File

@ -4,7 +4,7 @@ go 1.23.0
toolchain go1.24.6
require github.com/gogf/gf/v2 v2.9.8
require github.com/gogf/gf/v2 v2.10.0
require (
go.opentelemetry.io/otel v1.38.0 // indirect

View File

@ -0,0 +1,34 @@
package issue4242
import (
"context"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/issue/4242/service"
"github.com/gogf/gf/contrib/drivers/mysql/v2"
)
func init() {
service.RegisterIssue4242(New())
}
type sIssue4242 struct {
}
func New() *sIssue4242 {
return &sIssue4242{}
}
// GetDriver tests versioned import path is preserved.
func (s *sIssue4242) GetDriver(ctx context.Context) (d mysql.Driver, err error) {
return mysql.Driver{}, nil
}
// GetRequest tests another versioned import.
func (s *sIssue4242) GetRequest(ctx context.Context) (*ghttp.Request, error) {
g.Log().Info(ctx, "getting request")
return nil, nil
}

View File

@ -0,0 +1,37 @@
package issue4242alias
import (
"context"
// Anonymous import (should be skipped)
_ "github.com/gogf/gf/v2/os/gres"
// Versioned import without alias
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/issue/4242/service"
// Explicit alias import
mysqlDriver "github.com/gogf/gf/contrib/drivers/mysql/v2"
)
func init() {
service.RegisterIssue4242Alias(New())
}
type sIssue4242Alias struct {
}
func New() *sIssue4242Alias {
return &sIssue4242Alias{}
}
// GetDriver tests explicit alias import.
func (s *sIssue4242Alias) GetDriver(ctx context.Context) (d mysqlDriver.Driver, err error) {
return mysqlDriver.Driver{}, nil
}
// GetRequest tests versioned import.
func (s *sIssue4242Alias) GetRequest(ctx context.Context) (*ghttp.Request, error) {
return nil, nil
}

View File

@ -0,0 +1,10 @@
// ==========================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// ==========================================================================
package logic
import (
_ "github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/issue/4242/logic/issue4242"
_ "github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/issue/4242/logic/issue4242alias"
)

View File

@ -0,0 +1,37 @@
// ================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// You can delete these comments if you wish manually maintain this interface file.
// ================================================================================
package service
import (
"context"
"github.com/gogf/gf/contrib/drivers/mysql/v2"
"github.com/gogf/gf/v2/net/ghttp"
)
type (
IIssue4242 interface {
// GetDriver tests versioned import path is preserved.
GetDriver(ctx context.Context) (d mysql.Driver, err error)
// GetRequest tests another versioned import.
GetRequest(ctx context.Context) (*ghttp.Request, error)
}
)
var (
localIssue4242 IIssue4242
)
func Issue4242() IIssue4242 {
if localIssue4242 == nil {
panic("implement not found for interface IIssue4242, forgot register?")
}
return localIssue4242
}
func RegisterIssue4242(i IIssue4242) {
localIssue4242 = i
}

View File

@ -0,0 +1,37 @@
// ================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// You can delete these comments if you wish manually maintain this interface file.
// ================================================================================
package service
import (
"context"
mysqlDriver "github.com/gogf/gf/contrib/drivers/mysql/v2"
"github.com/gogf/gf/v2/net/ghttp"
)
type (
IIssue4242Alias interface {
// GetDriver tests explicit alias import.
GetDriver(ctx context.Context) (d mysqlDriver.Driver, err error)
// GetRequest tests versioned import.
GetRequest(ctx context.Context) (*ghttp.Request, error)
}
)
var (
localIssue4242Alias IIssue4242Alias
)
func Issue4242Alias() IIssue4242Alias {
if localIssue4242Alias == nil {
panic("implement not found for interface IIssue4242Alias, forgot register?")
}
return localIssue4242Alias
}
func RegisterIssue4242Alias(i IIssue4242Alias) {
localIssue4242Alias = i
}

View File

@ -1,3 +1,5 @@
module github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/issue/4387
go 1.20
go 1.23.0
toolchain go1.24.12

View File

View File

@ -749,7 +749,9 @@ func (a *TArray[T]) String() string {
}
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
// Note that do not use pointer as its receiver here.
// DO NOT change this receiver to pointer type, as the TArray can be used as a var defined variable, like:
// var a TArray[int]
// Please refer to corresponding tests for more details.
func (a TArray[T]) MarshalJSON() ([]byte, error) {
a.mu.RLock()
defer a.mu.RUnlock()

View File

@ -46,7 +46,7 @@ func NewSortedTArray[T comparable](comparator func(a, b T) int, safe ...bool) *S
return NewSortedTArraySize(0, comparator, safe...)
}
// NewSortedTArraySize create and returns an sorted array with given size and cap.
// NewSortedTArraySize create and returns a sorted array with given size and cap.
// The parameter `safe` is used to specify whether using array in concurrent-safety,
// which is false in default.
func NewSortedTArraySize[T comparable](cap int, comparator func(a, b T) int, safe ...bool) *SortedTArray[T] {
@ -718,7 +718,9 @@ func (a *SortedTArray[T]) String() string {
}
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
// Note that do not use pointer as its receiver here.
// DO NOT change this receiver to pointer type, as the TArray can be used as a var defined variable, like:
// var a SortedTArray[int]
// Please refer to corresponding tests for more details.
func (a SortedTArray[T]) MarshalJSON() ([]byte, error) {
a.mu.RLock()
defer a.mu.RUnlock()

View File

@ -22,8 +22,11 @@ type NilChecker[V any] func(V) bool
// KVMap wraps map type `map[K]V` and provides more map features.
type KVMap[K comparable, V any] struct {
mu rwmutex.RWMutex
data map[K]V
mu rwmutex.RWMutex
data map[K]V
// nilChecker is the custom nil checker function.
// It uses empty.IsNil if it's nil.
nilChecker NilChecker[V]
}
@ -58,15 +61,15 @@ func NewKVMapFrom[K comparable, V any](data map[K]V, safe ...bool) *KVMap[K, V]
// The parameter `safe` is used to specify whether to use the map in concurrent-safety mode, which is false by default.
func NewKVMapWithCheckerFrom[K comparable, V any](data map[K]V, checker NilChecker[V], safe ...bool) *KVMap[K, V] {
m := NewKVMapFrom[K, V](data, safe...)
m.RegisterNilChecker(checker)
m.SetNilChecker(checker)
return m
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// SetNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (m *KVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
func (m *KVMap[K, V]) SetNilChecker(nilChecker NilChecker[V]) {
m.mu.Lock()
defer m.mu.Unlock()
m.nilChecker = nilChecker
@ -74,12 +77,12 @@ func (m *KVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
// otherwise it falls back to the default empty.IsNil function.
func (m *KVMap[K, V]) isNil(v V) bool {
if m.nilChecker != nil {
return m.nilChecker(v)
}
return any(v) == nil
return empty.IsNil(v)
}
// Iterator iterates the hash map readonly with custom callback function `f`.
@ -242,11 +245,12 @@ func (m *KVMap[K, V]) Pops(size int) map[K]V {
return newMap
}
// doSetWithLockCheck checks whether value of the key exists with mutex.Lock,
// if not exists, set value to the map with given `key`,
// or else just return the existing value.
// doSetWithLockCheck sets value with given `value` if it does not exist,
// and then returns this value and whether it exists.
//
// It returns value with given `key`.
// It is a helper function for GetOrSet* functions.
//
// Note that, it does not add the value to the map if the given `value` is nil.
func (m *KVMap[K, V]) doSetWithLockCheck(key K, value V) (val V, ok bool) {
m.mu.Lock()
defer m.mu.Unlock()
@ -274,6 +278,8 @@ func (m *KVMap[K, V]) GetOrSet(key K, value V) V {
// GetOrSetFunc returns the value by key,
// or sets value with returned value of callback function `f` if it does not exist
// and then returns this value.
//
// Note that, it does not add the value to the map if the returned value of `f` is nil.
func (m *KVMap[K, V]) GetOrSetFunc(key K, f func() V) V {
v, _ := m.doSetWithLockCheck(key, f())
return v
@ -285,6 +291,8 @@ func (m *KVMap[K, V]) GetOrSetFunc(key K, f func() V) V {
//
// GetOrSetFuncLock differs with GetOrSetFunc function is that it executes function `f`
// with mutex.Lock of the hash map.
//
// Note that, it does not add the value to the map if the returned value of `f` is nil.
func (m *KVMap[K, V]) GetOrSetFuncLock(key K, f func() V) V {
m.mu.Lock()
defer m.mu.Unlock()
@ -524,6 +532,9 @@ func (m *KVMap[K, V]) String() string {
}
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
// DO NOT change this receiver to pointer type, as the KVMap can be used as a var defined variable, like:
// var m gmap.KVMap[int, string]
// Please refer to corresponding tests for more details.
func (m KVMap[K, V]) MarshalJSON() ([]byte, error) {
return json.Marshal(gconv.Map(m.Map()))
}

View File

@ -56,7 +56,7 @@ func NewListKVMap[K comparable, V any](safe ...bool) *ListKVMap[K, V] {
// which is false by default.
func NewListKVMapWithChecker[K comparable, V any](checker NilChecker[V], safe ...bool) *ListKVMap[K, V] {
m := NewListKVMap[K, V](safe...)
m.RegisterNilChecker(checker)
m.SetNilChecker(checker)
return m
}
@ -81,11 +81,11 @@ func NewListKVMapWithCheckerFrom[K comparable, V any](data map[K]V, nilChecker N
return m
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// SetNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (m *ListKVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
func (m *ListKVMap[K, V]) SetNilChecker(nilChecker NilChecker[V]) {
m.mu.Lock()
defer m.mu.Unlock()
m.nilChecker = nilChecker
@ -93,12 +93,12 @@ func (m *ListKVMap[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
// otherwise it falls back to the default empty.IsNil function.
func (m *ListKVMap[K, V]) isNil(v V) bool {
if m.nilChecker != nil {
return m.nilChecker(v)
}
return any(v) == nil
return empty.IsNil(v)
}
// Iterator is alias of IteratorAsc.
@ -402,6 +402,8 @@ func (m *ListKVMap[K, V]) GetVarOrSetFuncLock(key K, f func() V) *gvar.Var {
// SetIfNotExist sets `value` to the map if the `key` does not exist, and then returns true.
// It returns false if `key` exists, and `value` would be ignored.
//
// Note that it does not add the value to the map if `value` is nil.
func (m *ListKVMap[K, V]) SetIfNotExist(key K, value V) bool {
m.mu.Lock()
defer m.mu.Unlock()
@ -421,6 +423,8 @@ func (m *ListKVMap[K, V]) SetIfNotExist(key K, value V) bool {
// SetIfNotExistFunc sets value with return value of callback function `f`, and then returns true.
// It returns false if `key` exists, and `value` would be ignored.
//
// Note that, it does not add the value to the map if the returned value of `f` is nil.
func (m *ListKVMap[K, V]) SetIfNotExistFunc(key K, f func() V) bool {
m.mu.Lock()
defer m.mu.Unlock()
@ -444,6 +448,8 @@ func (m *ListKVMap[K, V]) SetIfNotExistFunc(key K, f func() V) bool {
//
// SetIfNotExistFuncLock differs with SetIfNotExistFunc function is that
// it executes function `f` with mutex.Lock of the map.
//
// Note that, it does not add the value to the map if the returned value of `f` is nil.
func (m *ListKVMap[K, V]) SetIfNotExistFuncLock(key K, f func() V) bool {
m.mu.Lock()
defer m.mu.Unlock()
@ -609,6 +615,9 @@ func (m *ListKVMap[K, V]) String() string {
}
// MarshalJSON implements the interface MarshalJSON for json.Marshal.
// DO NOT change this receiver to pointer type, as the ListKVMap can be used as a var defined variable, like:
// var m gmap.ListKVMap[string]string
// Please refer to corresponding tests for more details.
func (m ListKVMap[K, V]) MarshalJSON() (jsonBytes []byte, err error) {
if m.data == nil {
return []byte("{}"), nil

View File

@ -774,6 +774,13 @@ func Test_KVMap_MarshalJSON(t *testing.T) {
t.Assert(data["a"], 1)
t.Assert(data["b"], 2)
})
gtest.C(t, func(t *gtest.T) {
var m gmap.KVMap[int, int]
m.Set(1, 10)
b, err := json.Marshal(m)
t.AssertNil(err)
t.Assert(string(b), `{"1":10}`)
})
}
func Test_KVMap_UnmarshalJSON(t *testing.T) {
@ -1647,9 +1654,10 @@ func Test_KVMap_TypedNil(t *testing.T) {
return nil
})
}
t.Assert(m1.Size(), 10)
t.Assert(m1.Size(), 5)
m2 := gmap.NewKVMap[int, *Student](true)
m2.RegisterNilChecker(func(student *Student) bool {
m2.SetNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
@ -1679,7 +1687,8 @@ func Test_NewKVMapWithChecker_TypedNil(t *testing.T) {
return nil
})
}
t.Assert(m1.Size(), 10)
t.Assert(m1.Size(), 5)
m2 := gmap.NewKVMapWithChecker[int, *Student](func(student *Student) bool {
return student == nil
}, true)

View File

@ -183,77 +183,6 @@ func Test_ListKVMap_SetIfNotExistFuncLock_MultipleKeys(t *testing.T) {
})
}
// Test_ListKVMap_GetOrSetFuncLock_NilValue tests that nil values are handled correctly.
func Test_ListKVMap_GetOrSetFuncLock_NilValue(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
m := gmap.NewListKVMap[string, *int](true)
key := "nilKey"
callCount := int32(0)
var wg sync.WaitGroup
goroutines := 50
wg.Add(goroutines)
for i := 0; i < goroutines; i++ {
go func() {
defer wg.Done()
m.GetOrSetFuncLock(key, func() *int {
atomic.AddInt32(&callCount, 1)
return nil
})
}()
}
wg.Wait()
// Callback should be called once
t.Assert(atomic.LoadInt32(&callCount), 1)
// Typed nil pointer (*int)(nil) is stored because any(value) != nil for typed nil
// This is a Go language feature: typed nil is not the same as interface nil
t.Assert(m.Contains(key), true)
t.Assert(m.Get(key), (*int)(nil))
t.Assert(m.Size(), 1)
})
}
// Test_ListKVMap_SetIfNotExistFuncLock_NilValue tests that nil values are handled correctly.
func Test_ListKVMap_SetIfNotExistFuncLock_NilValue(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
m := gmap.NewListKVMap[string, *string](true)
key := "nilKey"
callCount := int32(0)
successCount := int32(0)
var wg sync.WaitGroup
goroutines := 50
wg.Add(goroutines)
for i := 0; i < goroutines; i++ {
go func() {
defer wg.Done()
success := m.SetIfNotExistFuncLock(key, func() *string {
atomic.AddInt32(&callCount, 1)
return nil
})
if success {
atomic.AddInt32(&successCount, 1)
}
}()
}
wg.Wait()
// Callback should be called once
t.Assert(atomic.LoadInt32(&callCount), 1)
// Should report success once
t.Assert(atomic.LoadInt32(&successCount), 1)
// Typed nil pointer (*string)(nil) is stored because any(value) != nil for typed nil
t.Assert(m.Contains(key), true)
t.Assert(m.Get(key), (*string)(nil))
t.Assert(m.Size(), 1)
})
}
// Test_ListKVMap_GetOrSetFuncLock_ExistingKey tests behavior when key already exists.
func Test_ListKVMap_GetOrSetFuncLock_ExistingKey(t *testing.T) {
gtest.C(t, func(t *gtest.T) {

View File

@ -1159,6 +1159,13 @@ func Test_ListKVMap_MarshalJSON_Error(t *testing.T) {
t.AssertNil(err)
t.Assert(string(b), `{"a":"1"}`)
})
gtest.C(t, func(t *gtest.T) {
var m gmap.ListKVMap[int, int]
m.Set(1, 10)
b, err := json.Marshal(m)
t.AssertNil(err)
t.Assert(string(b), `{"1":10}`)
})
}
// Test empty map operations
@ -1358,9 +1365,10 @@ func Test_ListKVMap_TypedNil(t *testing.T) {
return nil
})
}
t.Assert(m1.Size(), 10)
t.Assert(m1.Size(), 5)
m2 := gmap.NewListKVMap[int, *Student](true)
m2.RegisterNilChecker(func(student *Student) bool {
m2.SetNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
@ -1390,7 +1398,8 @@ func Test_NewListKVMapWithChecker_TypedNil(t *testing.T) {
return nil
})
}
t.Assert(m1.Size(), 10)
t.Assert(m1.Size(), 5)
m2 := gmap.NewListKVMapWithChecker[int, *Student](func(student *Student) bool {
return student == nil
}, true)

View File

@ -9,6 +9,7 @@ package gset
import (
"bytes"
"github.com/gogf/gf/v2/internal/empty"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/internal/rwmutex"
"github.com/gogf/gf/v2/text/gstr"
@ -39,7 +40,7 @@ func NewTSet[T comparable](safe ...bool) *TSet[T] {
// The parameter `safe` is used to specify whether using set in concurrent-safety mode.
func NewTSetWithChecker[T comparable](checker NilChecker[T], safe ...bool) *TSet[T] {
s := NewTSet[T](safe...)
s.RegisterNilChecker(checker)
s.SetNilChecker(checker)
return s
}
@ -66,11 +67,11 @@ func NewTSetWithCheckerFrom[T comparable](items []T, checker NilChecker[T], safe
return set
}
// RegisterNilChecker registers a custom nil checker function for the set elements.
// SetNilChecker registers a custom nil checker function for the set elements.
// This function is used to determine if an element should be considered as nil.
// The nil checker function takes an element of type T and returns a boolean indicating
// whether the element should be treated as nil.
func (set *TSet[T]) RegisterNilChecker(nilChecker NilChecker[T]) {
func (set *TSet[T]) SetNilChecker(nilChecker NilChecker[T]) {
set.mu.Lock()
defer set.mu.Unlock()
set.nilChecker = nilChecker
@ -78,12 +79,12 @@ func (set *TSet[T]) RegisterNilChecker(nilChecker NilChecker[T]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
// otherwise it falls back to the default empty.IsNil function.
func (set *TSet[T]) isNil(v T) bool {
if set.nilChecker != nil {
return set.nilChecker(v)
}
return any(v) == nil
return empty.IsNil(v)
}
// Iterator iterates the set readonly with given callback function `f`,
@ -109,7 +110,7 @@ func (set *TSet[T]) Add(items ...T) {
}
// AddIfNotExist checks whether item exists in the set,
// it adds the item to set and returns true if it does not exists in the set,
// it adds the item to set and returns true if it does not exist in the set,
// or else it does nothing and returns false.
//
// Note that, if `item` is nil, it does nothing and returns false.

View File

@ -601,10 +601,10 @@ func Test_TSet_TypedNil(t *testing.T) {
set := gset.NewTSet[*Student](true)
var s *Student = nil
exist := set.AddIfNotExist(s)
t.Assert(exist, true)
t.Assert(exist, false)
set2 := gset.NewTSet[*Student](true)
set2.RegisterNilChecker(func(student *Student) bool {
set2.SetNilChecker(func(student *Student) bool {
return student == nil
})
exist2 := set2.AddIfNotExist(s)
@ -621,7 +621,7 @@ func Test_NewTSetWithChecker_TypedNil(t *testing.T) {
set := gset.NewTSet[*Student](true)
var s *Student = nil
exist := set.AddIfNotExist(s)
t.Assert(exist, true)
t.Assert(exist, false)
set2 := gset.NewTSetWithChecker[*Student](func(student *Student) bool {
return student == nil

View File

@ -12,6 +12,7 @@ import (
"github.com/emirpasic/gods/v2/trees/avltree"
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/internal/empty"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/internal/rwmutex"
"github.com/gogf/gf/v2/text/gstr"
@ -52,7 +53,7 @@ func NewAVLKVTree[K comparable, V any](comparator func(v1, v2 K) int, safe ...bo
// The parameter `checker` is used to specify whether the given value is nil.
func NewAVLKVTreeWithChecker[K comparable, V any](comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *AVLKVTree[K, V] {
t := NewAVLKVTree[K, V](comparator, safe...)
t.RegisterNilChecker(checker)
t.SetNilChecker(checker)
return t
}
@ -78,11 +79,11 @@ func NewAVLKVTreeWithCheckerFrom[K comparable, V any](comparator func(v1, v2 K)
return tree
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// SetNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *AVLKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
func (tree *AVLKVTree[K, V]) SetNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
@ -90,12 +91,12 @@ func (tree *AVLKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *AVLKVTree[K, V]) isNil(value V) bool {
// otherwise it falls back to the default empty.IsNil function.
func (tree *AVLKVTree[K, V]) isNil(v V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
return tree.nilChecker(v)
}
return any(value) == nil
return empty.IsNil(v)
}
// Clone clones and returns a new tree from current tree.

View File

@ -12,6 +12,7 @@ import (
"github.com/emirpasic/gods/v2/trees/btree"
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/internal/empty"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/internal/rwmutex"
"github.com/gogf/gf/v2/text/gstr"
@ -51,7 +52,7 @@ func NewBKVTree[K comparable, V any](m int, comparator func(v1, v2 K) int, safe
// The parameter `checker` is used to specify whether the given value is nil.
func NewBKVTreeWithChecker[K comparable, V any](m int, comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *BKVTree[K, V] {
t := NewBKVTree[K, V](m, comparator, safe...)
t.RegisterNilChecker(checker)
t.SetNilChecker(checker)
return t
}
@ -77,11 +78,11 @@ func NewBKVTreeWithCheckerFrom[K comparable, V any](m int, comparator func(v1, v
return tree
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// SetNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *BKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
func (tree *BKVTree[K, V]) SetNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
@ -89,12 +90,12 @@ func (tree *BKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *BKVTree[K, V]) isNil(value V) bool {
// otherwise it falls back to the default empty.IsNil function.
func (tree *BKVTree[K, V]) isNil(v V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
return tree.nilChecker(v)
}
return any(value) == nil
return empty.IsNil(v)
}
// Clone clones and returns a new tree from current tree.

View File

@ -12,6 +12,7 @@ import (
"github.com/emirpasic/gods/v2/trees/redblacktree"
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/internal/empty"
"github.com/gogf/gf/v2/internal/json"
"github.com/gogf/gf/v2/internal/rwmutex"
"github.com/gogf/gf/v2/text/gstr"
@ -47,7 +48,7 @@ func NewRedBlackKVTree[K comparable, V any](comparator func(v1, v2 K) int, safe
// The parameter `checker` is used to specify whether the given value is nil.
func NewRedBlackKVTreeWithChecker[K comparable, V any](comparator func(v1, v2 K) int, checker NilChecker[V], safe ...bool) *RedBlackKVTree[K, V] {
t := NewRedBlackKVTree[K, V](comparator, safe...)
t.RegisterNilChecker(checker)
t.SetNilChecker(checker)
return t
}
@ -96,11 +97,11 @@ func RedBlackKVTreeInitFrom[K comparable, V any](tree *RedBlackKVTree[K, V], com
}
}
// RegisterNilChecker registers a custom nil checker function for the map values.
// SetNilChecker registers a custom nil checker function for the map values.
// This function is used to determine if a value should be considered as nil.
// The nil checker function takes a value of type V and returns a boolean indicating
// whether the value should be treated as nil.
func (tree *RedBlackKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
func (tree *RedBlackKVTree[K, V]) SetNilChecker(nilChecker NilChecker[V]) {
tree.mu.Lock()
defer tree.mu.Unlock()
tree.nilChecker = nilChecker
@ -108,12 +109,12 @@ func (tree *RedBlackKVTree[K, V]) RegisterNilChecker(nilChecker NilChecker[V]) {
// isNil checks whether the given value is nil.
// It first checks if a custom nil checker function is registered and uses it if available,
// otherwise it performs a standard nil check using any(v) == nil.
func (tree *RedBlackKVTree[K, V]) isNil(value V) bool {
// otherwise it falls back to the default empty.IsNil function.
func (tree *RedBlackKVTree[K, V]) isNil(v V) bool {
if tree.nilChecker != nil {
return tree.nilChecker(value)
return tree.nilChecker(v)
}
return any(value) == nil
return empty.IsNil(v)
}
// SetComparator sets/changes the comparator for sorting.

View File

@ -29,9 +29,10 @@ func Test_KVAVLTree_TypedNil(t *testing.T) {
avlTree.Set(i, s)
}
}
t.Assert(avlTree.Size(), 10)
t.Assert(avlTree.Size(), 5)
avlTree2 := gtree.NewAVLKVTree[int, *Student](gutil.ComparatorTStr[int], true)
avlTree2.RegisterNilChecker(func(student *Student) bool {
avlTree2.SetNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
@ -62,9 +63,10 @@ func Test_KVBTree_TypedNil(t *testing.T) {
btree.Set(i, s)
}
}
t.Assert(btree.Size(), 10)
t.Assert(btree.Size(), 5)
btree2 := gtree.NewBKVTree[int, *Student](100, gutil.ComparatorTStr[int], true)
btree2.RegisterNilChecker(func(student *Student) bool {
btree2.SetNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
@ -95,10 +97,10 @@ func Test_KVRedBlackTree_TypedNil(t *testing.T) {
redBlackTree.Set(i, s)
}
}
t.Assert(redBlackTree.Size(), 10)
redBlackTree2 := gtree.NewRedBlackKVTree[int, *Student](gutil.ComparatorTStr[int], true)
t.Assert(redBlackTree.Size(), 5)
redBlackTree2.RegisterNilChecker(func(student *Student) bool {
redBlackTree2 := gtree.NewRedBlackKVTree[int, *Student](gutil.ComparatorTStr[int], true)
redBlackTree2.SetNilChecker(func(student *Student) bool {
return student == nil
})
for i := 0; i < 10; i++ {
@ -128,7 +130,8 @@ func Test_NewKVAVLTreeWithChecker_TypedNil(t *testing.T) {
avlTree.Set(i, s)
}
}
t.Assert(avlTree.Size(), 10)
t.Assert(avlTree.Size(), 5)
avlTree2 := gtree.NewAVLKVTreeWithChecker[int, *Student](gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)
@ -160,7 +163,8 @@ func Test_NewKVBTreeWithChecker_TypedNil(t *testing.T) {
btree.Set(i, s)
}
}
t.Assert(btree.Size(), 10)
t.Assert(btree.Size(), 5)
btree2 := gtree.NewBKVTreeWithChecker[int, *Student](100, gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)
@ -192,7 +196,8 @@ func Test_NewRedBlackKVTreeWithChecker_TypedNil(t *testing.T) {
redBlackTree.Set(i, s)
}
}
t.Assert(redBlackTree.Size(), 10)
t.Assert(redBlackTree.Size(), 5)
redBlackTree2 := gtree.NewRedBlackKVTreeWithChecker[int, *Student](gutil.ComparatorTStr[int], func(student *Student) bool {
return student == nil
}, true)

View File

@ -179,7 +179,7 @@ func (c *Client) updateLocalValue(ctx context.Context) (err error) {
}
// AddWatcher adds a watcher for the specified configuration file.
func (c *Client) AddWatcher(name string, f func(ctx context.Context)) {
func (c *Client) AddWatcher(name string, f gcfg.WatcherFunc) {
c.watchers.Add(name, f)
}
@ -193,6 +193,11 @@ func (c *Client) GetWatcherNames() []string {
return c.watchers.GetNames()
}
// IsWatching checks whether the watcher with the specified name is registered.
func (c *Client) IsWatching(name string) bool {
return c.watchers.IsWatching(name)
}
// notifyWatchers notifies all watchers.
func (c *Client) notifyWatchers(ctx context.Context) {
c.watchers.Notify(ctx)

View File

@ -4,7 +4,7 @@ go 1.23.0
require (
github.com/apolloconfig/agollo/v4 v4.3.1
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
)
require (

View File

@ -207,7 +207,7 @@ func (c *Client) startAsynchronousWatch(plan *watch.Plan) {
}
// AddWatcher adds a watcher for the specified configuration file.
func (c *Client) AddWatcher(name string, f func(ctx context.Context)) {
func (c *Client) AddWatcher(name string, f gcfg.WatcherFunc) {
c.watchers.Add(name, f)
}
@ -221,6 +221,11 @@ func (c *Client) GetWatcherNames() []string {
return c.watchers.GetNames()
}
// IsWatching checks whether the watcher with the specified name is registered.
func (c *Client) IsWatching(name string) bool {
return c.watchers.IsWatching(name)
}
// notifyWatchers notifies all watchers.
func (c *Client) notifyWatchers(ctx context.Context) {
c.watchers.Notify(ctx)

View File

@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/consul/v2
go 1.23.0
require (
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
github.com/hashicorp/consul/api v1.24.0
github.com/hashicorp/go-cleanhttp v0.5.2
)

View File

@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/kubecm/v2
go 1.24.0
require (
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
k8s.io/api v0.33.4
k8s.io/apimachinery v0.33.4
k8s.io/client-go v0.33.4

View File

@ -199,7 +199,7 @@ func (c *Client) startAsynchronousWatch(ctx context.Context, namespace string, w
}
// AddWatcher adds a watcher for the specified configuration file.
func (c *Client) AddWatcher(name string, f func(ctx context.Context)) {
func (c *Client) AddWatcher(name string, f gcfg.WatcherFunc) {
c.watchers.Add(name, f)
}
@ -213,6 +213,11 @@ func (c *Client) GetWatcherNames() []string {
return c.watchers.GetNames()
}
// IsWatching checks whether the watcher with the specified name is registered.
func (c *Client) IsWatching(name string) bool {
return c.watchers.IsWatching(name)
}
// notifyWatchers notifies all watchers.
func (c *Client) notifyWatchers(ctx context.Context) {
c.watchers.Notify(ctx)

View File

@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/nacos/v2
go 1.23.0
require (
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
github.com/nacos-group/nacos-sdk-go/v2 v2.3.3
)

View File

@ -152,7 +152,7 @@ func (c *Client) addWatcher() error {
}
// AddWatcher adds a watcher for the specified configuration file.
func (c *Client) AddWatcher(name string, f func(ctx context.Context)) {
func (c *Client) AddWatcher(name string, f gcfg.WatcherFunc) {
c.watchers.Add(name, f)
}
@ -166,6 +166,11 @@ func (c *Client) GetWatcherNames() []string {
return c.watchers.GetNames()
}
// IsWatching checks whether the watcher with the specified name is registered.
func (c *Client) IsWatching(name string) bool {
return c.watchers.IsWatching(name)
}
// notifyWatchers notifies all watchers.
func (c *Client) notifyWatchers(ctx context.Context) {
c.watchers.Notify(ctx)

View File

@ -3,7 +3,7 @@ module github.com/gogf/gf/contrib/config/polaris/v2
go 1.23.0
require (
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
github.com/polarismesh/polaris-go v1.6.1
)

View File

@ -187,7 +187,7 @@ func (c *Client) startAsynchronousWatch(ctx context.Context, changeChan <-chan m
}
// AddWatcher adds a watcher for the specified configuration file.
func (c *Client) AddWatcher(name string, f func(ctx context.Context)) {
func (c *Client) AddWatcher(name string, f gcfg.WatcherFunc) {
c.watchers.Add(name, f)
}
@ -201,6 +201,11 @@ func (c *Client) GetWatcherNames() []string {
return c.watchers.GetNames()
}
// IsWatching checks whether the watcher with the specified name is registered.
func (c *Client) IsWatching(name string) bool {
return c.watchers.IsWatching(name)
}
// notifyWatchers notifies all watchers.
func (c *Client) notifyWatchers(ctx context.Context) {
c.watchers.Notify(ctx)

View File

@ -4,7 +4,7 @@ go 1.23.0
require (
github.com/ClickHouse/clickhouse-go/v2 v2.0.15
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
github.com/google/uuid v1.6.0
github.com/shopspring/decimal v1.3.1
)

View File

@ -108,7 +108,7 @@ func (d *Driver) doMergeInsert(
one = list[0]
oneLen = len(one)
charL, charR = d.GetChars()
conflictKeySet = gset.New(false)
conflictKeySet = gset.NewStrSet(false)
// queryHolders: Handle data with Holder that need to be merged
// queryValues: Handle data that need to be merged

View File

@ -6,7 +6,7 @@ replace github.com/gogf/gf/v2 => ../../../
require (
gitee.com/chunanyong/dm v1.8.12
github.com/gogf/gf/v2 v2.9.8
github.com/gogf/gf/v2 v2.10.0
)
require (

View File

@ -307,7 +307,7 @@ func (d *Driver) doMergeInsert(
one = list[0]
oneLen = len(one)
charL, charR = d.GetChars()
conflictKeySet = gset.New(false)
conflictKeySet = gset.NewStrSet(false)
// queryHolders: Handle data with Holder that need to be merged
// queryValues: Handle data that need to be merged

View File

@ -0,0 +1,102 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"context"
"testing"
"time"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/os/glog"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_Ctx(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
db, err := gdb.Instance()
t.AssertNil(err)
err1 := db.PingMaster()
err2 := db.PingSlave()
t.Assert(err1, nil)
t.Assert(err2, nil)
newDb := db.Ctx(context.Background())
t.AssertNE(newDb, nil)
})
}
func Test_Ctx_Query(t *testing.T) {
db.GetLogger().(*glog.Logger).SetCtxKeys("SpanId", "TraceId")
gtest.C(t, func(t *gtest.T) {
db.SetDebug(true)
defer db.SetDebug(false)
ctx := context.WithValue(context.Background(), "TraceId", "12345678")
ctx = context.WithValue(ctx, "SpanId", "0.1")
db.Query(ctx, "select 1")
})
gtest.C(t, func(t *gtest.T) {
db.SetDebug(true)
defer db.SetDebug(false)
db.Query(ctx, "select 2")
})
}
func Test_Ctx_Model(t *testing.T) {
table := createInitTable()
defer dropTable(table)
db.GetLogger().(*glog.Logger).SetCtxKeys("SpanId", "TraceId")
gtest.C(t, func(t *gtest.T) {
db.SetDebug(true)
defer db.SetDebug(false)
ctx := context.WithValue(context.Background(), "TraceId", "12345678")
ctx = context.WithValue(ctx, "SpanId", "0.1")
db.Model(table).Ctx(ctx).All()
})
gtest.C(t, func(t *gtest.T) {
db.SetDebug(true)
defer db.SetDebug(false)
db.Model(table).All()
})
}
func Test_Ctx_Transaction(t *testing.T) {
table := createInitTable()
defer dropTable(table)
db.GetLogger().(*glog.Logger).SetCtxKeys("SpanId", "TraceId")
gtest.C(t, func(t *gtest.T) {
db.SetDebug(true)
defer db.SetDebug(false)
ctx := context.WithValue(context.Background(), "TraceId", "tx_trace_123")
ctx = context.WithValue(ctx, "SpanId", "0.2")
err := db.Transaction(ctx, func(ctx context.Context, tx gdb.TX) error {
_, err := tx.Model(table).Ctx(ctx).Where("id", 1).One()
return err
})
t.AssertNil(err)
})
}
func Test_Ctx_Timeout(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*10)
defer cancel()
// Wait for the context to expire
time.Sleep(time.Millisecond * 50)
// Query with expired context should return error
_, err := db.Model(table).Ctx(ctx).All()
t.AssertNE(err, nil)
})
}

View File

@ -0,0 +1,216 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"context"
"database/sql"
"fmt"
"testing"
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_Model_Hook_Select(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Select: func(ctx context.Context, in *gdb.HookSelectInput) (result gdb.Result, err error) {
result, err = in.Next(ctx)
if err != nil {
return
}
for i, record := range result {
record["test"] = gvar.New(100 + record["id"].Int())
result[i] = record
}
return
},
})
all, err := m.Where("id > ?", 6).OrderAsc("id").All()
t.AssertNil(err)
t.Assert(len(all), 4)
t.Assert(all[0]["id"].Int(), 7)
t.Assert(all[0]["test"].Int(), 107)
t.Assert(all[1]["test"].Int(), 108)
t.Assert(all[2]["test"].Int(), 109)
t.Assert(all[3]["test"].Int(), 110)
})
}
func Test_Model_Hook_Insert(t *testing.T) {
table := createTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Insert: func(ctx context.Context, in *gdb.HookInsertInput) (result sql.Result, err error) {
for i, item := range in.Data {
item["passport"] = fmt.Sprintf(`test_port_%d`, item["id"])
item["nickname"] = fmt.Sprintf(`test_name_%d`, item["id"])
item["password"] = fmt.Sprintf(`test_pass_%d`, item["id"])
item["create_time"] = CreateTime
in.Data[i] = item
}
return in.Next(ctx)
},
})
_, err := m.Insert(g.Map{
"id": 1,
"nickname": "name_1",
})
t.AssertNil(err)
one, err := m.One()
t.AssertNil(err)
t.Assert(one["id"].Int(), 1)
t.Assert(one["passport"], `test_port_1`)
t.Assert(one["nickname"], `test_name_1`)
})
}
func Test_Model_Hook_Update(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Update: func(ctx context.Context, in *gdb.HookUpdateInput) (result sql.Result, err error) {
switch value := in.Data.(type) {
case gdb.List:
for i, data := range value {
data["passport"] = `port`
data["nickname"] = `name`
value[i] = data
}
in.Data = value
case gdb.Map:
value["passport"] = `port`
value["nickname"] = `name`
in.Data = value
}
return in.Next(ctx)
},
})
_, err := m.Data(g.Map{
"nickname": "name_1",
}).WherePri(1).Update()
t.AssertNil(err)
one, err := m.One()
t.AssertNil(err)
t.Assert(one["id"].Int(), 1)
t.Assert(one["passport"], `port`)
t.Assert(one["nickname"], `name`)
})
}
func Test_Model_Hook_Delete(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Delete: func(ctx context.Context, in *gdb.HookDeleteInput) (result sql.Result, err error) {
return db.Model(table).Data(g.Map{
"nickname": `deleted`,
}).Where(in.Condition).Update()
},
})
_, err := m.Where("1=1").Delete()
t.AssertNil(err)
all, err := m.All()
t.AssertNil(err)
for _, item := range all {
t.Assert(item["nickname"].String(), `deleted`)
}
})
}
func Test_Model_Hook_Select_Count(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Select: func(ctx context.Context, in *gdb.HookSelectInput) (result gdb.Result, err error) {
result, err = in.Next(ctx)
if err != nil {
return
}
// Adding extra fields should not affect Count operations
for i, record := range result {
record["extra"] = gvar.New("extra_value")
result[i] = record
}
return
},
})
count, err := m.Count()
t.AssertNil(err)
t.Assert(count, TableSize)
})
}
func Test_Model_Hook_Chain(t *testing.T) {
table := createInitTable()
defer dropTable(table)
// Normal chain: two hooks both modify data
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Select: func(ctx context.Context, in *gdb.HookSelectInput) (result gdb.Result, err error) {
result, err = in.Next(ctx)
if err != nil {
return
}
for i, record := range result {
record["hook1"] = gvar.New("value1")
result[i] = record
}
return
},
}).Hook(gdb.HookHandler{
Select: func(ctx context.Context, in *gdb.HookSelectInput) (result gdb.Result, err error) {
result, err = in.Next(ctx)
if err != nil {
return
}
for i, record := range result {
record["hook2"] = gvar.New("value2")
result[i] = record
}
return
},
})
all, err := m.Where("id", 1).All()
t.AssertNil(err)
t.Assert(len(all), 1)
t.Assert(all[0]["id"].Int(), 1)
// The last Hook should take effect (Hook replaces previous one)
t.Assert(all[0]["hook2"].String(), "value2")
})
// Error chain: hook returns error
gtest.C(t, func(t *gtest.T) {
m := db.Model(table).Hook(gdb.HookHandler{
Select: func(ctx context.Context, in *gdb.HookSelectInput) (result gdb.Result, err error) {
return nil, gerror.New("hook error")
},
})
_, err := m.Where("id", 1).All()
t.AssertNE(err, nil)
t.Assert(err.Error(), "hook error")
})
}

View File

@ -0,0 +1,141 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"testing"
"github.com/gogf/gf/v2/encoding/gjson"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/util/gmeta"
)
func Test_Model_Builder(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
all, err := m.Where(
b.Where("id", g.Slice{1, 2, 3}).WhereOr("id", g.Slice{4, 5, 6}),
).All()
t.AssertNil(err)
t.Assert(len(all), 6)
})
// Where And
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
all, err := m.Where(
b.Where("id", g.Slice{1, 2, 3}).WhereOr("id", g.Slice{4, 5, 6}),
).Where(
b.Where("id", g.Slice{2, 3}).WhereOr("id", g.Slice{5, 6}),
).Where(
b.Where("id", g.Slice{3}).Where("id", g.Slice{1, 2, 3}),
).All()
t.AssertNil(err)
t.Assert(len(all), 1)
})
// Where Or
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
all, err := m.WhereOr(
b.Where("id", g.Slice{1, 2, 3}).WhereOr("id", g.Slice{4, 5, 6}),
).WhereOr(
b.Where("id", g.Slice{2, 3}).WhereOr("id", g.Slice{5, 6}),
).WhereOr(
b.Where("id", g.Slice{3}).Where("id", g.Slice{1, 2, 3}),
).All()
t.AssertNil(err)
t.Assert(len(all), 6)
})
// Where with struct which has a field type of *gtime.Time
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
type Query struct {
Id any
Nickname *gtime.Time
}
where, args := b.Where(&Query{Id: 1}).Build()
t.Assert(where, `"id"=? AND "nickname" IS NULL`)
t.Assert(args, []any{1})
})
// Where with struct which has a field type of *gjson.Json
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
type Query struct {
Id any
Nickname *gjson.Json
}
where, args := b.Where(&Query{Id: 1}).Build()
t.Assert(where, `"id"=? AND "nickname" IS NULL`)
t.Assert(args, []any{1})
})
// Where with do struct which has a field type of *gtime.Time and generated by gf cli
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
type Query struct {
gmeta.Meta `orm:"do:true"`
Id any
Nickname *gtime.Time
}
where, args := b.Where(&Query{Id: 1}).Build()
t.Assert(where, `"id"=?`)
t.Assert(args, []any{1})
})
// Where with do struct which has a field type of *gjson.Json and generated by gf cli
gtest.C(t, func(t *gtest.T) {
m := db.Model(table)
b := m.Builder()
type Query struct {
gmeta.Meta `orm:"do:true"`
Id any
Nickname *gjson.Json
}
where, args := b.Where(&Query{Id: 1}).Build()
t.Assert(where, `"id"=?`)
t.Assert(args, []any{1})
})
}
func Test_Safe_Builder(t *testing.T) {
// test whether m.Builder() is chain safe
gtest.C(t, func(t *gtest.T) {
b := db.Model().Builder()
b.Where("id", 1)
_, args := b.Build()
t.AssertNil(args)
b = b.Where("id", 1)
_, args = b.Build()
t.Assert(args, g.Slice{1})
})
}

View File

@ -0,0 +1,410 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"fmt"
"testing"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/text/gstr"
"github.com/gogf/gf/v2/util/gconv"
)
// createTableDO creates a table with nullable columns (no NOT NULL constraints)
// suitable for DO (Data Object) partial insert tests.
func createTableDO(table ...string) (name string) {
if len(table) > 0 {
name = table[0]
} else {
name = fmt.Sprintf(`%s_%d`, TablePrefix+"do_test", gtime.TimestampNano())
}
dropTable(name)
if _, err := db.Exec(ctx, fmt.Sprintf(`
CREATE TABLE %s (
id bigserial NOT NULL,
passport varchar(45) DEFAULT '',
password varchar(32) DEFAULT '',
nickname varchar(45) DEFAULT '',
create_time timestamp DEFAULT NULL,
PRIMARY KEY (id)
);`, name,
)); err != nil {
gtest.Fatal(err)
}
return
}
func Test_Model_Insert_Data_DO(t *testing.T) {
table := createTableDO()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type User struct {
g.Meta `orm:"do:true"`
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := User{
Id: 1,
Passport: "user_1",
Password: "pass_1",
}
result, err := db.Model(table).Data(data).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 1)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], ``)
})
}
func Test_Model_Insert_Data_List_DO(t *testing.T) {
table := createTableDO()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type User struct {
g.Meta `orm:"do:true"`
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := g.Slice{
User{
Id: 1,
Passport: "user_1",
Password: "pass_1",
},
User{
Id: 2,
Passport: "user_2",
Password: "pass_2",
},
}
result, err := db.Model(table).Data(data).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 2)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], ``)
one, err = db.Model(table).WherePri(2).One()
t.AssertNil(err)
t.Assert(one[`id`], 2)
t.Assert(one[`passport`], `user_2`)
t.Assert(one[`password`], `pass_2`)
t.Assert(one[`nickname`], ``)
})
}
func Test_Model_Update_Data_DO(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type User struct {
g.Meta `orm:"do:true"`
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := User{
Id: 1,
Passport: "user_100",
Password: "pass_100",
}
_, err := db.Model(table).Data(data).WherePri(1).Update()
t.AssertNil(err)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_100`)
t.Assert(one[`password`], `pass_100`)
t.Assert(one[`nickname`], `name_1`)
})
}
func Test_Model_Update_Pointer_Data_DO(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type NN string
type Req struct {
Id int
Passport *string
Password *string
Nickname *NN
}
type UserDo struct {
g.Meta `orm:"do:true"`
Id any
Passport any
Password any
Nickname any
CreateTime any
}
var (
nickname = NN("nickname_111")
req = Req{
Password: gconv.PtrString("12345678"),
Nickname: &nickname,
}
data = UserDo{
Passport: req.Passport,
Password: req.Password,
Nickname: req.Nickname,
}
)
_, err := db.Model(table).Data(data).WherePri(1).Update()
t.AssertNil(err)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`password`], `12345678`)
t.Assert(one[`nickname`], `nickname_111`)
})
}
func Test_Model_Where_DO(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type User struct {
g.Meta `orm:"do:true"`
Id any
Passport any
Password any
Nickname any
CreateTime any
}
where := User{
Id: 1,
Passport: "user_1",
Password: "pass_1",
}
one, err := db.Model(table).Where(where).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], `name_1`)
})
}
func Test_Model_Insert_Data_ForDao(t *testing.T) {
table := createTableDO()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type UserForDao struct {
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := UserForDao{
Id: 1,
Passport: "user_1",
Password: "pass_1",
}
result, err := db.Model(table).Data(data).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 1)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], ``)
})
}
func Test_Model_Insert_Data_List_ForDao(t *testing.T) {
table := createTableDO()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type UserForDao struct {
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := g.Slice{
UserForDao{
Id: 1,
Passport: "user_1",
Password: "pass_1",
},
UserForDao{
Id: 2,
Passport: "user_2",
Password: "pass_2",
},
}
result, err := db.Model(table).Data(data).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 2)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], ``)
one, err = db.Model(table).WherePri(2).One()
t.AssertNil(err)
t.Assert(one[`id`], 2)
t.Assert(one[`passport`], `user_2`)
t.Assert(one[`password`], `pass_2`)
t.Assert(one[`nickname`], ``)
})
}
func Test_Model_Update_Data_ForDao(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type UserForDao struct {
Id any
Passport any
Password any
Nickname any
CreateTime any
}
data := UserForDao{
Id: 1,
Passport: "user_100",
Password: "pass_100",
}
_, err := db.Model(table).Data(data).WherePri(1).Update()
t.AssertNil(err)
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_100`)
t.Assert(one[`password`], `pass_100`)
t.Assert(one[`nickname`], `name_1`)
})
}
func Test_Model_Where_ForDao(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type UserForDao struct {
Id any
Passport any
Password any
Nickname any
CreateTime any
}
where := UserForDao{
Id: 1,
Passport: "user_1",
Password: "pass_1",
}
one, err := db.Model(table).Where(where).One()
t.AssertNil(err)
t.Assert(one[`id`], 1)
t.Assert(one[`passport`], `user_1`)
t.Assert(one[`password`], `pass_1`)
t.Assert(one[`nickname`], `name_1`)
})
}
func Test_Model_Where_FieldPrefix(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
array := gstr.SplitAndTrim(gtest.DataContent(`table_with_prefix.sql`), ";")
for _, v := range array {
if _, err := db.Exec(ctx, v); err != nil {
gtest.Error(err)
}
}
defer dropTable("instance")
type Instance struct {
ID int `orm:"f_id"`
Name string
}
type InstanceDo struct {
g.Meta `orm:"table:instance, do:true"`
ID any `orm:"f_id"`
}
var instance *Instance
err := db.Model("instance").Where(InstanceDo{
ID: 1,
}).Scan(&instance)
t.AssertNil(err)
t.AssertNE(instance, nil)
t.Assert(instance.ID, 1)
t.Assert(instance.Name, "john")
})
// With omitempty.
gtest.C(t, func(t *gtest.T) {
array := gstr.SplitAndTrim(gtest.DataContent(`table_with_prefix.sql`), ";")
for _, v := range array {
if _, err := db.Exec(ctx, v); err != nil {
gtest.Error(err)
}
}
defer dropTable("instance")
type Instance struct {
ID int `orm:"f_id,omitempty"`
Name string
}
type InstanceDo struct {
g.Meta `orm:"table:instance, do:true"`
ID any `orm:"f_id,omitempty"`
}
var instance *Instance
err := db.Model("instance").Where(InstanceDo{
ID: 1,
}).Scan(&instance)
t.AssertNil(err)
t.AssertNE(instance, nil)
t.Assert(instance.ID, 1)
t.Assert(instance.Name, "john")
})
}

View File

@ -0,0 +1,177 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"testing"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_Model_LeftJoinOnField(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
LeftJoinOnField(table2, "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_RightJoinOnField(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
RightJoinOnField(table2, "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_InnerJoinOnField(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
InnerJoinOnField(table2, "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_LeftJoinOnFields(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
LeftJoinOnFields(table2, "id", "=", "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_RightJoinOnFields(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
RightJoinOnFields(table2, "id", "=", "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_InnerJoinOnFields(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "*").
InnerJoinOnFields(table2, "id", "=", "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 2)
})
}
func Test_Model_FieldsPrefix(t *testing.T) {
var (
table1 = "t_" + gtime.TimestampNanoStr() + "_table1"
table2 = "t_" + gtime.TimestampNanoStr() + "_table2"
)
createInitTable(table1)
defer dropTable(table1)
createInitTable(table2)
defer dropTable(table2)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table1).
FieldsPrefix(table1, "id").
FieldsPrefix(table2, "nickname").
LeftJoinOnField(table2, "id").
WhereIn("id", g.Slice{1, 2}).
Order("id asc").All()
t.AssertNil(err)
t.Assert(len(r), 2)
t.Assert(r[0]["id"], 1)
t.Assert(r[0]["nickname"], "name_1")
})
}

View File

@ -0,0 +1,477 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"database/sql"
"reflect"
"testing"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/test/gtest"
"github.com/gogf/gf/v2/util/gconv"
)
func Test_Model_Embedded_Insert(t *testing.T) {
table := createTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type Base struct {
Id int `json:"id"`
CreateTime string `json:"create_time"`
}
type User struct {
Base
Passport string `json:"passport"`
Password string `json:"password"`
Nickname string `json:"nickname"`
}
result, err := db.Model(table).Data(User{
Passport: "john-test",
Password: "123456",
Nickname: "John",
Base: Base{
Id: 100,
CreateTime: gtime.Now().String(),
},
}).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 1)
value, err := db.Model(table).Fields("passport").Where("id=100").Value()
t.AssertNil(err)
t.Assert(value.String(), "john-test")
})
}
func Test_Model_Embedded_MapToStruct(t *testing.T) {
table := createTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
type Ids struct {
Id int `json:"id"`
}
type Base struct {
Ids
CreateTime string `json:"create_time"`
}
type User struct {
Base
Passport string `json:"passport"`
Password string `json:"password"`
Nickname string `json:"nickname"`
}
data := g.Map{
"id": 100,
"passport": "t1",
"password": "123456",
"nickname": "T1",
"create_time": gtime.Now().String(),
}
result, err := db.Model(table).Data(data).Insert()
t.AssertNil(err)
n, _ := result.RowsAffected()
t.Assert(n, 1)
one, err := db.Model(table).Where("id=100").One()
t.AssertNil(err)
user := new(User)
t.Assert(one.Struct(user), nil)
t.Assert(user.Id, data["id"])
t.Assert(user.Passport, data["passport"])
t.Assert(user.Password, data["password"])
t.Assert(user.Nickname, data["nickname"])
t.Assert(user.CreateTime, data["create_time"])
})
}
func Test_Struct_Pointer_Attribute(t *testing.T) {
table := createInitTable()
defer dropTable(table)
type User struct {
Id *int
Passport *string
Password *string
Nickname string
}
gtest.C(t, func(t *gtest.T) {
one, err := db.Model(table).WherePri(1).One()
t.AssertNil(err)
user := new(User)
err = one.Struct(user)
t.AssertNil(err)
t.Assert(*user.Id, 1)
t.Assert(*user.Passport, "user_1")
t.Assert(*user.Password, "pass_1")
t.Assert(user.Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
user := new(User)
err := db.Model(table).Scan(user, "id=1")
t.AssertNil(err)
t.Assert(*user.Id, 1)
t.Assert(*user.Passport, "user_1")
t.Assert(*user.Password, "pass_1")
t.Assert(user.Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
var user *User
err := db.Model(table).Scan(&user, "id=1")
t.AssertNil(err)
t.Assert(*user.Id, 1)
t.Assert(*user.Passport, "user_1")
t.Assert(*user.Password, "pass_1")
t.Assert(user.Nickname, "name_1")
})
}
func Test_Structs_Pointer_Attribute(t *testing.T) {
table := createInitTable()
defer dropTable(table)
type User struct {
Id *int
Passport *string
Password *string
Nickname string
}
// All
gtest.C(t, func(t *gtest.T) {
one, err := db.Model(table).All("id < 3")
t.AssertNil(err)
users := make([]User, 0)
err = one.Structs(&users)
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
one, err := db.Model(table).All("id < 3")
t.AssertNil(err)
users := make([]*User, 0)
err = one.Structs(&users)
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
var users []User
one, err := db.Model(table).All("id < 3")
t.AssertNil(err)
err = one.Structs(&users)
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
var users []*User
one, err := db.Model(table).All("id < 3")
t.AssertNil(err)
err = one.Structs(&users)
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
// Structs
gtest.C(t, func(t *gtest.T) {
users := make([]User, 0)
err := db.Model(table).Scan(&users, "id < 3")
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
users := make([]*User, 0)
err := db.Model(table).Scan(&users, "id < 3")
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
var users []User
err := db.Model(table).Scan(&users, "id < 3")
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
gtest.C(t, func(t *gtest.T) {
var users []*User
err := db.Model(table).Scan(&users, "id < 3")
t.AssertNil(err)
t.Assert(len(users), 2)
t.Assert(*users[0].Id, 1)
t.Assert(*users[0].Passport, "user_1")
t.Assert(*users[0].Password, "pass_1")
t.Assert(users[0].Nickname, "name_1")
})
}
func Test_Struct_Empty(t *testing.T) {
table := createTable()
defer dropTable(table)
type User struct {
Id int
Passport string
Password string
Nickname string
}
gtest.C(t, func(t *gtest.T) {
user := new(User)
err := db.Model(table).Where("id=100").Scan(user)
t.Assert(err, sql.ErrNoRows)
t.AssertNE(user, nil)
})
gtest.C(t, func(t *gtest.T) {
one, err := db.Model(table).Where("id=100").One()
t.AssertNil(err)
var user *User
t.Assert(one.Struct(&user), nil)
t.Assert(user, nil)
})
gtest.C(t, func(t *gtest.T) {
var user *User
err := db.Model(table).Where("id=100").Scan(&user)
t.AssertNil(err)
t.Assert(user, nil)
})
}
func Test_Structs_Empty(t *testing.T) {
table := createTable()
defer dropTable(table)
type User struct {
Id int
Passport string
Password string
Nickname string
}
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
users := make([]User, 0)
t.Assert(all.Structs(&users), nil)
})
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
users := make([]User, 10)
t.Assert(all.Structs(&users), sql.ErrNoRows)
})
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
var users []User
t.Assert(all.Structs(&users), nil)
})
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
users := make([]*User, 0)
t.Assert(all.Structs(&users), nil)
})
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
users := make([]*User, 10)
t.Assert(all.Structs(&users), sql.ErrNoRows)
})
gtest.C(t, func(t *gtest.T) {
all, err := db.Model(table).Where("id>100").All()
t.AssertNil(err)
var users []*User
t.Assert(all.Structs(&users), nil)
})
}
type MyTime struct {
gtime.Time
}
type MyTimeSt struct {
CreateTime MyTime
}
func (st *MyTimeSt) UnmarshalValue(v any) error {
m := gconv.Map(v)
t, err := gtime.StrToTime(gconv.String(m["create_time"]))
if err != nil {
return err
}
st.CreateTime = MyTime{*t}
return nil
}
func Test_Model_Scan_CustomType_Time(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
st := new(MyTimeSt)
err := db.Model(table).Fields("create_time").Scan(st)
t.AssertNil(err)
t.Assert(st.CreateTime.String(), "2018-10-24 10:00:00")
})
gtest.C(t, func(t *gtest.T) {
var stSlice []*MyTimeSt
err := db.Model(table).Fields("create_time").Scan(&stSlice)
t.AssertNil(err)
t.Assert(len(stSlice), TableSize)
t.Assert(stSlice[0].CreateTime.String(), "2018-10-24 10:00:00")
t.Assert(stSlice[9].CreateTime.String(), "2018-10-24 10:00:00")
})
}
func Test_Model_Scan_CustomType_String(t *testing.T) {
type MyString string
type MyStringSt struct {
Passport MyString
}
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
st := new(MyStringSt)
err := db.Model(table).Fields("Passport").WherePri(1).Scan(st)
t.AssertNil(err)
t.Assert(st.Passport, "user_1")
})
gtest.C(t, func(t *gtest.T) {
var sts []MyStringSt
err := db.Model(table).Fields("Passport").Order("id asc").Scan(&sts)
t.AssertNil(err)
t.Assert(len(sts), TableSize)
t.Assert(sts[0].Passport, "user_1")
})
}
type User struct {
Id int
Passport string
Password string
Nickname string
CreateTime *gtime.Time
}
func (user *User) UnmarshalValue(value any) error {
if record, ok := value.(gdb.Record); ok {
*user = User{
Id: record["id"].Int(),
Passport: record["passport"].String(),
Password: "",
Nickname: record["nickname"].String(),
CreateTime: record["create_time"].GTime(),
}
return nil
}
return gerror.NewCodef(gcode.CodeInvalidParameter, `unsupported value type for UnmarshalValue: %v`, reflect.TypeOf(value))
}
func Test_Model_Scan_UnmarshalValue(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
var users []*User
err := db.Model(table).Order("id asc").Scan(&users)
t.AssertNil(err)
t.Assert(len(users), TableSize)
t.Assert(users[0].Id, 1)
t.Assert(users[0].Passport, "user_1")
t.Assert(users[0].Password, "")
t.Assert(users[0].Nickname, "name_1")
t.Assert(users[0].CreateTime.String(), CreateTime)
t.Assert(users[9].Id, 10)
t.Assert(users[9].Passport, "user_10")
t.Assert(users[9].Password, "")
t.Assert(users[9].Nickname, "name_10")
t.Assert(users[9].CreateTime.String(), CreateTime)
})
}
func Test_Model_Scan_Map(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
var users []*User
err := db.Model(table).Order("id asc").Scan(&users)
t.AssertNil(err)
t.Assert(len(users), TableSize)
t.Assert(users[0].Id, 1)
t.Assert(users[0].Passport, "user_1")
t.Assert(users[0].Password, "")
t.Assert(users[0].Nickname, "name_1")
t.Assert(users[0].CreateTime.String(), CreateTime)
t.Assert(users[9].Id, 10)
t.Assert(users[9].Passport, "user_10")
t.Assert(users[9].Password, "")
t.Assert(users[9].Nickname, "name_10")
t.Assert(users[9].CreateTime.String(), CreateTime)
})
}
func Test_Scan_AutoFilteringByStructAttributes(t *testing.T) {
table := createInitTable()
defer dropTable(table)
type User struct {
Id int
Passport string
}
gtest.C(t, func(t *gtest.T) {
var user *User
err := db.Model(table).OrderAsc("id").Scan(&user)
t.AssertNil(err)
t.Assert(user.Id, 1)
})
gtest.C(t, func(t *gtest.T) {
var users []User
err := db.Model(table).OrderAsc("id").Scan(&users)
t.AssertNil(err)
t.Assert(len(users), TableSize)
t.Assert(users[0].Id, 1)
})
}

View File

@ -0,0 +1,66 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"testing"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_Model_SubQuery_Where(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).Where(
"id in ?",
db.Model(table).Fields("id").Where("id", g.Slice{1, 3, 5}),
).OrderAsc("id").All()
t.AssertNil(err)
t.Assert(len(r), 3)
t.Assert(r[0]["id"], 1)
t.Assert(r[1]["id"], 3)
t.Assert(r[2]["id"], 5)
})
}
func Test_Model_SubQuery_Having(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).Where(
"id in ?",
db.Model(table).Fields("id").Where("id", g.Slice{1, 3, 5}),
).Group("id").Having(
"id > ?",
db.Model(table).Fields("MAX(id)").Where("id", g.Slice{1, 3}),
).OrderAsc("id").All()
t.AssertNil(err)
t.Assert(len(r), 1)
t.Assert(r[0]["id"], 5)
})
}
func Test_Model_SubQuery_Model(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
subQuery1 := db.Model(table).Where("id", g.Slice{1, 3, 5})
subQuery2 := db.Model(table).Where("id", g.Slice{5, 7, 9})
r, err := db.Model("? AS a, ? AS b", subQuery1, subQuery2).Fields("a.id").Where("a.id=b.id").OrderAsc("id").All()
t.AssertNil(err)
t.Assert(len(r), 1)
t.Assert(r[0]["id"], 5)
})
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,146 @@
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package gaussdb_test
import (
"testing"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/test/gtest"
)
func Test_Union(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.Union(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").All()
t.AssertNil(err)
t.Assert(len(r), 3)
t.Assert(r[0]["id"], 3)
t.Assert(r[1]["id"], 2)
t.Assert(r[2]["id"], 1)
})
gtest.C(t, func(t *gtest.T) {
r, err := db.Union(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").One()
t.AssertNil(err)
t.Assert(r["id"], 3)
})
}
func Test_UnionAll(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.UnionAll(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").All()
t.AssertNil(err)
t.Assert(len(r), 5)
t.Assert(r[0]["id"], 3)
t.Assert(r[1]["id"], 2)
t.Assert(r[2]["id"], 2)
t.Assert(r[3]["id"], 1)
t.Assert(r[4]["id"], 1)
})
gtest.C(t, func(t *gtest.T) {
r, err := db.UnionAll(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").One()
t.AssertNil(err)
t.Assert(r["id"], 3)
})
}
func Test_Model_Union(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).Union(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").All()
t.AssertNil(err)
t.Assert(len(r), 3)
t.Assert(r[0]["id"], 3)
t.Assert(r[1]["id"], 2)
t.Assert(r[2]["id"], 1)
})
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).Union(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").One()
t.AssertNil(err)
t.Assert(r["id"], 3)
})
}
func Test_Model_UnionAll(t *testing.T) {
table := createInitTable()
defer dropTable(table)
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).UnionAll(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").All()
t.AssertNil(err)
t.Assert(len(r), 5)
t.Assert(r[0]["id"], 3)
t.Assert(r[1]["id"], 2)
t.Assert(r[2]["id"], 2)
t.Assert(r[3]["id"], 1)
t.Assert(r[4]["id"], 1)
})
gtest.C(t, func(t *gtest.T) {
r, err := db.Model(table).UnionAll(
db.Model(table).Where("id", 1),
db.Model(table).Where("id", 2),
db.Model(table).WhereIn("id", g.Slice{1, 2, 3}).OrderDesc("id"),
).OrderDesc("id").One()
t.AssertNil(err)
t.Assert(r["id"], 3)
})
}

Some files were not shown because too many files have changed in this diff Show More