@contentstack/cli-audit 1.10.0 → 1.11.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/lib/util/log.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.print = void 0;
3
+ exports.print = print;
4
4
  const tslib_1 = require("tslib");
5
5
  const map_1 = tslib_1.__importDefault(require("lodash/map"));
6
6
  const winston_1 = tslib_1.__importDefault(require("winston"));
@@ -150,4 +150,3 @@ function print(printInput) {
150
150
  }).join(' ');
151
151
  cli_utilities_1.cliux.print(str);
152
152
  }
153
- exports.print = print;
@@ -1,18 +1,12 @@
1
1
  {
2
- "version": "1.10.0",
3
2
  "commands": {
4
3
  "cm:stacks:audit:fix": {
5
- "id": "cm:stacks:audit:fix",
6
- "description": "Perform audits and fix possible errors in the exported Contentstack data.",
7
- "strict": true,
8
- "pluginName": "@contentstack/cli-audit",
9
- "pluginAlias": "@contentstack/cli-audit",
10
- "pluginType": "core",
11
4
  "aliases": [
12
5
  "audit:fix",
13
6
  "cm:stacks:audit:fix"
14
7
  ],
15
- "hiddenAliases": [],
8
+ "args": {},
9
+ "description": "Perform audits and fix possible errors in the exported Contentstack data.",
16
10
  "examples": [
17
11
  "$ <%= config.bin %> <%= command.id %> --copy-dir",
18
12
  "$ <%= config.bin %> <%= command.id %> --report-path=<path> --copy-dir",
@@ -22,23 +16,42 @@
22
16
  "$ <%= config.bin %> <%= command.id %> --report-path=<path> --modules=content-types --filter=\"name=\"<filter-value>\" --copy-dir --copy-path=<path>"
23
17
  ],
24
18
  "flags": {
19
+ "config": {
20
+ "char": "c",
21
+ "description": "Path of the external config",
22
+ "helpGroup": "COMMON",
23
+ "name": "config",
24
+ "hasDynamicHelp": false,
25
+ "multiple": false,
26
+ "type": "option"
27
+ },
28
+ "data-dir": {
29
+ "char": "d",
30
+ "description": "Path where the data is stored",
31
+ "helpGroup": "COMMON",
32
+ "name": "data-dir",
33
+ "hasDynamicHelp": false,
34
+ "multiple": false,
35
+ "type": "option"
36
+ },
25
37
  "report-path": {
26
- "name": "report-path",
27
- "type": "option",
28
38
  "description": "Path to store the audit reports",
29
- "multiple": false
39
+ "name": "report-path",
40
+ "hasDynamicHelp": false,
41
+ "multiple": false,
42
+ "type": "option"
30
43
  },
31
44
  "reference-only": {
32
- "name": "reference-only",
33
- "type": "boolean",
34
45
  "description": "Checks only for missing references.",
35
46
  "hidden": true,
36
- "allowNo": false
47
+ "name": "reference-only",
48
+ "allowNo": false,
49
+ "type": "boolean"
37
50
  },
38
51
  "modules": {
39
- "name": "modules",
40
- "type": "option",
41
52
  "description": "Provide the list of modules to be audited",
53
+ "name": "modules",
54
+ "hasDynamicHelp": false,
42
55
  "multiple": true,
43
56
  "options": [
44
57
  "content-types",
@@ -47,28 +60,31 @@
47
60
  "extensions",
48
61
  "workflows",
49
62
  "custom-roles",
50
- "assets"
51
- ]
63
+ "assets",
64
+ "field-rules"
65
+ ],
66
+ "type": "option"
52
67
  },
53
68
  "copy-dir": {
54
- "name": "copy-dir",
55
- "type": "boolean",
56
69
  "description": "Create backup from the original data.",
57
- "allowNo": false
70
+ "name": "copy-dir",
71
+ "allowNo": false,
72
+ "type": "boolean"
58
73
  },
59
74
  "copy-path": {
60
- "name": "copy-path",
61
- "type": "option",
62
- "description": "Provide the path to backup the copied data",
63
- "multiple": false,
64
75
  "dependsOn": [
65
76
  "copy-dir"
66
- ]
77
+ ],
78
+ "description": "Provide the path to backup the copied data",
79
+ "name": "copy-path",
80
+ "hasDynamicHelp": false,
81
+ "multiple": false,
82
+ "type": "option"
67
83
  },
68
84
  "fix-only": {
69
- "name": "fix-only",
70
- "type": "option",
71
85
  "description": "Provide the list of fix options",
86
+ "name": "fix-only",
87
+ "hasDynamicHelp": false,
72
88
  "multiple": true,
73
89
  "options": [
74
90
  "reference",
@@ -78,82 +94,108 @@
78
94
  "blocks",
79
95
  "group",
80
96
  "content_types"
81
- ]
97
+ ],
98
+ "type": "option"
82
99
  },
83
100
  "yes": {
84
- "name": "yes",
85
- "type": "boolean",
86
101
  "char": "y",
87
102
  "description": "Use this flag to skip confirmation",
88
103
  "hidden": true,
89
- "allowNo": false
104
+ "name": "yes",
105
+ "allowNo": false,
106
+ "type": "boolean"
90
107
  },
91
108
  "external-config": {
92
- "name": "external-config",
93
- "type": "option",
94
109
  "description": "Provide JSON input",
95
110
  "hidden": true,
96
- "multiple": false
111
+ "name": "external-config",
112
+ "hasDynamicHelp": false,
113
+ "multiple": false,
114
+ "type": "option"
97
115
  },
98
116
  "columns": {
99
- "name": "columns",
100
- "type": "option",
101
- "description": "Show only the specified columns (comma-separated)",
117
+ "description": "Specify columns to display, comma-separated.",
102
118
  "helpGroup": "TABLE",
119
+ "name": "columns",
120
+ "hasDynamicHelp": false,
103
121
  "multiple": false,
104
- "exclusive": [
105
- "extended"
106
- ]
122
+ "type": "option"
107
123
  },
108
124
  "sort": {
109
- "name": "sort",
110
- "type": "option",
111
- "description": "Property to sort by (prepend '-' for descending)",
125
+ "description": "Sort the table by a column. Use \"-\" for descending.",
112
126
  "helpGroup": "TABLE",
113
- "multiple": false
127
+ "name": "sort",
128
+ "hasDynamicHelp": false,
129
+ "multiple": false,
130
+ "type": "option"
114
131
  },
115
132
  "filter": {
116
- "name": "filter",
117
- "type": "option",
118
- "description": "Filter property by partial string matching. For example: name=foo",
133
+ "description": "Filter rows by a column value (e.g., name=foo).",
119
134
  "helpGroup": "TABLE",
120
- "multiple": false
135
+ "name": "filter",
136
+ "hasDynamicHelp": false,
137
+ "multiple": false,
138
+ "type": "option"
121
139
  },
122
140
  "csv": {
123
- "name": "csv",
124
- "type": "boolean",
125
- "description": "The output is in the CSV format [alias: --output=csv]",
141
+ "description": "Output results in CSV format.",
126
142
  "helpGroup": "TABLE",
143
+ "name": "csv",
127
144
  "allowNo": false,
128
- "exclusive": [
129
- "no-truncate"
130
- ]
145
+ "type": "boolean"
131
146
  },
132
147
  "no-truncate": {
148
+ "description": "Prevent truncation of long text in columns.",
149
+ "helpGroup": "TABLE",
133
150
  "name": "no-truncate",
134
- "type": "boolean",
135
- "description": "The output is not truncated to fit the screen",
151
+ "allowNo": false,
152
+ "type": "boolean"
153
+ },
154
+ "no-header": {
155
+ "description": "Hide table headers in output.",
136
156
  "helpGroup": "TABLE",
157
+ "name": "no-header",
137
158
  "allowNo": false,
138
- "exclusive": [
139
- "csv"
140
- ]
159
+ "type": "boolean"
160
+ },
161
+ "output": {
162
+ "description": "Specify output format: csv, json, or yaml.",
163
+ "helpGroup": "TABLE",
164
+ "name": "output",
165
+ "hasDynamicHelp": false,
166
+ "multiple": false,
167
+ "options": [
168
+ "csv",
169
+ "json",
170
+ "yaml"
171
+ ],
172
+ "type": "option"
141
173
  }
142
174
  },
143
- "args": {}
144
- },
145
- "cm:stacks:audit": {
146
- "id": "cm:stacks:audit",
147
- "description": "Perform audits and find possible errors in the exported Contentstack data",
148
- "strict": true,
149
- "pluginName": "@contentstack/cli-audit",
175
+ "hasDynamicHelp": false,
176
+ "hiddenAliases": [],
177
+ "id": "cm:stacks:audit:fix",
150
178
  "pluginAlias": "@contentstack/cli-audit",
179
+ "pluginName": "@contentstack/cli-audit",
151
180
  "pluginType": "core",
181
+ "strict": true,
182
+ "isESM": false,
183
+ "relativePath": [
184
+ "lib",
185
+ "commands",
186
+ "cm",
187
+ "stacks",
188
+ "audit",
189
+ "fix.js"
190
+ ]
191
+ },
192
+ "cm:stacks:audit": {
152
193
  "aliases": [
153
194
  "audit",
154
195
  "cm:stacks:audit"
155
196
  ],
156
- "hiddenAliases": [],
197
+ "args": {},
198
+ "description": "Perform audits and find possible errors in the exported Contentstack data",
157
199
  "examples": [
158
200
  "$ <%= config.bin %> <%= command.id %>",
159
201
  "$ <%= config.bin %> <%= command.id %> --report-path=<path>",
@@ -162,23 +204,42 @@
162
204
  "$ <%= config.bin %> <%= command.id %> --report-path=<path> --modules=content-types --filter=\"name=\"<filter-value>\""
163
205
  ],
164
206
  "flags": {
207
+ "config": {
208
+ "char": "c",
209
+ "description": "Path of the external config",
210
+ "helpGroup": "COMMON",
211
+ "name": "config",
212
+ "hasDynamicHelp": false,
213
+ "multiple": false,
214
+ "type": "option"
215
+ },
216
+ "data-dir": {
217
+ "char": "d",
218
+ "description": "Path where the data is stored",
219
+ "helpGroup": "COMMON",
220
+ "name": "data-dir",
221
+ "hasDynamicHelp": false,
222
+ "multiple": false,
223
+ "type": "option"
224
+ },
165
225
  "report-path": {
166
- "name": "report-path",
167
- "type": "option",
168
226
  "description": "Path to store the audit reports",
169
- "multiple": false
227
+ "name": "report-path",
228
+ "hasDynamicHelp": false,
229
+ "multiple": false,
230
+ "type": "option"
170
231
  },
171
232
  "reference-only": {
172
- "name": "reference-only",
173
- "type": "boolean",
174
233
  "description": "Checks only for missing references.",
175
234
  "hidden": true,
176
- "allowNo": false
235
+ "name": "reference-only",
236
+ "allowNo": false,
237
+ "type": "boolean"
177
238
  },
178
239
  "modules": {
179
- "name": "modules",
180
- "type": "option",
181
240
  "description": "Provide the list of modules to be audited",
241
+ "name": "modules",
242
+ "hasDynamicHelp": false,
182
243
  "multiple": true,
183
244
  "options": [
184
245
  "content-types",
@@ -187,55 +248,87 @@
187
248
  "extensions",
188
249
  "workflows",
189
250
  "custom-roles",
190
- "assets"
191
- ]
251
+ "assets",
252
+ "field-rules"
253
+ ],
254
+ "type": "option"
192
255
  },
193
256
  "columns": {
194
- "name": "columns",
195
- "type": "option",
196
- "description": "Show only the specified columns (comma-separated)",
257
+ "description": "Specify columns to display, comma-separated.",
197
258
  "helpGroup": "TABLE",
259
+ "name": "columns",
260
+ "hasDynamicHelp": false,
198
261
  "multiple": false,
199
- "exclusive": [
200
- "extended"
201
- ]
262
+ "type": "option"
202
263
  },
203
264
  "sort": {
204
- "name": "sort",
205
- "type": "option",
206
- "description": "Property to sort by (prepend '-' for descending)",
265
+ "description": "Sort the table by a column. Use \"-\" for descending.",
207
266
  "helpGroup": "TABLE",
208
- "multiple": false
267
+ "name": "sort",
268
+ "hasDynamicHelp": false,
269
+ "multiple": false,
270
+ "type": "option"
209
271
  },
210
272
  "filter": {
211
- "name": "filter",
212
- "type": "option",
213
- "description": "Filter property by partial string matching. For example: name=foo",
273
+ "description": "Filter rows by a column value (e.g., name=foo).",
214
274
  "helpGroup": "TABLE",
215
- "multiple": false
275
+ "name": "filter",
276
+ "hasDynamicHelp": false,
277
+ "multiple": false,
278
+ "type": "option"
216
279
  },
217
280
  "csv": {
218
- "name": "csv",
219
- "type": "boolean",
220
- "description": "The output is in the CSV format [alias: --output=csv]",
281
+ "description": "Output results in CSV format.",
221
282
  "helpGroup": "TABLE",
283
+ "name": "csv",
222
284
  "allowNo": false,
223
- "exclusive": [
224
- "no-truncate"
225
- ]
285
+ "type": "boolean"
226
286
  },
227
287
  "no-truncate": {
288
+ "description": "Prevent truncation of long text in columns.",
289
+ "helpGroup": "TABLE",
228
290
  "name": "no-truncate",
229
- "type": "boolean",
230
- "description": "The output is not truncated to fit the screen",
291
+ "allowNo": false,
292
+ "type": "boolean"
293
+ },
294
+ "no-header": {
295
+ "description": "Hide table headers in output.",
231
296
  "helpGroup": "TABLE",
297
+ "name": "no-header",
232
298
  "allowNo": false,
233
- "exclusive": [
234
- "csv"
235
- ]
299
+ "type": "boolean"
300
+ },
301
+ "output": {
302
+ "description": "Specify output format: csv, json, or yaml.",
303
+ "helpGroup": "TABLE",
304
+ "name": "output",
305
+ "hasDynamicHelp": false,
306
+ "multiple": false,
307
+ "options": [
308
+ "csv",
309
+ "json",
310
+ "yaml"
311
+ ],
312
+ "type": "option"
236
313
  }
237
314
  },
238
- "args": {}
315
+ "hasDynamicHelp": false,
316
+ "hiddenAliases": [],
317
+ "id": "cm:stacks:audit",
318
+ "pluginAlias": "@contentstack/cli-audit",
319
+ "pluginName": "@contentstack/cli-audit",
320
+ "pluginType": "core",
321
+ "strict": true,
322
+ "isESM": false,
323
+ "relativePath": [
324
+ "lib",
325
+ "commands",
326
+ "cm",
327
+ "stacks",
328
+ "audit",
329
+ "index.js"
330
+ ]
239
331
  }
240
- }
332
+ },
333
+ "version": "1.11.0"
241
334
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentstack/cli-audit",
3
- "version": "1.10.0",
3
+ "version": "1.11.0",
4
4
  "description": "Contentstack audit plugin",
5
5
  "author": "Contentstack CLI",
6
6
  "homepage": "https://github.com/contentstack/cli",
@@ -18,10 +18,10 @@
18
18
  "/oclif.manifest.json"
19
19
  ],
20
20
  "dependencies": {
21
- "@contentstack/cli-command": "~1.3.3",
22
- "@contentstack/cli-utilities": "~1.9.0",
23
- "@oclif/plugin-help": "^5.2.20",
24
- "@oclif/plugin-plugins": "^5.4.34",
21
+ "@contentstack/cli-command": "~1.5.0",
22
+ "@oclif/plugin-help": "^6.2.25",
23
+ "@contentstack/cli-utilities": "~1.11.0",
24
+ "@oclif/plugin-plugins": "^5.4.24",
25
25
  "chalk": "^4.1.2",
26
26
  "fast-csv": "^4.3.6",
27
27
  "fs-extra": "^11.3.0",
@@ -30,19 +30,19 @@
30
30
  "winston": "^3.17.0"
31
31
  },
32
32
  "devDependencies": {
33
- "@oclif/test": "^4.1.12",
33
+ "@oclif/test": "^4.1.11",
34
34
  "@types/chai": "^4.3.20",
35
35
  "@types/fs-extra": "^11.0.4",
36
36
  "@types/mocha": "^10.0.10",
37
- "@types/node": "^20.17.28",
37
+ "@types/node": "^20.17.19",
38
38
  "@types/uuid": "^9.0.8",
39
39
  "chai": "^4.5.0",
40
40
  "eslint": "^8.57.1",
41
- "eslint-config-oclif": "^4.0.0",
41
+ "eslint-config-oclif": "^6.0.15",
42
42
  "eslint-config-oclif-typescript": "^3.1.14",
43
43
  "mocha": "^10.8.2",
44
44
  "nyc": "^15.1.0",
45
- "oclif": "^3.17.2",
45
+ "oclif": "^4.17.30",
46
46
  "shx": "^0.3.4",
47
47
  "sinon": "^19.0.5",
48
48
  "ts-node": "^10.9.2",
@@ -69,11 +69,11 @@
69
69
  "lint": "eslint . --ext .ts --config .eslintrc",
70
70
  "postpack": "shx rm -f oclif.manifest.json",
71
71
  "posttest": "npm run lint",
72
- "compile": "shx rm -rf lib && tsc -b",
73
- "prepack": "npm run build && oclif manifest && oclif readme",
72
+ "compile": "shx rm -rf lib tsconfig.tsbuildinfo && tsc -b",
73
+ "prepack": "pnpm compile && oclif manifest && oclif readme",
74
74
  "test": "mocha --forbid-only \"test/**/*.test.ts\"",
75
75
  "version": "oclif readme && git add README.md",
76
- "clean": "rm -rf ./lib ./node_modules tsconfig.tsbuildinfo oclif.manifest.json",
76
+ "clean": "rm -rf ./lib ./node_modules .tsbuildinfo oclif.manifest.json",
77
77
  "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
78
78
  "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\""
79
79
  },