@memberjunction/cli 2.128.0 → 2.129.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/oclif.manifest.json +23 -23
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -177,6 +177,31 @@ Available sync commands:
|
|
|
177
177
|
|
|
178
178
|
**📚 For detailed documentation:** See the [MetadataSync README](../MetadataSync/README.md)
|
|
179
179
|
|
|
180
|
+
#### Adding Comments to JSON Metadata Files
|
|
181
|
+
|
|
182
|
+
Since JSON doesn't support comments natively, you can add documentation to your metadata files using custom keys with an underscore prefix. These keys are preserved but ignored during sync operations:
|
|
183
|
+
|
|
184
|
+
```json
|
|
185
|
+
{
|
|
186
|
+
"_comments": [
|
|
187
|
+
"This file configures encryption for sensitive fields",
|
|
188
|
+
"See /metadata/encryption-keys/ for key configuration"
|
|
189
|
+
],
|
|
190
|
+
"fields": {
|
|
191
|
+
"Name": "My Entity",
|
|
192
|
+
"Encrypt": true
|
|
193
|
+
},
|
|
194
|
+
"_note": "Comments can appear anywhere in the record"
|
|
195
|
+
}
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
**Key points:**
|
|
199
|
+
- Use underscore prefix (`_comments`, `_note`, etc.) by convention
|
|
200
|
+
- Comments are preserved in their original position after sync operations
|
|
201
|
+
- Reserved keys: `fields`, `relatedEntities`, `primaryKey`, `sync`, `deleteRecord`
|
|
202
|
+
|
|
203
|
+
See the [MetadataSync README](../MetadataSync/README.md#adding-comments-to-json-metadata-files) for complete documentation.
|
|
204
|
+
|
|
180
205
|
#### Quick Examples:
|
|
181
206
|
```bash
|
|
182
207
|
# Validate all metadata files
|
package/oclif.manifest.json
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commands": {
|
|
3
|
+
"ai": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "Execute AI agents and actions",
|
|
7
|
+
"flags": {},
|
|
8
|
+
"hasDynamicHelp": false,
|
|
9
|
+
"hidden": false,
|
|
10
|
+
"hiddenAliases": [],
|
|
11
|
+
"id": "ai",
|
|
12
|
+
"pluginAlias": "@memberjunction/cli",
|
|
13
|
+
"pluginName": "@memberjunction/cli",
|
|
14
|
+
"pluginType": "core",
|
|
15
|
+
"strict": true,
|
|
16
|
+
"enableJsonFlag": false,
|
|
17
|
+
"isESM": false,
|
|
18
|
+
"relativePath": [
|
|
19
|
+
"dist",
|
|
20
|
+
"commands",
|
|
21
|
+
"ai",
|
|
22
|
+
"index.js"
|
|
23
|
+
]
|
|
24
|
+
},
|
|
3
25
|
"bump": {
|
|
4
26
|
"aliases": [],
|
|
5
27
|
"args": {},
|
|
@@ -72,28 +94,6 @@
|
|
|
72
94
|
"index.js"
|
|
73
95
|
]
|
|
74
96
|
},
|
|
75
|
-
"ai": {
|
|
76
|
-
"aliases": [],
|
|
77
|
-
"args": {},
|
|
78
|
-
"description": "Execute AI agents and actions",
|
|
79
|
-
"flags": {},
|
|
80
|
-
"hasDynamicHelp": false,
|
|
81
|
-
"hidden": false,
|
|
82
|
-
"hiddenAliases": [],
|
|
83
|
-
"id": "ai",
|
|
84
|
-
"pluginAlias": "@memberjunction/cli",
|
|
85
|
-
"pluginName": "@memberjunction/cli",
|
|
86
|
-
"pluginType": "core",
|
|
87
|
-
"strict": true,
|
|
88
|
-
"enableJsonFlag": false,
|
|
89
|
-
"isESM": false,
|
|
90
|
-
"relativePath": [
|
|
91
|
-
"dist",
|
|
92
|
-
"commands",
|
|
93
|
-
"ai",
|
|
94
|
-
"index.js"
|
|
95
|
-
]
|
|
96
|
-
},
|
|
97
97
|
"clean": {
|
|
98
98
|
"aliases": [],
|
|
99
99
|
"args": {},
|
|
@@ -2500,5 +2500,5 @@
|
|
|
2500
2500
|
]
|
|
2501
2501
|
}
|
|
2502
2502
|
},
|
|
2503
|
-
"version": "2.
|
|
2503
|
+
"version": "2.129.0"
|
|
2504
2504
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memberjunction/cli",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.129.0",
|
|
4
4
|
"description": "MemberJunction command line tools",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"oclif"
|
|
@@ -51,14 +51,14 @@
|
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
53
|
"@inquirer/prompts": "^5.0.1",
|
|
54
|
-
"@memberjunction/ai-cli": "2.
|
|
55
|
-
"@memberjunction/codegen-lib": "2.
|
|
56
|
-
"@memberjunction/core": "2.
|
|
57
|
-
"@memberjunction/db-auto-doc": "2.
|
|
58
|
-
"@memberjunction/metadata-sync": "2.
|
|
59
|
-
"@memberjunction/query-gen": "2.
|
|
60
|
-
"@memberjunction/sqlserver-dataprovider": "2.
|
|
61
|
-
"@memberjunction/testing-cli": "2.
|
|
54
|
+
"@memberjunction/ai-cli": "2.129.0",
|
|
55
|
+
"@memberjunction/codegen-lib": "2.129.0",
|
|
56
|
+
"@memberjunction/core": "2.129.0",
|
|
57
|
+
"@memberjunction/db-auto-doc": "2.129.0",
|
|
58
|
+
"@memberjunction/metadata-sync": "2.129.0",
|
|
59
|
+
"@memberjunction/query-gen": "2.129.0",
|
|
60
|
+
"@memberjunction/sqlserver-dataprovider": "2.129.0",
|
|
61
|
+
"@memberjunction/testing-cli": "2.129.0",
|
|
62
62
|
"@oclif/core": "^3",
|
|
63
63
|
"@oclif/plugin-help": "^6",
|
|
64
64
|
"@oclif/plugin-version": "^2.0.17",
|