Skip to content

Staging-to-main | DX | 13-05-2024 | Release #1405

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 34 commits into from
May 13, 2024
Merged

Staging-to-main | DX | 13-05-2024 | Release #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
e8c0eb5
feat: Added Audit and audit fix for Select fields in entries and mino…
cs-raj Apr 27, 2024
1ad7460
Merge remote-tracking branch 'origin/development' into feat/CS-44502
cs-raj Apr 27, 2024
dd691e7
PR fixes and version bump of CLI
cs-raj Apr 29, 2024
4476bfd
PR fixes
cs-raj Apr 29, 2024
1d1cd70
Merge pull request #1390 from contentstack/main
cs-raj Apr 29, 2024
73e36f5
Merge pull request #1391 from contentstack/staging-to-development
cs-raj Apr 29, 2024
c433a1d
Merge branch 'development' into feat/CS-44502
cs-raj Apr 29, 2024
393fa49
PR fixes and lock-file update
cs-raj Apr 29, 2024
fcd54b8
log removal
cs-raj Apr 29, 2024
6a7a823
Merge pull request #1389 from contentstack/feat/CS-44502
cs-raj Apr 29, 2024
903f31f
Merge branch 'hotfix/DX-530' into hotfix/DX-530-stag
aman19K May 3, 2024
eef9ee5
Merge pull request #1394 from contentstack/hotfix/DX-530-stag
cs-raj May 3, 2024
57439ae
Merge branch 'main' into main-to-staging
cs-raj May 3, 2024
2420979
lock-file and readme updated
cs-raj May 3, 2024
1631ce3
Merge pull request #1396 from contentstack/main-to-staging
cs-raj May 3, 2024
43a68b5
Merge branch 'staging' into staging-to-development
cs-raj May 3, 2024
551c0b6
Lock-file and readme update
cs-raj May 3, 2024
f50b1b4
Merge pull request #1398 from contentstack/staging-to-development
cs-raj May 3, 2024
e9800f0
added audit and audit fix for mandatory fields in Entries, and added …
cs-raj May 6, 2024
d2a9de3
PR fixes and lock-file update
cs-raj May 6, 2024
43c1988
PR comment fixes
cs-raj May 6, 2024
69fe156
added condition to show extension updated message successfully, in ma…
cs-raj May 6, 2024
2e0ad9a
formatting
cs-raj May 6, 2024
696b556
PR change
cs-raj May 6, 2024
291679f
displaying the audit report for the mandatory feilds in case of no pu…
cs-raj May 6, 2024
528dbeb
Merge pull request #1400 from contentstack/fix/DX-54
cs-raj May 6, 2024
71ca574
removing redundant checks
cs-raj May 6, 2024
d35443c
Merge branch 'development' into feat/DX-523
cs-raj May 7, 2024
4cde239
Merge pull request #1399 from contentstack/feat/DX-523
cs-raj May 7, 2024
91cc0a3
used the length property to validate the missing mandatory fields, av…
cs-raj May 7, 2024
95ad166
Merge pull request #1402 from contentstack/bugfix/DX-552
cs-raj May 7, 2024
8470a58
lock-file update
cs-raj May 8, 2024
3cf1e9d
Merge pull request #1403 from contentstack/fix/lock-files
cs-raj May 8, 2024
3b104ca
Merge pull request #1404 from contentstack/development
cs-raj May 8, 2024
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
1,567 changes: 675 additions & 892 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

