cmd/ent: add comments to 'describe' command (#3067)

This commit is contained in:
nzlov
2022-11-07 22:23:07 +08:00
committed by GitHub
parent a91aabe3ef
commit 942eb56b2a
3 changed files with 62 additions and 60 deletions

View File

@@ -35,14 +35,14 @@ func TestPrinter_Print(t *testing.T) {
},
out: `
User:
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators |
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| id | int | false | false | false | false | false | false | | 0 |
| name | string | false | false | false | false | false | false | | 1 |
| age | int | false | false | true | false | false | false | | 0 |
| created_at | time.Time | false | false | true | false | false | true | | 0 |
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators | Comment |
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| id | int | false | false | false | false | false | false | | 0 | |
| name | string | false | false | false | false | false | false | | 1 | |
| age | int | false | false | true | false | false | false | | 0 | |
| created_at | time.Time | false | false | true | false | false | true | | 0 | |
+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
`,
},
@@ -61,17 +61,17 @@ User:
},
out: `
User:
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators |
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| id | int | false | false | false | false | false | false | | 0 |
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
+--------+-------+---------+---------+----------+--------+----------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional |
+--------+-------+---------+---------+----------+--------+----------+
| groups | Group | false | | M2M | false | true |
| spouse | User | false | | O2O | true | false |
+--------+-------+---------+---------+----------+--------+----------+
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators | Comment |
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| id | int | false | false | false | false | false | false | | 0 | |
+-------+------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
+--------+-------+---------+---------+----------+--------+----------+---------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional | Comment |
+--------+-------+---------+---------+----------+--------+----------+---------+
| groups | Group | false | | M2M | false | true | |
| spouse | User | false | | O2O | true | false | |
+--------+-------+---------+---------+----------+--------+----------+---------+
`,
},
@@ -94,19 +94,19 @@ User:
},
out: `
User:
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| id | int | false | false | false | false | false | false | | 0 |
| name | string | false | false | false | false | false | false | | 1 |
| age | int | false | false | true | false | false | false | | 0 |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
+--------+-------+---------+---------+----------+--------+----------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional |
+--------+-------+---------+---------+----------+--------+----------+
| groups | Group | false | | M2M | false | true |
| spouse | User | false | | O2O | true | false |
+--------+-------+---------+---------+----------+--------+----------+
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators | Comment |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| id | int | false | false | false | false | false | false | | 0 | |
| name | string | false | false | false | false | false | false | | 1 | |
| age | int | false | false | true | false | false | false | | 0 | |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
+--------+-------+---------+---------+----------+--------+----------+---------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional | Comment |
+--------+-------+---------+---------+----------+--------+----------+---------+
| groups | Group | false | | M2M | false | true | |
| spouse | User | false | | O2O | true | false | |
+--------+-------+---------+---------+----------+--------+----------+---------+
`,
},
@@ -139,32 +139,32 @@ User:
},
out: `
User:
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| id | int | false | false | false | false | false | false | | 0 |
| name | string | false | false | false | false | false | false | | 1 |
| age | int | false | false | true | false | false | false | | 0 |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
+--------+-------+---------+---------+----------+--------+----------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional |
+--------+-------+---------+---------+----------+--------+----------+
| groups | Group | false | | M2M | false | true |
| spouse | User | false | | O2O | true | false |
+--------+-------+---------+---------+----------+--------+----------+
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators | Comment |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| id | int | false | false | false | false | false | false | | 0 | |
| name | string | false | false | false | false | false | false | | 1 | |
| age | int | false | false | true | false | false | false | | 0 | |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
+--------+-------+---------+---------+----------+--------+----------+---------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional | Comment |
+--------+-------+---------+---------+----------+--------+----------+---------+
| groups | Group | false | | M2M | false | true | |
| spouse | User | false | | O2O | true | false | |
+--------+-------+---------+---------+----------+--------+----------+---------+
Group:
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
| id | int | false | false | false | false | false | false | | 0 |
| name | string | false | false | false | false | false | false | | 0 |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+
+-------+------+---------+---------+----------+--------+----------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional |
+-------+------+---------+---------+----------+--------+----------+
| users | User | false | | M2M | false | true |
+-------+------+---------+---------+----------+--------+----------+
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| Field | Type | Unique | Optional | Nillable | Default | UpdateDefault | Immutable | StructTag | Validators | Comment |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
| id | int | false | false | false | false | false | false | | 0 | |
| name | string | false | false | false | false | false | false | | 0 | |
+-------+--------+--------+----------+----------+---------+---------------+-----------+-----------+------------+---------+
+-------+------+---------+---------+----------+--------+----------+---------+
| Edge | Type | Inverse | BackRef | Relation | Unique | Optional | Comment |
+-------+------+---------+---------+----------+--------+----------+---------+
| users | User | false | | M2M | false | true | |
+-------+------+---------+---------+----------+--------+----------+---------+
`,
},