Allow configuration object in projects array #5176

azz · 2017-12-25T13:21:36Z

Summary

Closes #5174

Test plan

Added an integration test. Happy to add more if you can think of edge cases.

azz · 2017-12-25T13:30:27Z

I'm not familiar with jest-cli/jest-config so let me know if I'm going about implementing it wrong!

azz · 2017-12-25T13:32:00Z

packages/jest-config/src/index.js

 ): {
  configPath: ?Path,
  globalConfig: GlobalConfig,
  hasDeprecationWarnings: boolean,
  projectConfig: ProjectConfig,
 } {
  let rawOptions;
-  let configPath;
+  let configPath = null;


Is there anywhere that requires a configPath to be set other than readConfigFileAndSetRootDir?

cpojer

This is pretty cool, I like it a lot! We got a bug report previously that having only one project doesn’t work. Can we, as part of this PR, fix that too? By making it configurable with a custom object, it’s more likely people will end up with a single project while they are iterating on their setup and it would suck if that breaks because of a Jest bug. See #4117

cpojer · 2017-12-25T13:29:13Z

packages/jest-config/src/index.js

+      rawOptions.rootDir = parentConfigPath;
+    } else {
+      throw new Error(
+        'jest: Cannot use configuration as an object without a file path',


Can you end this sentence with a full stop (.) ?

Also, please capitalize Jest.

codecov-io · 2017-12-25T13:45:23Z

Codecov Report

Merging #5176 into master will increase coverage by 0.25%.
The diff coverage is 42.85%.

@@            Coverage Diff            @@
##           master   #5176      +/-   ##
=========================================
+ Coverage   60.54%   60.8%   +0.25%     
=========================================
  Files         201     201              
  Lines        6707    6707              
  Branches        3       4       +1     
=========================================
+ Hits         4061    4078      +17     
+ Misses       2645    2628      -17     
  Partials        1       1

Impacted Files	Coverage Δ
packages/jest-config/src/normalize.js	`93.1% <100%> (ø)`	⬆️
packages/jest-config/src/index.js	`25.92% <38.46%> (+2.11%)`	⬆️
...st-config/src/read_config_file_and_set_root_dir.js	`0% <0%> (ø)`	⬆️
packages/jest-config/src/vendor/jsonlint.js	`5.72% <0%> (+5.72%)`	⬆️

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 2cb57a0...c9d5fec. Read the comment docs.

azz · 2017-12-25T14:08:44Z

I did a bit of digging on that issue and got lost, do we want to treat:

{
  testMatch: ['...']
}

The same as

{
  projects: [{
    testMatch: ['...']
  }]
}

?

cpojer · 2017-12-25T14:35:10Z

Yes, basically. I was thinking Jest should throw if there are ProjectConfig fields defined in the global config if there are one or more projects defined. In absence of a collision, it should just run whatever is specified in the projects settings.

To sum up:

No projects setting: use the whole config object for a single test run.
1-N projects setting: throw when ProjectConfig options are part of the initial config (I believe right now we silently ignore those). Run N test runs.

@SimenB any thoughts?

SimenB · 2017-12-26T10:24:10Z

I think we need to go through what's in ProjectConfig and what's in GlobalConfig, they don't really seems focused right now (at least looking at types/Config). I've never thought of the difference when adding options, and I can see that I should have... If we can clean that up, then I'm with you, it makes sense to throw if mixed.

Should we go through the docs as well and specify what we consider global config and what we consider project config? Not sure how to best say it without confusing people who don't care about the difference as they don't use projects. I suppose clear error messages might be enough

cpojer · 2017-12-26T22:16:54Z

Alright, as a start, let’s just make sure a single project specified in the projects settings keeps working then :)

SimenB · 2017-12-27T11:24:55Z

packages/jest-config/src/index.js

  // Whether it needs to look into `--config` arg passed to CLI.
  // It only used to read initial config. If the initial config contains
  // `project` property, we don't want to read `--config` value and rather
  // read individual configs for every project.
  skipArgvConfigOption?: boolean,
+  parentConfigPath?: ?Path,


what does ? on both sides mean? From my understanding name: ?type allows null, undefined or a value, while name?: type allows undefined or a value.

https://flow.org/en/docs/types/primitives/#toc-maybe-types

I'm not very proficient with Flow. I just added the ? on the LHS to satisfy the checker. Maybe I can remove the one left, but the property is optional so I think I'll get an error when it's not explicitly passed.

Yeah, I think so 🙂

Removing it worked.

SimenB · 2017-12-27T11:26:14Z

packages/jest-config/src/index.js

+      rawOptions = packageRootOrConfig;
+      rawOptions.rootDir = parentConfigPath;
+    } else {
+      throw new Error(


can we have a test for this (mostly for coverage)?

SimenB · 2017-12-27T13:14:52Z

packages/jest-config/src/index.js

@@ -166,10 +185,3 @@ const getConfigs = (
    }),
  };
 };
