Feat/load referenced config from packagejson#14044

Merged

SimenB merged 31 commits into

jestjs:mainfrom

rafaelrabelos:feat/load_referenced_config_from_packagejson

Nov 30, 2023

Contributor

rafaelrabelos commented Apr 1, 2023

Feat: load referenced json config file from package.json 'jest' when it has a valid path

Summary

Currently Jest requires json config files to be in root folder of projects. Allowing to load from another path brings way to keep projects organized. That way files can be moved to another folder includind these who are only for tests

Test plan

yarn jest packages/jest-config/src/tests/resolveConfigPath.test.ts

rafaelrabelos added 3 commits

March 31, 2023 21:28


          Loads .json config file when jest key has a path


          Adds feature explaining section for docs

398dc06


          Adds changelog info

d0fd07d

Contributor

facebook-github-bot commented Apr 1, 2023

Hi @rafaelrabelos!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!


          Update changelog with PR info

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

facebook-github-bot added the cla signed label

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

1 similar comment

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

mrazauskas commented Apr 1, 2023

You can use --config CLI flag to point Jest to a config file. It does work from command line or as a script in package.json: "yarn jest --config path/to/jest.config.json".

Do you have a use case there that isn’t enough?

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

19 similar comments

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 1, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Contributor

facebook-github-bot commented Apr 2, 2023

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

rafaelrabelos added 2 commits

August 11, 2023 02:12


          Adds fs dependency

1f3b8f0


          Test and fix file resolution

94e23f2

rafaelrabelos requested a review from SimenB

August 12, 2023 02:25

Contributor Author

rafaelrabelos commented Aug 12, 2023

@rafaelrabelos could you take a look at the failing CI? 🙂

CI fails solved 🙂


          Improves doc example

8fcfa68

mrazauskas reviewed

View reviewed changes

docs/Configuration.md Outdated

mrazauskas reviewed

View reviewed changes

packages/jest-config/src/resolveConfigPath.ts Outdated

rafaelrabelos and others added 2 commits

August 12, 2023 22:06


          Update docs/Configuration.md

d174794

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>


          Merge branch 'main' into feat/load_referenced_config_from_packagejson

a551494

SimenB requested changes

View reviewed changes

packages/jest-config/src/resolveConfigPath.ts Outdated

packages/jest-config/src/resolveConfigPath.ts Outdated

+                  if (jest && typeof jest === 'string') {
+                    const resolvedConfigFile = path.resolve(packagePath, jest);
+                    return isFile(resolvedConfigFile) ? resolvedConfigFile : undefined;

Member

SimenB Aug 13, 2023

if the path provided isn't a file, we should throw an error

Contributor Author

rafaelrabelos Aug 16, 2023

In that case, when jest key could not be resolved as a valid file path, the package.Json is assumed. That because jest key can be a path or a config object, so i need to allow that function to return for a second flow option.
I did a new test case to avoid future issues for those who changes that code. It makes sense?

Member

SimenB Aug 21, 2023

That because jest key can be a path or a config object

My point is that if you in your config define "jest": "./some-path" (i.e. it is a string), and the path it resolves to is not a file, then Jest should error. Not ignore the entry.

Contributor Author

rafaelrabelos Aug 21, 2023

Nice, guess i understood the point: if path is not a config object and it is an string there is no option to it to not be a file, be a file or throw an error. Working on it for the next push commit

Member

SimenB Aug 21, 2023

yeah, exactly 👍

packages/jest-config/src/resolveConfigPath.ts Outdated

packages/jest-config/src/__tests__/resolveConfigPath.test.ts Outdated

rafaelrabelos added 6 commits

August 16, 2023 14:49


          Remove AAA comments from tests

fce78ca


          make resolveJestKey types well defined


          Merge branch 'feat/load_referenced_config_from_packagejson' of https:…

ddbb1c8

…//github.com/rafaelrabelos/jest into feat/load_referenced_config_from_packagejson


          Aditional typing refactor

af8716b


          Test case for when jest key is not a valid file

78c0ba5


          Optmize Parse calls

b552e19

rafaelrabelos requested review from SimenB and mrazauskas

August 17, 2023 20:10

github-actions Bot commented Nov 19, 2023

This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.

github-actions Bot added the Stale label


          Merge branch 'main' into feat/load_referenced_config_from_packagejson

ab6d71f

github-actions Bot removed the Stale label

SimenB added 2 commits

November 27, 2023 09:25


          do not support directory

00167af


          bring test back, and simplify

886420c

SimenB approved these changes

View reviewed changes

Member

SimenB left a comment

thanks!

SimenB enabled auto-merge (squash)

November 27, 2023 08:39

SimenB merged commit 20e66df into jestjs:main

github-actions Bot commented Dec 31, 2023

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.

github-actions Bot locked as resolved and limited conversation to collaborators

Member

SimenB commented Feb 20, 2024

https://github.com/jestjs/jest/releases/tag/v30.0.0-alpha.3

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels