Skip to content

feat(cli-repl): warn when util.inspect() truncated output MONGOSH-1285 #2585

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(cli-repl): warn when util.inspect() truncated output MONGOSH-1285 #2585

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions packages/cli-repl/src/format-output.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export type FormatOptions = {
showStackTraces?: boolean;
bugReportErrorMessageInfo?: string;
allowControlCharacters?: boolean;
warnTruncatedOutput?: boolean;
};

// eslint-disable-next-line no-control-regex
Expand Down Expand Up @@ -160,7 +161,7 @@ Use db.getCollection('system.profile').find() to show raw profile entries.`,
});
}

return formatSimpleType(value, options);
return formatSimpleType(value, { ...options, warnTruncatedOutput: true });
}

function formatSimpleType(output: any, options: FormatOptions): string {
Expand All @@ -173,7 +174,19 @@ function formatSimpleType(output: any, options: FormatOptions): string {
}
if (typeof output === 'undefined') return '';

return inspect(output, options);
let result = inspect(output, options);
if (options.warnTruncatedOutput) {
if (
/(\d+ more item)|(\d+ more character)|(\[Object\])|(\[Array\])/.test(
result
)
) {
result +=
'\nWarning: The output might be truncated.' +
'\nTo see more use util.inspect() with custom options or configure depth, maxArrayLength and maxStringLength config options.';
}
}
return result;
}

function formatCollections(
Expand Down
Loading