Skip to content

Commit 29864e1

Browse files
authored
Merge pull request #1856 from contentstack/feat/DX-2332
DX - 2332 - Feat: Added Summary for the audited data
2 parents 90edc42 + cf85ca6 commit 29864e1

File tree

18 files changed

+12639
-23484
lines changed

18 files changed

+12639
-23484
lines changed

package-lock.json

Lines changed: 12248 additions & 23307 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/contentstack-audit/README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Perform audits and find possible errors in the exported Contentstack data
5252

5353
```
5454
USAGE
55-
$ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
55+
$ csdx audit [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
5656
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
5757
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
5858
@@ -63,8 +63,9 @@ FLAGS
6363
--report-path=<value> Path to store the audit reports
6464
6565
COMMON FLAGS
66-
-c, --config=<value> Path of the external config
67-
-d, --data-dir=<value> Path where the data is stored
66+
-c, --config=<value> Path of the external config
67+
-d, --data-dir=<value> Path where the data is stored
68+
-s, --show-console-output Display the audit and audit fix result for individual modules
6869
6970
TABLE FLAGS
7071
--columns=<value> Specify columns to display, comma-separated.
@@ -101,7 +102,7 @@ Perform audits and fix possible errors in the exported Contentstack data.
101102

102103
```
103104
USAGE
104-
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
105+
$ csdx audit:fix [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
105106
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
106107
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
107108
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
@@ -117,8 +118,9 @@ FLAGS
117118
--report-path=<value> Path to store the audit reports
118119
119120
COMMON FLAGS
120-
-c, --config=<value> Path of the external config
121-
-d, --data-dir=<value> Path where the data is stored
121+
-c, --config=<value> Path of the external config
122+
-d, --data-dir=<value> Path where the data is stored
123+
-s, --show-console-output Display the audit and audit fix result for individual modules
122124
123125
TABLE FLAGS
124126
--columns=<value> Specify columns to display, comma-separated.
@@ -157,7 +159,7 @@ Perform audits and find possible errors in the exported Contentstack data
157159

158160
```
159161
USAGE
160-
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
162+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
161163
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
162164
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
163165
@@ -168,8 +170,9 @@ FLAGS
168170
--report-path=<value> Path to store the audit reports
169171
170172
COMMON FLAGS
171-
-c, --config=<value> Path of the external config
172-
-d, --data-dir=<value> Path where the data is stored
173+
-c, --config=<value> Path of the external config
174+
-d, --data-dir=<value> Path where the data is stored
175+
-s, --show-console-output Display the audit and audit fix result for individual modules
173176
174177
TABLE FLAGS
175178
--columns=<value> Specify columns to display, comma-separated.
@@ -208,7 +211,7 @@ Perform audits and fix possible errors in the exported Contentstack data.
208211

209212
```
210213
USAGE
211-
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
214+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
212215
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
213216
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
214217
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
@@ -224,8 +227,9 @@ FLAGS
224227
--report-path=<value> Path to store the audit reports
225228
226229
COMMON FLAGS
227-
-c, --config=<value> Path of the external config
228-
-d, --data-dir=<value> Path where the data is stored
230+
-c, --config=<value> Path of the external config
231+
-d, --data-dir=<value> Path where the data is stored
232+
-s, --show-console-output Display the audit and audit fix result for individual modules
229233
230234
TABLE FLAGS
231235
--columns=<value> Specify columns to display, comma-separated.

packages/contentstack-audit/package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
],
2020
"dependencies": {
2121
"@contentstack/cli-command": "~1.5.0",
22-
"@oclif/plugin-help": "^6.2.25",
22+
"@oclif/plugin-help": "^6.2.27",
2323
"@contentstack/cli-utilities": "~1.11.0",
24-
"@oclif/plugin-plugins": "^5.4.24",
24+
"@oclif/plugin-plugins": "^5.4.36",
2525
"chalk": "^4.1.2",
2626
"fast-csv": "^4.3.6",
2727
"fs-extra": "^11.3.0",
@@ -30,23 +30,23 @@
3030
"winston": "^3.17.0"
3131
},
3232
"devDependencies": {
33-
"@oclif/test": "^4.1.11",
33+
"@oclif/test": "^4.1.12",
3434
"@types/chai": "^4.3.20",
3535
"@types/fs-extra": "^11.0.4",
3636
"@types/mocha": "^10.0.10",
37-
"@types/node": "^20.17.19",
37+
"@types/node": "^20.17.30",
3838
"@types/uuid": "^9.0.8",
3939
"chai": "^4.5.0",
4040
"eslint": "^8.57.1",
41-
"eslint-config-oclif": "^6.0.15",
41+
"eslint-config-oclif": "^6.0.42",
4242
"eslint-config-oclif-typescript": "^3.1.14",
4343
"mocha": "^10.8.2",
4444
"nyc": "^15.1.0",
45-
"oclif": "^4.17.30",
46-
"shx": "^0.3.4",
45+
"oclif": "^4.17.43",
46+
"shx": "^0.4.0",
4747
"sinon": "^19.0.5",
4848
"ts-node": "^10.9.2",
49-
"typescript": "^5.7.3"
49+
"typescript": "^5.8.3"
5050
},
5151
"oclif": {
5252
"bin": "csdx",

0 commit comments

Comments
 (0)