Add --showConfig argument #3296

wyze · 2017-04-12T22:35:21Z

Summary

This solves #3288. It adds a JSON output of the config and then exits.

Adds a --showConfig argument.
Updates the --debug output to be JSON.
Updates the jest-editor-support package to use --showConfig.

Test plan

Integration tests pass.
jest --showConfig outputs config and exits.

codecov-io · 2017-04-13T00:07:43Z

Codecov Report

Merging #3296 into master will increase coverage by 0.33%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #3296      +/-   ##
==========================================
+ Coverage    63.9%   64.23%   +0.33%     
==========================================
  Files         176      176              
  Lines        6475     6465      -10     
  Branches        4        4              
==========================================
+ Hits         4138     4153      +15     
+ Misses       2336     2311      -25     
  Partials        1        1

Impacted Files	Coverage Δ
packages/jest-editor-support/src/Settings.js	`100% <100%> (+100%)`	⬆️
packages/jest-cli/src/lib/logDebugMessages.js	`100% <100%> (ø)`	⬆️
packages/jest-cli/src/watch.js	`64.61% <0%> (-0.54%)`	⬇️
packages/jest-editor-support/src/Process.js	`20% <0%> (+20%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9c2f99...5617a2f. Read the comment docs.

rogeliog · 2017-04-13T00:32:06Z

integration_tests/__tests__/showConfig-test.js

+  it('outputs config info and exits', () => {
+    /* eslint-disable sort-keys */
+    const {stdout} = runJest(dir, ['--showConfig', '--no-cache']);
+    expect(JSON.parse(stdout)).toEqual({


We should change this to a snapshot test... If there are any fullPaths we can fix them with a serializer for paths that replaces /some/full/path/ -> /mocked/full/path/, something like:

const rootPath = path.resolve(/* resolve root path */); expect.addSnapshotSerializer({ test: val => typeof val === 'string' && val.startsWith(rootPath), print: val => val.replace(rootPath, '/mocked/root/path'), })

Sounds good. I was going to do snapshot at first but because of the paths, I went this way. Will add the serializer and change this to a snapshot.

Let me know if you have some questions about the serializer 👍

Yeah, snapshot sounds like a great idea here. Don't wanna keep this in sync manually.

rogeliog · 2017-04-13T00:34:20Z

packages/jest-cli/src/cli/runCLI.js

+  const config = readConfig(argv, root);
+  if (argv.showConfig) {
+    const output = ({config}) => {
+      pipe.write(JSON.stringify(config, null, 2));


Based on what @cpojer mentioned I think we can make this use logDebugMessage and update logDebugMesage to print out a JSON... Is that ok @cpojer?

Also, maybe we can move this to where argv.debug is used

Ah, I didn't see that right below inside of _run. I agree, I'll get that moved.

I said back in the issue that it appeared to be 2 changes here. One being adding this flag and outputting JSON config. The other being to change --debug output to be JSON as well. I'm willing to make the change in this PR, but I figured they would be separate changes therefor separate PRs.

I think we can do it in a single PR.

wyze · 2017-04-14T03:20:40Z

Alright, changed the test over to snapshot and made the additional requested changes.

One thing I couldn't get working is the Settings test for jest-editor-support. If someone could point me in the right direction to fix that test, that would be great.

thymikee · 2017-04-14T06:08:23Z

packages/jest-cli/src/lib/__tests__/logDebugMessages-test.js

@@ -15,42 +15,37 @@ jest.mock('../../../package.json', () => ({version: 123}));
 jest.mock('myRunner', () => ({name: 'My Runner'}), {virtual: true});


This file lacks 'use strict'; declaration, can you add it?

Sure thing!

thymikee · 2017-04-14T06:22:26Z

integration_tests/__tests__/showConfig-test.js

+    expect.addSnapshotSerializer({
+      print: val => val.replace(new RegExp(root, 'g'), '/mocked/root/path'),
+      test: val => typeof val === 'string' && val.indexOf(root) > -1,
+    });


You also need to change "name" to something like "[MD5 HASH]" because by default it gets assigned random hash.

I noticed that last night before I went to bed. Will get that fixed up!

wyze · 2017-04-14T22:39:01Z

I've updated the original description to include everything changed in here. I tried my best adding a test for the Settings module for jest-editor-support package, please give feedback on that. I've address all other feedback so far, good for another round of reviews. :)

cpojer · 2017-04-18T00:13:57Z

cc @orta – we may need to make the code in jest-editor-support work with older releases prior to 20.

* Add --showConfig argument * Update CLI.md

github-actions · 2021-05-13T18:15:54Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

facebook-github-bot added the CLA Signed ✔️ label Apr 12, 2017

rogeliog suggested changes Apr 13, 2017

View reviewed changes

wyze force-pushed the show-config-arg branch from 4c94e52 to 23c5f64 Compare April 14, 2017 03:18

thymikee reviewed Apr 14, 2017

View reviewed changes

wyze force-pushed the show-config-arg branch 3 times, most recently from ab88e82 to 290fd30 Compare April 14, 2017 20:06

Add --showConfig argument

3f11acc

wyze force-pushed the show-config-arg branch from 290fd30 to 3f11acc Compare April 14, 2017 22:37

Update CLI.md

5617a2f

cpojer merged commit 54cff1e into jestjs:master Apr 18, 2017

wyze deleted the show-config-arg branch April 18, 2017 00:56

skovhus pushed a commit to skovhus/jest that referenced this pull request Apr 29, 2017

Add --showConfig argument (jestjs#3296)

dc0a22c

* Add --showConfig argument * Update CLI.md

tushardhole pushed a commit to tushardhole/jest that referenced this pull request Aug 21, 2017

Add --showConfig argument (jestjs#3296)

2774f20

* Add --showConfig argument * Update CLI.md

github-actions bot locked as resolved and limited conversation to collaborators May 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --showConfig argument #3296

Add --showConfig argument #3296

wyze commented Apr 12, 2017 •

edited

Loading

codecov-io commented Apr 13, 2017 •

edited

Loading

rogeliog Apr 13, 2017

wyze Apr 13, 2017

rogeliog Apr 13, 2017

cpojer Apr 13, 2017

rogeliog Apr 13, 2017

rogeliog Apr 13, 2017

wyze Apr 13, 2017

wyze Apr 13, 2017 •

edited

Loading

cpojer Apr 13, 2017

wyze commented Apr 14, 2017 •

edited

Loading

thymikee Apr 14, 2017

wyze Apr 14, 2017

thymikee Apr 14, 2017

wyze Apr 14, 2017

wyze commented Apr 14, 2017

cpojer commented Apr 18, 2017 •

edited

Loading

github-actions bot commented May 13, 2021

		@@ -15,42 +15,37 @@ jest.mock('../../../package.json', () => ({version: 123}));
		jest.mock('myRunner', () => ({name: 'My Runner'}), {virtual: true});

Add --showConfig argument #3296

Add --showConfig argument #3296

Conversation

wyze commented Apr 12, 2017 • edited Loading

codecov-io commented Apr 13, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wyze Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wyze commented Apr 14, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wyze commented Apr 14, 2017

cpojer commented Apr 18, 2017 • edited Loading

github-actions bot commented May 13, 2021

wyze commented Apr 12, 2017 •

edited

Loading

codecov-io commented Apr 13, 2017 •

edited

Loading

wyze Apr 13, 2017 •

edited

Loading

wyze commented Apr 14, 2017 •

edited

Loading

cpojer commented Apr 18, 2017 •

edited

Loading