146 changes: 78 additions & 68 deletions packages/contentstack-audit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/cli-audit/1.4.1 darwin-arm64 node-v20.8.0
@contentstack/cli-audit/1.6.0 darwin-arm64 node-v21.6.2
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
Expand All @@ -36,14 +36,14 @@ USAGE
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
* [`csdx help [COMMANDS]`](#csdx-help-commands)
* [`csdx plugins`](#csdx-plugins)
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
* [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin)
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
* [`csdx plugins:install PLUGIN`](#csdx-pluginsinstall-plugin)
* [`csdx plugins:link PATH`](#csdx-pluginslink-path)
* [`csdx plugins:remove [PLUGIN]`](#csdx-pluginsremove-plugin)
* [`csdx plugins:reset`](#csdx-pluginsreset)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
* [`csdx plugins:uninstall [PLUGIN]`](#csdx-pluginsuninstall-plugin)
* [`csdx plugins:unlink [PLUGIN]`](#csdx-pluginsunlink-plugin)
* [`csdx plugins:update`](#csdx-pluginsupdate)

## `csdx audit`
Expand All @@ -53,12 +53,12 @@ Perform audits and find possible errors in the exported Contentstack data
```
USAGE
$ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
--no-truncate]
content-types|global-fields|entries|extensions|workflows] [--columns <value> | ] [--sort <value>] [--filter <value>]
[--csv | --no-truncate]

FLAGS
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports

COMMON FLAGS
Expand Down Expand Up @@ -98,17 +98,17 @@ Perform audits and fix possible errors in the exported Contentstack data.
```
USAGE
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
reference|global_field|json:rte|json:extension|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
<value>] [--csv | --no-truncate]
content-types|global-fields|entries|extensions|workflows] [--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]

FLAGS
--copy-dir Create backup from the original data.
--copy-path=<value> Provide the path to backup the copied data
--fix-only=<option>... Provide the list of fix options
<options: reference|global_field|json:rte|json:extension|blocks|group>
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports

COMMON FLAGS
Expand Down Expand Up @@ -150,12 +150,12 @@ Perform audits and find possible errors in the exported Contentstack data
```
USAGE
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
--no-truncate]
content-types|global-fields|entries|extensions|workflows] [--columns <value> | ] [--sort <value>] [--filter <value>]
[--csv | --no-truncate]

FLAGS
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports

COMMON FLAGS
Expand Down Expand Up @@ -197,17 +197,17 @@ 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
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
reference|global_field|json:rte|json:extension|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
<value>] [--csv | --no-truncate]
content-types|global-fields|entries|extensions|workflows] [--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]

FLAGS
--copy-dir Create backup from the original data.
--copy-path=<value> Provide the path to backup the copied data
--fix-only=<option>... Provide the list of fix options
<options: reference|global_field|json:rte|json:extension|blocks|group>
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports

COMMON FLAGS
Expand Down Expand Up @@ -285,48 +285,53 @@ EXAMPLES
$ csdx plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/index.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/index.ts)_

## `csdx plugins:install PLUGIN...`
## `csdx plugins:add PLUGIN`

Installs a plugin into the CLI.
Installs a plugin into csdx.

```
USAGE
$ csdx plugins:install PLUGIN...
$ csdx plugins:add PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
PLUGIN Plugin to install.

FLAGS
-f, --force Run yarn install with force flag.
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installs a plugin into csdx.

Installation of a user-installed plugin will override a core plugin.
Uses bundled npm executable to install plugins into /Users/raj.pandey/.local/share/@contentstack/cli-audit

e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
Installation of a user-installed plugin will override a core plugin.

Use the CSDX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CSDX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
$ csdx plugins:add

EXAMPLES
$ csdx plugins:add myplugin
Install a plugin from npm registry.

$ csdx plugins:add myplugin

Install a plugin from a github url.

$ csdx plugins:add https://github.com/someuser/someplugin

$ csdx plugins:add https://github.com/someuser/someplugin
Install a plugin from a github slug.

$ csdx plugins:add someuser/someplugin
$ csdx plugins:add someuser/someplugin
```

## `csdx plugins:inspect PLUGIN...`
Expand Down Expand Up @@ -354,59 +359,64 @@ EXAMPLES
$ csdx plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/inspect.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/inspect.ts)_

## `csdx plugins:install PLUGIN...`
## `csdx plugins:install PLUGIN`

Installs a plugin into the CLI.
Installs a plugin into csdx.

```
USAGE
$ csdx plugins:install PLUGIN...
$ csdx plugins:install PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
PLUGIN Plugin to install.

FLAGS
-f, --force Run yarn install with force flag.
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installs a plugin into csdx.

Installation of a user-installed plugin will override a core plugin.
Uses bundled npm executable to install plugins into /Users/raj.pandey/.local/share/@contentstack/cli-audit

e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
Installation of a user-installed plugin will override a core plugin.

Use the CSDX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CSDX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
$ csdx plugins:add

EXAMPLES
$ csdx plugins:install myplugin
Install a plugin from npm registry.

$ csdx plugins:install myplugin

Install a plugin from a github url.

$ csdx plugins:install https://github.com/someuser/someplugin

$ csdx plugins:install https://github.com/someuser/someplugin
Install a plugin from a github slug.

$ csdx plugins:install someuser/someplugin
$ csdx plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/install.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/install.ts)_

## `csdx plugins:link PLUGIN`
## `csdx plugins:link PATH`

Links a plugin into the CLI for development.

```
USAGE
$ csdx plugins:link PLUGIN
$ csdx plugins:link PATH [-h] [--install] [-v]

ARGUMENTS
PATH [default: .] path to plugin
Expand All @@ -428,15 +438,15 @@ EXAMPLES
$ csdx plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/link.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/link.ts)_

## `csdx plugins:uninstall PLUGIN...`
## `csdx plugins:remove [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
$ csdx plugins:uninstall PLUGIN...
$ csdx plugins:remove [PLUGIN] [-h] [-v]

ARGUMENTS
PLUGIN plugin to uninstall
Expand Down Expand Up @@ -469,15 +479,15 @@ FLAGS
--reinstall Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/reset.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/reset.ts)_

## `csdx plugins:uninstall PLUGIN...`
## `csdx plugins:uninstall [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
$ csdx plugins:uninstall PLUGIN...
$ csdx plugins:uninstall [PLUGIN] [-h] [-v]

ARGUMENTS
PLUGIN plugin to uninstall
Expand All @@ -497,15 +507,15 @@ EXAMPLES
$ csdx plugins:uninstall myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/uninstall.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/uninstall.ts)_

## `csdx plugins:uninstall PLUGIN...`
## `csdx plugins:unlink [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
$ csdx plugins:uninstall PLUGIN...
$ csdx plugins:unlink [PLUGIN] [-h] [-v]

ARGUMENTS
PLUGIN plugin to uninstall
Expand Down Expand Up @@ -541,5 +551,5 @@ DESCRIPTION
Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/update.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.18/src/commands/plugins/update.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion packages/contentstack-audit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@contentstack/cli-audit",
"version": "1.5.4",
"version": "1.6.0",
"description": "Contentstack audit plugin",
"author": "Contentstack CLI",
"homepage": "https://github.com/contentstack/cli",
Expand Down
Loading
Loading