-
-module.exports = {


is this on purpose?

Yes it is, you export instead. Cool! 🙂

SimenB · 2017-12-27T13:18:02Z

Red CI, seems like the new test is failing:

azz · 2017-12-27T13:27:24Z

Yes I know, I still need to investigate a fix for the issue mentioned above

azz · 2017-12-28T02:31:08Z

integration_tests/__tests__/multi_project_runner.test.js

+  expect(stdout).toEqual('');
+});
+
+test('allows a single project', () => {


This test passes. Is there another case that needs to be accounted for?

SimenB · 2017-12-28T09:55:28Z

integration_tests/__tests__/multi_project_runner.test.js

+  });
+
+  const {stdout, stderr} = runJest(DIR);
+  expect(stderr).toContain('Test Suites: 2 passed, 2 total');


I realize this probably follows the pattern of the other tests here, but could you use extractSummary from utils and use a snapshot? You get back both summary and rest from it with timestamps stripped

Also, just a quick status === 0 check would be nice

Cool, will do.

SimenB

Code LGTM 🙂

Can you update the documentation as well?
https://github.com/facebook/jest/blob/97ee7c985bcafdc0ac203ba443a5fb791fbc3b5d/docs/Configuration.md#projects-array

azz · 2017-12-28T10:03:30Z

Is the runner setting currently undocumented?

SimenB · 2017-12-28T10:07:52Z

Seems like #4240 did not include docs. Feel free to add them 😀

SimenB

This is great, thanks!

cpojer · 2017-12-28T11:47:40Z

@azz This is really solid work, thanks so much for this PR. This is such a nice little tweak that’s going to make the multi project runner much more approachable. I’m hoping to see more PRs from you that meaningfully extend Jest with new features.

github-actions · 2021-05-13T00:11:15Z

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.

Allow configuration object in projects array

0d4e3b7

facebook-github-bot added the CLA Signed ✔️ label Dec 25, 2017

azz added 2 commits December 26, 2017 00:24

Add changelog

0a4cf98

Fix type of packageRootOrConfig argument

75615e6

azz commented Dec 25, 2017

View reviewed changes

cpojer requested changes Dec 25, 2017

View reviewed changes

azz added 2 commits December 26, 2017 00:34

Move along, nothing to see here...

fb2b4d4

Change error message

50d01f7

SimenB reviewed Dec 27, 2017

View reviewed changes

azz added 2 commits December 27, 2017 23:48

Add unit test for readConfig()

b61f30e

Remove unneeded ?

b227bad

SimenB reviewed Dec 27, 2017

View reviewed changes

Update integration tests

3e4c825

SimenB mentioned this pull request Dec 27, 2017

jest --changedFilesToContributeTo=origin/master #5188

Closed

4 tasks

azz mentioned this pull request Dec 28, 2017

Document how to set this up alongside your regular jest config jest-community/jest-runner-eslint#22

Closed

azz commented Dec 28, 2017

View reviewed changes

