Skip to content

Feature/oclif v4 migration #1784

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
shafeeqd959 merged 6 commits into from
Mar 3, 2025
Merged

Feature/oclif v4 migration #1784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
721d59b
removed beta tag in import-setup-command
shafeeqd959 Feb 11, 2025
390599f
Merge branch 'development' of github.com:contentstack/cli into develo…
shafeeqd959 Feb 20, 2025
d0b7dae
basic migration from oclif v3 to v4
shafeeqd959 Feb 27, 2025
33bed2f
basic migration from oclif v3 to v4
shafeeqd959 Feb 27, 2025
9c009b9
Merge branch 'development' into feature/oclif-v4-migration
shafeeqd959 Feb 27, 2025
a2d1f1c
merged latest dev changes
shafeeqd959 Feb 27, 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
1 change: 0 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,6 @@ jobs:
token: ${{ secrets.NPM_TOKEN }}
package: ./packages/contentstack-import-setup/package.json
access: public
tag: beta
- name: Installing dependencies of export to csv
id: export-to-csv-installation
if: ${{env.release_releaseAll == 'true' || env.release_plugins_export-to-csv == 'true'}}
Expand Down
37,175 changes: 17,619 additions & 19,556 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

112 changes: 48 additions & 64 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.7.5 darwin-arm64 node-v22.14.0
@contentstack/cli-audit/1.7.5 darwin-arm64 node-v22.13.1
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
Expand All @@ -34,7 +34,7 @@ USAGE
* [`csdx audit:fix`](#csdx-auditfix)
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
* [`csdx help [COMMANDS]`](#csdx-help-commands)
* [`csdx help [COMMAND]`](#csdx-help-command)
* [`csdx plugins`](#csdx-plugins)
* [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin)
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
Expand All @@ -52,21 +52,17 @@ Perform audits and find possible errors in the exported Contentstack data

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

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

TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored

DESCRIPTION
Perform audits and find possible errors in the exported Contentstack data
Expand All @@ -93,10 +89,9 @@ Perform audits and fix possible errors in the exported Contentstack data.

```
USAGE
$ csdx audit:fix [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles] [--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]
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...]

FLAGS
--copy-dir Create backup from the original data.
Expand All @@ -107,12 +102,9 @@ FLAGS
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
--report-path=<value> Path to store the audit reports

TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored

DESCRIPTION
Perform audits and fix possible errors in the exported Contentstack data.
Expand Down Expand Up @@ -141,21 +133,17 @@ Perform audits and find possible errors in the exported Contentstack data

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

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

TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored

DESCRIPTION
Perform audits and find possible errors in the exported Contentstack data
Expand Down Expand Up @@ -184,10 +172,9 @@ Perform audits and fix possible errors in the exported Contentstack data.

```
USAGE
$ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles] [--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]
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...]

FLAGS
--copy-dir Create backup from the original data.
Expand All @@ -198,12 +185,9 @@ FLAGS
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
--report-path=<value> Path to store the audit reports

TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored

DESCRIPTION
Perform audits and fix possible errors in the exported Contentstack data.
Expand All @@ -228,16 +212,16 @@ EXAMPLES

_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)_

## `csdx help [COMMANDS]`
## `csdx help [COMMAND]`

Display help for csdx.

```
USAGE
$ csdx help [COMMANDS] [-n]
$ csdx help [COMMAND...] [-n]

ARGUMENTS
COMMANDS Command to show help for.
COMMAND... Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.
Expand All @@ -246,7 +230,7 @@ DESCRIPTION
Display help for csdx.
```

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

## `csdx plugins`

Expand All @@ -269,18 +253,18 @@ EXAMPLES
$ csdx plugins
```

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

## `csdx plugins:add PLUGIN`

Installs a plugin into csdx.

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

ARGUMENTS
PLUGIN Plugin to install.
PLUGIN... Plugin to install.

FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
Expand Down Expand Up @@ -327,7 +311,7 @@ USAGE
$ csdx plugins:inspect PLUGIN...

ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
PLUGIN... [default: .] Plugin to inspect.

FLAGS
-h, --help Show CLI help.
Expand All @@ -343,18 +327,18 @@ EXAMPLES
$ csdx plugins:inspect myplugin
```

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

## `csdx plugins:install PLUGIN`

Installs a plugin into csdx.

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

ARGUMENTS
PLUGIN Plugin to install.
PLUGIN... Plugin to install.

FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
Expand Down Expand Up @@ -392,7 +376,7 @@ EXAMPLES
$ csdx plugins:install someuser/someplugin
```

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

## `csdx plugins:link PATH`

Expand All @@ -406,9 +390,9 @@ ARGUMENTS
PATH [default: .] path to plugin

FLAGS
-h, --help Show CLI help.
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
--[no-]install Install dependencies after linking the plugin.

DESCRIPTION
Links a plugin into the CLI for development.
Expand All @@ -423,18 +407,18 @@ EXAMPLES
$ csdx plugins:link myplugin
```

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

## `csdx plugins:remove [PLUGIN]`

Removes a plugin from the CLI.

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

ARGUMENTS
PLUGIN plugin to uninstall
PLUGIN... plugin to uninstall

FLAGS
-h, --help Show CLI help.
Expand Down Expand Up @@ -464,18 +448,18 @@ FLAGS
--reinstall Reinstall all plugins after uninstalling.
```

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

## `csdx plugins:uninstall [PLUGIN]`

Removes a plugin from the CLI.

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

ARGUMENTS
PLUGIN plugin to uninstall
PLUGIN... plugin to uninstall

FLAGS
-h, --help Show CLI help.
Expand All @@ -492,18 +476,18 @@ EXAMPLES
$ csdx plugins:uninstall myplugin
```

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

## `csdx plugins:unlink [PLUGIN]`

Removes a plugin from the CLI.

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

ARGUMENTS
PLUGIN plugin to uninstall
PLUGIN... plugin to uninstall

FLAGS
-h, --help Show CLI help.
Expand Down Expand Up @@ -536,5 +520,5 @@ DESCRIPTION
Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.33/src/commands/plugins/update.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
<!-- commandsstop -->
6 changes: 3 additions & 3 deletions packages/contentstack-audit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
],
"dependencies": {
"@contentstack/cli-command": "~1.3.3",
"@oclif/plugin-help": "^6.2.25",
"@contentstack/cli-utilities": "~1.8.2",
"@oclif/plugin-help": "^5.2.20",
"@oclif/plugin-plugins": "^5.4.24",
"chalk": "^4.1.2",
"fast-csv": "^4.3.6",
Expand All @@ -38,11 +38,11 @@
"@types/uuid": "^9.0.8",
"chai": "^4.5.0",
"eslint": "^8.57.1",
"eslint-config-oclif": "^4.0.0",
"eslint-config-oclif": "^6.0.15",
"eslint-config-oclif-typescript": "^3.1.13",
"mocha": "^10.8.2",
"nyc": "^15.1.0",
"oclif": "^3.17.2",
"oclif": "^4.17.30",
"shx": "^0.3.4",
"sinon": "^19.0.2",
"ts-node": "^10.9.2",
Expand Down
Loading