@contentstack/cli-audit 1.4.0 → 1.4.1

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.4.0 linux-x64 node-v18.19.1
+@contentstack/cli-audit/1.4.1 linux-x64 node-v18.19.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -285,7 +285,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -354,7 +354,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -398,7 +398,7 @@ EXAMPLES
   $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PLUGIN`
 
@@ -428,7 +428,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -462,10 +462,14 @@ Remove all user-installed and linked plugins.
 
 ```
 USAGE
-  $ csdx plugins:reset
+  $ csdx plugins:reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -493,7 +497,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -537,5 +541,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.17/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.js

@@ -75,7 +75,13 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         let { ctSchema, gfSchema } = this.getCtAndGfSchema();
         let missingCtRefs, missingGfRefs, missingEntryRefs;
         for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
-            cli_utilities_1.ux.action.start(this.$t(this.messages.AUDIT_START_SPINNER, { module }));
+            (0, log_1.print)([
+                {
+                    bold: true,
+                    color: 'whiteBright',
+                    message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
+                },
+            ]);
             const constructorParam = {
                 ctSchema,
                 gfSchema,
@@ -98,7 +104,18 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     await this.prepareReport(module, missingEntryRefs);
                     break;
             }
-            cli_utilities_1.ux.action.stop();
+            (0, log_1.print)([
+                {
+                    bold: true,
+                    color: 'whiteBright',
+                    message: this.$t(this.messages.AUDIT_START_SPINNER, { module }),
+                },
+                {
+                    bold: true,
+                    message: ' done',
+                    color: 'whiteBright',
+                },
+            ]);
         }
         return { missingCtRefs, missingGfRefs, missingEntryRefs };
     }

