Added compact print option for default reporter

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-cli]`: Add `compact` option to default reporter ([#7845](https://github.com/facebook/jest/pull/7845))
 - `[jest-resolve]` Now supports PnP environment without plugins ([#8094](https://github.com/facebook/jest/pull/8094))
 
 ### Fixes

e2e/__tests__/__snapshots__/defaultReporter.test.ts.snap

@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`default reporter prints compact message 1`] = `""`;
+
+exports[`default reporter prints compact message 2`] = `
+"FAIL __tests__/fail.test.js
+ ● failing tests › fails __tests__/fail.test.js:13:11
+ ● failing tests › fails 2 __tests__/fail.test.js:17:11
+ ● failing tests › fails 3 __tests__/fail.test.js:23:11"
+`;

e2e/__tests__/defaultReporter.test.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {extractSummary} from '../Utils';
+import runJest from '../runJest';
+
+test('default reporter prints compact message', () => {
+ const {stdout, stderr} = runJest('default-reporter', [
+ '--verbose=false',
+ '--config',
+ JSON.stringify({
+ reporters: [['default', {compact: true}]],
+ }),
+ ]);
+ expect(stdout).toMatchSnapshot();
+ expect(extractSummary(stderr).rest).toMatchSnapshot();
+});

e2e/default-reporter/__tests__/fail.test.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+'use strict';
+
+describe('failing tests', () => {
+ it('fails', () => {
+ throw new Error(`failing test`);
+ });
+
+ it('fails 2', () => {
+ throw new Error(`failing test`);
+ });
+
+ it('passes', () => {});
+
+ it('fails 3', () => {
+ throw new Error(`failing test`);
+ });
+
+ it('passes 2', () => {});
+});

e2e/default-reporter/package.json

@@ -0,0 +1,3 @@
+{
+
+}

packages/jest-core/src/TestScheduler.ts

@@ -289,8 +289,14 @@ export default class TestScheduler {
  private _setupDefaultReporters(collectCoverage: boolean) {
  this.addReporter(
  this._globalConfig.verbose
- ? new VerboseReporter(this._globalConfig)
- : new DefaultReporter(this._globalConfig),
+ ? new VerboseReporter(
+ this._globalConfig,
+ this._getReporterOption('verbose'),
+ )
+ : new DefaultReporter(
+ this._globalConfig,
+ this._getReporterOption('default'),
+ ),
  );
 
  if (collectCoverage) {
@@ -365,6 +371,15 @@ export default class TestScheduler {
  }
  return Promise.resolve();
  }
+
+ private _getReporterOption(reporterName: string): Record<string, any> {
+ const reporters = this._globalConfig.reporters || [];
+ const config = reporters.find(
+ (item): item is Config.ReporterConfig =>
+ Array.isArray(item) && item[0] === reporterName,
+ );
+ return (config && config[1]) || {};
+ }
 }
 
 const createAggregatedResults = (numTotalTestSuites: number) => {

packages/jest-message-util/src/index.ts

@@ -51,11 +51,11 @@ const ANONYMOUS_FN_IGNORE = /^\s+at <anonymous>.*$/;
 const ANONYMOUS_PROMISE_IGNORE = /^\s+at (new )?Promise \(<anonymous>\).*$/;
 const ANONYMOUS_GENERATOR_IGNORE = /^\s+at Generator.next \(<anonymous>\).*$/;
 const NATIVE_NEXT_IGNORE = /^\s+at next \(native\).*$/;
-const TITLE_INDENT = ' ';
+export const TITLE_INDENT = ' ';
 const MESSAGE_INDENT = ' ';
 const STACK_INDENT = ' ';
 const ANCESTRY_SEPARATOR = ' \u203A ';
-const TITLE_BULLET = chalk.bold('\u25cf ');
+export const TITLE_BULLET = chalk.bold('\u25cf ');
 const STACK_TRACE_COLOR = chalk.dim;
 const STACK_PATH_REGEXP = /\s*at.*\(?(\:\d*\:\d*|native)\)?/;
 const EXEC_ERROR_MESSAGE = 'Test suite failed to run';
@@ -318,13 +318,8 @@ export const formatResultsErrors = (
  message = indentAllLines(message, MESSAGE_INDENT);
 
  const title =
- chalk.bold.red(
- TITLE_INDENT +
- TITLE_BULLET +
- result.ancestorTitles.join(ANCESTRY_SEPARATOR) +
- (result.ancestorTitles.length ? ANCESTRY_SEPARATOR : '') +
- result.title,
- ) + '\n';
+ chalk.bold.red(TITLE_INDENT + TITLE_BULLET + formatFullTitle(result)) +
+ '\n';
 
  return title + '\n' + message + '\n' + stack;
  })
@@ -354,3 +349,8 @@ export const separateMessageFromStack = (content: string) => {
  const stack = messageMatch[2];
  return {message, stack};
 };
+
+export const formatFullTitle = (result: AssertionResult) =>
+ result.ancestorTitles.join(ANCESTRY_SEPARATOR) +
+ (result.ancestorTitles.length ? ANCESTRY_SEPARATOR : '') +
+ result.title;

packages/jest-reporters/package.json

@@ -17,6 +17,7 @@
  "istanbul-lib-instrument": "^3.0.1",
  "istanbul-lib-source-maps": "^3.0.1",
  "jest-haste-map": "^24.3.1",
+ "jest-message-util": "^24.3.0",
  "jest-resolve": "^24.3.1",
  "jest-runtime": "^24.3.1",
  "jest-util": "^24.3.0",

packages/jest-reporters/src/default_reporter.ts

@@ -6,19 +6,22 @@
  */
 
 import {Config} from '@jest/types';
-import {AggregatedResult, TestResult} from '@jest/test-result';
+import {AggregatedResult, TestResult, AssertionResult} from '@jest/test-result';
 import {clearLine, getConsoleOutput, isInteractive} from 'jest-util';
+import {formatFullTitle, TITLE_INDENT, TITLE_BULLET} from 'jest-message-util';
 import chalk from 'chalk';
 import {Test, ReporterOnStartOptions} from './types';
 import BaseReporter from './base_reporter';
 import Status from './Status';
 import getResultHeader from './get_result_header';
 import getSnapshotStatus from './get_snapshot_status';
+import {formatFullPath} from './utils';
 
 type write = (chunk: string, enc?: any, cb?: () => void) => boolean;
 type FlushBufferedOutput = () => void;
-
-const TITLE_BULLET = chalk.bold('\u25cf ');
+export type DefaultReporterOptions = {
+ compact?: boolean;
+};
 
 export default class DefaultReporter extends BaseReporter {
  private _clear: string; // ANSI clear sequence for the last printed status
@@ -27,10 +30,15 @@ export default class DefaultReporter extends BaseReporter {
  private _out: write;
  private _status: Status;
  private _bufferedOutput: Set<FlushBufferedOutput>;
+ private _options: DefaultReporterOptions;
 
- constructor(globalConfig: Config.GlobalConfig) {
+ constructor(
+ globalConfig: Config.GlobalConfig,
+ options: DefaultReporterOptions = {},
+ ) {
  super();
  this._globalConfig = globalConfig;
+ this._options = options;
  this._clear = '';
  this._out = process.stdout.write.bind(process.stdout);
  this._err = process.stderr.write.bind(process.stderr);
@@ -149,11 +157,19 @@ export default class DefaultReporter extends BaseReporter {
  test.context.config,
  testResult,
  );
- this.printTestFileFailureMessage(
- testResult.testFilePath,
- test.context.config,
- testResult,
- );
+ if (this._options.compact) {
+ this.printCompactFailureMessage(
+ testResult.testFilePath,
+ test.context.config,
+ testResult,
+ );
+ } else {
+ this.printTestFileFailureMessage(
+ testResult.testFilePath,
+ test.context.config,
+ testResult,
+ );
+ }
  }
  this.forceFlushBufferedOutput();
  }
@@ -175,7 +191,7 @@ export default class DefaultReporter extends BaseReporter {
  const consoleBuffer = result.console;
  if (consoleBuffer && consoleBuffer.length) {
  this.log(
- ' ' +
+ TITLE_INDENT +
  TITLE_BULLET +
  'Console\n\n' +
  getConsoleOutput(
@@ -199,4 +215,24 @@ export default class DefaultReporter extends BaseReporter {
  const snapshotStatuses = getSnapshotStatus(result.snapshot, didUpdate);
  snapshotStatuses.forEach(this.log);
  }
+
+ printCompactFailureMessage(
+ _testPath: Config.Path,
+ config: Config.ProjectConfig,
+ result: TestResult,
+ ) {
+ result.testResults.forEach((assertionResult: AssertionResult) => {
+ if (assertionResult.failureMessages.length) {
+ const fullPath = formatFullPath(
+ result.testFilePath,
+ config || this._globalConfig,
+ assertionResult,
+ );
+ const fullTitle = formatFullTitle(assertionResult);
+ this.log(
+ TITLE_INDENT + chalk.red(TITLE_BULLET + fullTitle) + ' ' + fullPath,
+ );
+ }
+ });
+ }
 }

packages/jest-reporters/src/utils.ts

@@ -7,7 +7,7 @@
 
 import path from 'path';
 import {Config} from '@jest/types';
-import {AggregatedResult} from '@jest/test-result';
+import {AggregatedResult, AssertionResult, Callsite} from '@jest/test-result';
 import chalk from 'chalk';
 import slash from 'slash';
 import {pluralize} from 'jest-util';
@@ -266,3 +266,31 @@ export const wrapAnsiString = (string: string, terminalWidth: number) => {
  )
  .join('\n');
 };
+
+export const getLocation = (
+ assertionResult: AssertionResult,
+): Callsite | null => {
+ if (assertionResult.location) {
+ return assertionResult.location;
+ }
+ const matches = assertionResult.failureMessages[0].match(/(\d+):(\d+)/);
+ return (
+ matches && {
+ column: parseInt(matches[2], 10),
+ line: parseInt(matches[1], 10),
+ }
+ );
+};
+
+export const formatFullPath = (
+ testFilePath: string,
+ config: Config.GlobalConfig | Config.ProjectConfig,
+ assertionResult: AssertionResult,
+) => {
+ let path = formatTestPath(config, testFilePath);
+ const location = getLocation(assertionResult);
+ if (location) {
+ path += `:${location.line}:${location.column}`;
+ }
+ return path;
+};

packages/jest-reporters/src/verbose_reporter.ts

@@ -15,15 +15,18 @@ import {
 import chalk from 'chalk';
 import {specialChars} from 'jest-util';
 import {Test} from './types';
-import DefaultReporter from './default_reporter';
+import DefaultReporter, {DefaultReporterOptions} from './default_reporter';
 
 const {ICONS} = specialChars;
 
 export default class VerboseReporter extends DefaultReporter {
  protected _globalConfig: Config.GlobalConfig;
 
- constructor(globalConfig: Config.GlobalConfig) {
- super(globalConfig);
+ constructor(
+ globalConfig: Config.GlobalConfig,
+ options?: DefaultReporterOptions,
+ ) {
+ super(globalConfig, options);
  this._globalConfig = globalConfig;
  }
 

packages/jest-reporters/tsconfig.json

@@ -7,6 +7,7 @@
  "references": [
  {"path": "../jest-environment"},
  {"path": "../jest-haste-map"},
+ {"path": "../jest-message-util"},
  {"path": "../jest-resolve"},
  {"path": "../jest-runtime"},
  {"path": "../jest-test-result"},

packages/jest-test-result/src/index.ts

@@ -22,4 +22,5 @@ export {
  Status,
  Suite,
  TestResult,
+ Callsite,
 } from './types';

packages/jest-test-result/src/types.ts

@@ -44,7 +44,7 @@ export type Status =
 export type Bytes = number;
 
 export type Milliseconds = number;
-type Callsite = {
+export type Callsite = {
  column: number;
  line: number;
 };