SimenB reviewed Dec 28, 2017

View reviewed changes

SimenB requested changes Dec 28, 2017

View reviewed changes

Add documentation for runner and projects objects

d91e999

SimenB approved these changes Dec 28, 2017

View reviewed changes

Add status code checks

c9d5fec

cpojer merged commit a439772 into jestjs:master Dec 28, 2017

azz deleted the project-config branch December 28, 2017 11:50

SimenB mentioned this pull request Dec 28, 2017

Multi-project-runner fails with one project #4117

Closed

thymikee mentioned this pull request Jan 8, 2018

Option "projects" in configuration file does not work #5253

Closed

SimenB mentioned this pull request Jan 9, 2018

transformIgnorePatterns option is not used when specified in global config of multi-project setup #5260

Closed

SimenB mentioned this pull request Jan 26, 2018

specify custom runner on CLI #5382

Closed

renovate-tests mentioned this pull request Feb 6, 2018

Update dependency jest to v22 - autoclosed renovate-tests/changelog-md#3

Closed

renovate bot mentioned this pull request Feb 14, 2018

fix(deps): update dependency jest to ^22.0.0 manekinekko/devoxx-assistant#3

Open

SimenB mentioned this pull request May 6, 2018

Change testEnvironment on a per test basis #2587

Closed

backflip mentioned this pull request Sep 18, 2018

global setup and global teardown now gets globalConfig as a parameter #6486

Merged

thymikee mentioned this pull request Dec 11, 2018

fix(jest-config): Allow exactly one project #7498

Merged

SimenB mentioned this pull request May 2, 2019

Fix init when there is one project in projects config. #8409

Closed

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

Allow configuration object in projects array #5176

Allow configuration object in projects array #5176

azz commented Dec 25, 2017 •

edited

Loading

azz commented Dec 25, 2017

azz Dec 25, 2017

cpojer left a comment

cpojer Dec 25, 2017

codecov-io commented Dec 25, 2017 •

edited

Loading

azz commented Dec 25, 2017

cpojer commented Dec 25, 2017

SimenB commented Dec 26, 2017 •

edited

Loading

cpojer commented Dec 26, 2017

SimenB Dec 27, 2017

azz Dec 27, 2017 •

edited

Loading

SimenB Dec 27, 2017

azz Dec 27, 2017

SimenB Dec 27, 2017

SimenB Dec 27, 2017

SimenB Dec 27, 2017

SimenB commented Dec 27, 2017

azz commented Dec 27, 2017

azz Dec 28, 2017

SimenB Dec 28, 2017 •

edited

Loading

azz Dec 28, 2017

SimenB left a comment

azz commented Dec 28, 2017

SimenB commented Dec 28, 2017

SimenB left a comment

cpojer commented Dec 28, 2017

github-actions bot commented May 13, 2021

Allow configuration object in projects array #5176

Allow configuration object in projects array #5176

Conversation

azz commented Dec 25, 2017 • edited Loading

azz commented Dec 25, 2017

Choose a reason for hiding this comment

cpojer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Dec 25, 2017 • edited Loading

Codecov Report

azz commented Dec 25, 2017

cpojer commented Dec 25, 2017

SimenB commented Dec 26, 2017 • edited Loading

cpojer commented Dec 26, 2017

Choose a reason for hiding this comment

azz Dec 27, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Dec 27, 2017

azz commented Dec 27, 2017

Choose a reason for hiding this comment

SimenB Dec 28, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

azz commented Dec 28, 2017

SimenB commented Dec 28, 2017

SimenB left a comment

Choose a reason for hiding this comment

cpojer commented Dec 28, 2017

github-actions bot commented May 13, 2021

azz commented Dec 25, 2017 •

edited

Loading

codecov-io commented Dec 25, 2017 •

edited

Loading

SimenB commented Dec 26, 2017 •

edited

Loading

azz Dec 27, 2017 •

edited

Loading

SimenB Dec 28, 2017 •

edited

Loading