Skip to content

Commit 112857a

Browse files
Merge pull request #1852 from contentstack/staging
DX | 14-04-2025 | Release
2 parents f14e7d2 + 3cee775 commit 112857a

File tree

82 files changed

+34338
-28339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+34338
-28339
lines changed

.github/config/release.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"releaseAll": false,
2+
"releaseAll": true,
33
"plugins": {
4-
"utilities": true,
5-
"command": true,
4+
"utilities": false,
5+
"command": false,
66
"config": false,
77
"auth": false,
88
"export": false,

.github/workflows/release.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,6 @@ jobs:
186186
token: ${{ secrets.NPM_TOKEN }}
187187
package: ./packages/contentstack-import-setup/package.json
188188
access: public
189-
tag: beta
190189
- name: Installing dependencies of export to csv
191190
id: export-to-csv-installation
192191
if: ${{env.release_releaseAll == 'true' || env.release_plugins_export-to-csv == 'true'}}
@@ -308,5 +307,5 @@ jobs:
308307
id: create_release
309308
env:
310309
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
311-
VERSION: ${{ steps.publish-to-npm.outputs.version }}
310+
VERSION: ${{ steps.publish-core.outputs.version }}
312311
run: gh release create v"$VERSION" --title "Release $VERSION" --generate-notes

package-lock.json

Lines changed: 27586 additions & 22306 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: 89 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
1919
$ csdx COMMAND
2020
running command...
2121
$ csdx (--version|-v)
22-
@contentstack/cli-audit/1.10.0 darwin-arm64 node-v22.13.1
22+
@contentstack/cli-audit/1.11.0 darwin-arm64 node-v22.14.0
2323
$ csdx --help [COMMAND]
2424
USAGE
2525
$ csdx COMMAND
@@ -34,7 +34,7 @@ USAGE
3434
* [`csdx audit:fix`](#csdx-auditfix)
3535
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
3636
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
37-
* [`csdx help [COMMANDS]`](#csdx-help-commands)
37+
* [`csdx help [COMMAND]`](#csdx-help-command)
3838
* [`csdx plugins`](#csdx-plugins)
3939
* [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin)
4040
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
@@ -52,21 +52,29 @@ Perform audits and find possible errors in the exported Contentstack data
5252

5353
```
5454
USAGE
55-
$ csdx audit [--report-path <value>] [--modules
56-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
57-
<value>] [--filter <value>] [--csv | --no-truncate]
55+
$ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
56+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
57+
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
5858
5959
FLAGS
6060
--modules=<option>... Provide the list of modules to be audited
61-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
61+
<options:
62+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
6263
--report-path=<value> Path to store the audit reports
6364
65+
COMMON FLAGS
66+
-c, --config=<value> Path of the external config
67+
-d, --data-dir=<value> Path where the data is stored
68+
6469
TABLE FLAGS
65-
--columns=<value> Show only the specified columns (comma-separated)
66-
--csv The output is in the CSV format [alias: --output=csv]
67-
--filter=<value> Filter property by partial string matching. For example: name=foo
68-
--no-truncate The output is not truncated to fit the screen
69-
--sort=<value> Property to sort by (prepend '-' for descending)
70+
--columns=<value> Specify columns to display, comma-separated.
71+
--csv Output results in CSV format.
72+
--filter=<value> Filter rows by a column value (e.g., name=foo).
73+
--no-header Hide table headers in output.
74+
--no-truncate Prevent truncation of long text in columns.
75+
--output=<option> Specify output format: csv, json, or yaml.
76+
<options: csv|json|yaml>
77+
--sort=<value> Sort the table by a column. Use "-" for descending.
7078
7179
DESCRIPTION
7280
Perform audits and find possible errors in the exported Contentstack data
@@ -93,26 +101,34 @@ Perform audits and fix possible errors in the exported Contentstack data.
93101

94102
```
95103
USAGE
96-
$ csdx audit:fix [--report-path <value>] [--modules
97-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
98-
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
99-
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
104+
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
105+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
106+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
107+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
100108
101109
FLAGS
102110
--copy-dir Create backup from the original data.
103111
--copy-path=<value> Provide the path to backup the copied data
104112
--fix-only=<option>... Provide the list of fix options
105113
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
106114
--modules=<option>... Provide the list of modules to be audited
107-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
115+
<options:
116+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
108117
--report-path=<value> Path to store the audit reports
109118
119+
COMMON FLAGS
120+
-c, --config=<value> Path of the external config
121+
-d, --data-dir=<value> Path where the data is stored
122+
110123
TABLE FLAGS
111-
--columns=<value> Show only the specified columns (comma-separated)
112-
--csv The output is in the CSV format [alias: --output=csv]
113-
--filter=<value> Filter property by partial string matching. For example: name=foo
114-
--no-truncate The output is not truncated to fit the screen
115-
--sort=<value> Property to sort by (prepend '-' for descending)
124+
--columns=<value> Specify columns to display, comma-separated.
125+
--csv Output results in CSV format.
126+
--filter=<value> Filter rows by a column value (e.g., name=foo).
127+
--no-header Hide table headers in output.
128+
--no-truncate Prevent truncation of long text in columns.
129+
--output=<option> Specify output format: csv, json, or yaml.
130+
<options: csv|json|yaml>
131+
--sort=<value> Sort the table by a column. Use "-" for descending.
116132
117133
DESCRIPTION
118134
Perform audits and fix possible errors in the exported Contentstack data.
@@ -141,21 +157,29 @@ Perform audits and find possible errors in the exported Contentstack data
141157

142158
```
143159
USAGE
144-
$ csdx cm:stacks:audit [--report-path <value>] [--modules
145-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
146-
<value>] [--filter <value>] [--csv | --no-truncate]
160+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
161+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
162+
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
147163
148164
FLAGS
149165
--modules=<option>... Provide the list of modules to be audited
150-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
166+
<options:
167+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
151168
--report-path=<value> Path to store the audit reports
152169
170+
COMMON FLAGS
171+
-c, --config=<value> Path of the external config
172+
-d, --data-dir=<value> Path where the data is stored
173+
153174
TABLE FLAGS
154-
--columns=<value> Show only the specified columns (comma-separated)
155-
--csv The output is in the CSV format [alias: --output=csv]
156-
--filter=<value> Filter property by partial string matching. For example: name=foo
157-
--no-truncate The output is not truncated to fit the screen
158-
--sort=<value> Property to sort by (prepend '-' for descending)
175+
--columns=<value> Specify columns to display, comma-separated.
176+
--csv Output results in CSV format.
177+
--filter=<value> Filter rows by a column value (e.g., name=foo).
178+
--no-header Hide table headers in output.
179+
--no-truncate Prevent truncation of long text in columns.
180+
--output=<option> Specify output format: csv, json, or yaml.
181+
<options: csv|json|yaml>
182+
--sort=<value> Sort the table by a column. Use "-" for descending.
159183
160184
DESCRIPTION
161185
Perform audits and find possible errors in the exported Contentstack data
@@ -184,26 +208,34 @@ Perform audits and fix possible errors in the exported Contentstack data.
184208

185209
```
186210
USAGE
187-
$ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
188-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
189-
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
190-
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
211+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
212+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
213+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
214+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
191215
192216
FLAGS
193217
--copy-dir Create backup from the original data.
194218
--copy-path=<value> Provide the path to backup the copied data
195219
--fix-only=<option>... Provide the list of fix options
196220
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
197221
--modules=<option>... Provide the list of modules to be audited
198-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
222+
<options:
223+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
199224
--report-path=<value> Path to store the audit reports
200225
226+
COMMON FLAGS
227+
-c, --config=<value> Path of the external config
228+
-d, --data-dir=<value> Path where the data is stored
229+
201230
TABLE FLAGS
202-
--columns=<value> Show only the specified columns (comma-separated)
203-
--csv The output is in the CSV format [alias: --output=csv]
204-
--filter=<value> Filter property by partial string matching. For example: name=foo
205-
--no-truncate The output is not truncated to fit the screen
206-
--sort=<value> Property to sort by (prepend '-' for descending)
231+
--columns=<value> Specify columns to display, comma-separated.
232+
--csv Output results in CSV format.
233+
--filter=<value> Filter rows by a column value (e.g., name=foo).
234+
--no-header Hide table headers in output.
235+
--no-truncate Prevent truncation of long text in columns.
236+
--output=<option> Specify output format: csv, json, or yaml.
237+
<options: csv|json|yaml>
238+
--sort=<value> Sort the table by a column. Use "-" for descending.
207239
208240
DESCRIPTION
209241
Perform audits and fix possible errors in the exported Contentstack data.
@@ -228,16 +260,16 @@ EXAMPLES
228260

229261
_See code: [src/commands/cm/stacks/audit/fix.ts](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
230262

231-
## `csdx help [COMMANDS]`
263+
## `csdx help [COMMAND]`
232264

233265
Display help for csdx.
234266

235267
```
236268
USAGE
237-
$ csdx help [COMMANDS] [-n]
269+
$ csdx help [COMMAND...] [-n]
238270
239271
ARGUMENTS
240-
COMMANDS Command to show help for.
272+
COMMAND... Command to show help for.
241273
242274
FLAGS
243275
-n, --nested-commands Include all nested commands in the output.
@@ -246,7 +278,7 @@ DESCRIPTION
246278
Display help for csdx.
247279
```
248280

249-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
281+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
250282

251283
## `csdx plugins`
252284

@@ -277,10 +309,10 @@ Installs a plugin into csdx.
277309

278310
```
279311
USAGE
280-
$ csdx plugins:add PLUGIN [--json] [-f] [-h] [-s | -v]
312+
$ csdx plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]
281313
282314
ARGUMENTS
283-
PLUGIN Plugin to install.
315+
PLUGIN... Plugin to install.
284316
285317
FLAGS
286318
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
@@ -327,7 +359,7 @@ USAGE
327359
$ csdx plugins:inspect PLUGIN...
328360
329361
ARGUMENTS
330-
PLUGIN [default: .] Plugin to inspect.
362+
PLUGIN... [default: .] Plugin to inspect.
331363
332364
FLAGS
333365
-h, --help Show CLI help.
@@ -351,10 +383,10 @@ Installs a plugin into csdx.
351383

352384
```
353385
USAGE
354-
$ csdx plugins:install PLUGIN [--json] [-f] [-h] [-s | -v]
386+
$ csdx plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]
355387
356388
ARGUMENTS
357-
PLUGIN Plugin to install.
389+
PLUGIN... Plugin to install.
358390
359391
FLAGS
360392
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
@@ -406,9 +438,9 @@ ARGUMENTS
406438
PATH [default: .] path to plugin
407439
408440
FLAGS
409-
-h, --help Show CLI help.
441+
-h, --help Show CLI help.
410442
-v, --verbose
411-
--[no-]install Install dependencies after linking the plugin.
443+
--[no-]install Install dependencies after linking the plugin.
412444
413445
DESCRIPTION
414446
Links a plugin into the CLI for development.
@@ -431,10 +463,10 @@ Removes a plugin from the CLI.
431463

432464
```
433465
USAGE
434-
$ csdx plugins:remove [PLUGIN] [-h] [-v]
466+
$ csdx plugins:remove [PLUGIN...] [-h] [-v]
435467
436468
ARGUMENTS
437-
PLUGIN plugin to uninstall
469+
PLUGIN... plugin to uninstall
438470
439471
FLAGS
440472
-h, --help Show CLI help.
@@ -472,10 +504,10 @@ Removes a plugin from the CLI.
472504

473505
```
474506
USAGE
475-
$ csdx plugins:uninstall [PLUGIN] [-h] [-v]
507+
$ csdx plugins:uninstall [PLUGIN...] [-h] [-v]
476508
477509
ARGUMENTS
478-
PLUGIN plugin to uninstall
510+
PLUGIN... plugin to uninstall
479511
480512
FLAGS
481513
-h, --help Show CLI help.
@@ -500,10 +532,10 @@ Removes a plugin from the CLI.
500532

501533
```
502534
USAGE
503-
$ csdx plugins:unlink [PLUGIN] [-h] [-v]
535+
$ csdx plugins:unlink [PLUGIN...] [-h] [-v]
504536
505537
ARGUMENTS
506-
PLUGIN plugin to uninstall
538+
PLUGIN... plugin to uninstall
507539
508540
FLAGS
509541
-h, --help Show CLI help.

packages/contentstack-audit/package.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@contentstack/cli-audit",
3-
"version": "1.10.0",
3+
"version": "1.11.0",
44
"description": "Contentstack audit plugin",
55
"author": "Contentstack CLI",
66
"homepage": "https://github.com/contentstack/cli",
@@ -18,10 +18,10 @@
1818
"/oclif.manifest.json"
1919
],
2020
"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",
2525
"chalk": "^4.1.2",
2626
"fast-csv": "^4.3.6",
2727
"fs-extra": "^11.3.0",
@@ -30,19 +30,19 @@
3030
"winston": "^3.17.0"
3131
},
3232
"devDependencies": {
33-
"@oclif/test": "^4.1.12",
33+
"@oclif/test": "^4.1.11",
3434
"@types/chai": "^4.3.20",
3535
"@types/fs-extra": "^11.0.4",
3636
"@types/mocha": "^10.0.10",
37-
"@types/node": "^20.17.28",
37+
"@types/node": "^20.17.19",
3838
"@types/uuid": "^9.0.8",
3939
"chai": "^4.5.0",
4040
"eslint": "^8.57.1",
41-
"eslint-config-oclif": "^4.0.0",
41+
"eslint-config-oclif": "^6.0.15",
4242
"eslint-config-oclif-typescript": "^3.1.14",
4343
"mocha": "^10.8.2",
4444
"nyc": "^15.1.0",
45-
"oclif": "^3.17.2",
45+
"oclif": "^4.17.30",
4646
"shx": "^0.3.4",
4747
"sinon": "^19.0.5",
4848
"ts-node": "^10.9.2",
@@ -69,11 +69,11 @@
6969
"lint": "eslint . --ext .ts --config .eslintrc",
7070
"postpack": "shx rm -f oclif.manifest.json",
7171
"posttest": "npm run lint",
72-
"compile": "shx rm -rf lib && tsc -b",
72+
"compile": "shx rm -rf lib tsconfig.tsbuildinfo && tsc -b",
7373
"prepack": "pnpm compile && oclif manifest && oclif readme",
7474
"test": "mocha --forbid-only \"test/**/*.test.ts\"",
7575
"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",
7777
"test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
7878
"test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\""
7979
},

0 commit comments

Comments
 (0)