Skip to content

DX - 2332 - Feat: Added Summary for the audited data #1856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 11, 2025
Merged

DX - 2332 - Feat: Added Summary for the audited data #1856

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6fcb13e
Feat: Added a summary view of the audited Data
cs-raj Apr 10, 2025
d3066de
v2
cs-raj Apr 10, 2025
c8c7fcc
Merge branch 'development' into feat/DX-2332
cs-raj Apr 10, 2025
009724d
Lock file update
cs-raj Apr 10, 2025
f01b41d
Fixed PR comments
cs-raj Apr 10, 2025
e69946f
Fixed the build script
cs-raj Apr 10, 2025
5cb98d7
Merge branch 'development' into feat/DX-2332
cs-raj Apr 11, 2025
668c702
Lock File update
cs-raj Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
644 changes: 281 additions & 363 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 16 additions & 12 deletions packages/contentstack-audit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Perform audits and find possible errors in the exported Contentstack data

```
USAGE
$ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
$ csdx audit [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]

Expand All @@ -63,8 +63,9 @@ FLAGS
--report-path=<value> Path to store the audit reports

COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-s, --show-console-output Display the audit and audit fix result for individual modules

TABLE FLAGS
--columns=<value> Specify columns to display, comma-separated.
Expand Down Expand Up @@ -101,7 +102,7 @@ Perform audits and fix possible errors in the exported Contentstack data.

```
USAGE
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
$ csdx audit:fix [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
Expand All @@ -117,8 +118,9 @@ FLAGS
--report-path=<value> Path to store the audit reports

COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-s, --show-console-output Display the audit and audit fix result for individual modules

TABLE FLAGS
--columns=<value> Specify columns to display, comma-separated.
Expand Down Expand Up @@ -157,7 +159,7 @@ Perform audits and find possible errors in the exported Contentstack data

```
USAGE
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]

Expand All @@ -168,8 +170,9 @@ FLAGS
--report-path=<value> Path to store the audit reports

COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-s, --show-console-output Display the audit and audit fix result for individual modules

TABLE FLAGS
--columns=<value> Specify columns to display, comma-separated.
Expand Down Expand Up @@ -208,7 +211,7 @@ Perform audits and fix possible errors in the exported Contentstack data.

```
USAGE
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [-s] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
Expand All @@ -224,8 +227,9 @@ FLAGS
--report-path=<value> Path to store the audit reports

COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
-s, --show-console-output Display the audit and audit fix result for individual modules

TABLE FLAGS
--columns=<value> Specify columns to display, comma-separated.
Expand Down
18 changes: 9 additions & 9 deletions packages/contentstack-audit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
],
"dependencies": {
"@contentstack/cli-command": "~1.4.0",
"@oclif/plugin-help": "^6.2.25",
"@oclif/plugin-help": "^6.2.27",
"@contentstack/cli-utilities": "~1.10.0",
"@oclif/plugin-plugins": "^5.4.24",
"@oclif/plugin-plugins": "^5.4.36",
"chalk": "^4.1.2",
"fast-csv": "^4.3.6",
"fs-extra": "^11.3.0",
Expand All @@ -30,23 +30,23 @@
"winston": "^3.17.0"
},
"devDependencies": {
"@oclif/test": "^4.1.11",
"@oclif/test": "^4.1.12",
"@types/chai": "^4.3.20",
"@types/fs-extra": "^11.0.4",
"@types/mocha": "^10.0.10",
"@types/node": "^20.17.19",
"@types/node": "^20.17.30",
"@types/uuid": "^9.0.8",
"chai": "^4.5.0",
"eslint": "^8.57.1",
"eslint-config-oclif": "^6.0.15",
"eslint-config-oclif": "^6.0.42",
"eslint-config-oclif-typescript": "^3.1.14",
"mocha": "^10.8.2",
"nyc": "^15.1.0",
"oclif": "^4.17.30",
"shx": "^0.3.4",
"oclif": "^4.17.43",
"shx": "^0.4.0",
"sinon": "^19.0.5",
"ts-node": "^10.9.2",
"typescript": "^5.7.3"
"typescript": "^5.8.3"
},
"oclif": {
"bin": "csdx",
Expand All @@ -70,7 +70,7 @@
"postpack": "shx rm -f oclif.manifest.json",
"posttest": "npm run lint",
"compile": "shx rm -rf lib && tsc -b",
"prepack": "pnpm compile && oclif manifest && oclif readme",
"prepack": "npm run build && oclif manifest && oclif readme",
"test": "mocha --forbid-only \"test/**/*.test.ts\"",
"version": "oclif readme && git add README.md",
"clean": "rm -rf ./lib ./node_modules tsconfig.tsbuildinfo oclif.manifest.json",
Expand Down
Loading
Loading