package/lib/config/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const config = {
     showTerminalOutput: true,
     skipRefs: ['sys_assets'],
-    skipFieldTypes: ['taxonomy'],
+    skipFieldTypes: ['taxonomy', 'group'],
     modules: ['content-types', 'global-fields', 'entries'],
     'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group'],
     moduleConfig: {

package/lib/messages/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tableColumnDescriptions = exports.auditFixMsg = exports.auditMsg = exports.commonMsg = exports.errors = exports.$t = void 0;
+const tslib_1 = require("tslib");
+const memoize_1 = tslib_1.__importDefault(require("lodash/memoize"));
 const errors = {};
 exports.errors = errors;
 const tableColumnDescriptions = {
@@ -51,13 +53,16 @@ const messages = Object.assign(Object.assign(Object.assign(Object.assign(Object.
  * @returns a string.
  */
 function $t(msg, args) {
-    if (!msg)
-        return '';
-    for (const key of Object.keys(args)) {
-        const escapedKey = key.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-        msg = msg.replace(new RegExp(`{${escapedKey}}`, 'g'), args[key]);
-    }
-    return msg;
+    const transfer = (0, memoize_1.default)(function (msg, args) {
+        if (!msg)
+            return '';
+        for (const key of Object.keys(args)) {
+            const escapedKey = key.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            msg = msg.replace(new RegExp(`{${escapedKey}}`, 'g'), args[key] || escapedKey);
+        }
+        return msg;
+    });
+    return transfer(msg, args);
 }
 exports.$t = $t;
 exports.default = messages;

package/lib/modules/entries.js

@@ -10,6 +10,7 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
 const fs_1 = require("fs");
 const content_types_1 = tslib_1.__importDefault(require("./content-types"));
 const messages_1 = require("../messages");
+const util_1 = require("../util");
 const global_fields_1 = tslib_1.__importDefault(require("./global-fields"));
 class Entries {
     constructor({ log, fix, config, moduleName, ctSchema, gfSchema }) {
@@ -59,11 +60,13 @@ class Entries {
                             this.removeMissingKeysOnEntry(ctSchema.schema, this.entries[entryUid]);
                         }
                         this.lookForReference([{ locale: code, uid, name: title }], ctSchema, this.entries[entryUid]);
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ENTRY_SUCCESS_MSG, {
+                        const message = (0, messages_1.$t)(messages_1.auditMsg.SCAN_ENTRY_SUCCESS_MSG, {
                             title,
                             local: code,
                             module: this.config.moduleConfig.entries.name,
-                        }), 'info');
+                        });
+                        this.log(message, 'hidden');
+                        (0, util_1.print)([{ message: `info: ${message}`, color: 'green' }]);
                     }
                     if (this.fix) {
                         await this.writeFixContent(`${basePath}/${indexer[fileIndex]}`, this.entries);
@@ -71,7 +74,7 @@ class Entries {
                 }
             }
         }
-        this.log('', 'info'); // Adding empty line
+        // this.log('', 'info'); // Adding empty line
         this.removeEmptyVal();
         return this.missingRefs;
     }

package/lib/types/utils.d.ts

@@ -1,7 +1,7 @@
 import { Color } from "chalk";
 import { PrintOptions } from "@contentstack/cli-utilities";
 import config from "../config";
-type LogFn = (message: string | any, logType?: LoggerType | PrintOptions | undefined) => void;
+type LogFn = (message: string | any, logType?: LoggerType | PrintOptions | undefined, skipCredentialCheck?: boolean) => void;
 type ExitFn = (code?: number | undefined) => void;
 type Partial<T> = {
     [P in keyof T]?: T[P];
@@ -10,7 +10,7 @@ type ConfigType = {
     config?: string;
 } & typeof config & Record<string, any>;
 export { LogFn, ExitFn, Partial, ConfigType };
-export type LoggerType = "info" | "warn" | "error" | "debug";
+export type LoggerType = "info" | "warn" | "error" | "debug" | 'hidden';
 export type PrintType = {
     message: string;
     bold?: boolean;

package/lib/util/log.d.ts

@@ -5,6 +5,7 @@ export default class Logger {
     private infoLogger;
     private errorLogger;
     private config;
+    private hiddenInfoLogger;
     get loggerOptions(): winston.transports.FileTransportOptions;
     constructor(config: Record<string, any>);
     /**
@@ -24,7 +25,7 @@ export default class Logger {
      * @param {LoggerType | PrintOptions | undefined} [logType] - The `logType` parameter is an optional
      * parameter that specifies the type of log. It can be one of the following values:
      */
-    log(message: string | any, logType?: LoggerType | PrintOptions | undefined): void;
+    log(message: string | any, logType?: LoggerType | PrintOptions | undefined, skipCredentialCheck?: boolean): void;
     /**
      * The function `returnString` takes a message as input and returns a modified version of the message
      * with sensitive credentials replaced and any ANSI escape codes removed.

package/lib/util/log.js

@@ -35,6 +35,7 @@ class Logger {
         this.config = config;
         this.infoLogger = this.getLoggerInstance('info');
         this.errorLogger = this.getLoggerInstance('error');
+        this.hiddenInfoLogger = this.getLoggerInstance('hidden');
     }
     /**
      * The function getLoggerInstance creates and returns a winston logger instance based on the provided
@@ -48,15 +49,20 @@ class Logger {
         const consoleOptions = {
             format: winston_1.default.format.combine(winston_1.default.format.simple(), winston_1.default.format.colorize({ all: true })),
         };
+        const isHidden = logType === 'hidden';
+        logType = logType === 'hidden' ? 'info' : logType;
         if (logType === 'error') {
             consoleOptions.level = logType;
         }
         const filename = (0, path_1.normalize)((0, path_1.resolve)(this.config.basePath, 'logs', `${logType}.log`)).replace(/^(\.\.(\/|\\|$))+/, '');
+        const transports = [
+            new winston_1.default.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { level: logType, filename })),
+        ];
+        if (!isHidden) {
+            transports.push(new winston_1.default.transports.Console(consoleOptions));
+        }
         const loggerOptions = {
-            transports: [
-                new winston_1.default.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { level: logType, filename })),
-                new winston_1.default.transports.Console(consoleOptions),
-            ],
+            transports,
             levels: customLevels.levels,
         };
         if (logType === 'error') {
@@ -72,8 +78,8 @@ class Logger {
      * @param {LoggerType | PrintOptions | undefined} [logType] - The `logType` parameter is an optional
      * parameter that specifies the type of log. It can be one of the following values:
      */
-    log(message, logType) {
-        const logString = this.returnString(message);
+    log(message, logType, skipCredentialCheck = false) {
+        const logString = skipCredentialCheck ? message : this.returnString(message);
         switch (logType) {
             case 'info':
             case 'debug':
@@ -83,6 +89,9 @@ class Logger {
             case 'error':
                 this.errorLogger.error(logString);
                 break;
+            case 'hidden':
+                this.hiddenInfoLogger.log('info', logString);
+                break;
             default:
                 cli_utilities_1.cliux.print(logString, logType || {});
                 break;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.0",
+  "version": "1.4.1",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",