Allow .cjs extension for the configuration file #6911

Activity

1. tipy01

   added

   TYPE: enhancementThe accepted proposal for future implementation.The accepted proposal for future implementation.

   on Mar 3, 2022
2. need-response-app

   added

   STATE: Need responseAn issue that requires a response or attention from the team.An issue that requires a response or attention from the team.

   on Mar 3, 2022
3. JordanAtBridgit commented on Mar 4, 2022

   

   JordanAtBridgit

   on Mar 4, 2022

   More actions

   This is exactly what I came to inquire about.

   I find myself in a situation where I want to use global before/after hooks which, according to the docs, are configured through the JS version of the config file. When I converted the existing JSON config to the JS format, I started getting the error An error has occurred while reading the "path/to/.testcaferc.js" configuration file. I had to poke around in configuration-base.js to see that the error was reported as so:
   Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/.testcaferc.js from /path/to/node_modules/testcafe/lib/configuration/configuration-base.js not supported. .testcaferc.js is treated as an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which declares all .js files in that package scope as ES modules. Instead rename .testcaferc.js to end in .cjs, change the requiring code to use dynamic import() which is available in all CommonJS modules, or change "type": "module" to "type": "commonjs" in /home/jordan/repos/rp-web/uitests/package.json to treat all .js files as CommonJS (using .mjs for all ES modules instead).

   I can't change the require() in configuration-base.js, and I have way too many existing import statements to just remove the type: "modules in my package.json. When I try changing the extension of my config file to .cjs, it gets loaded as a JSON file since the extension isn't recognized anymore. This leads to parsing errors, as the JS version is obviously not valid JSON.

   If I may be so bold as to offer a suggestion, if the function that identifies the config as JS vs JSON were to also allow for the .cjs extension, this appears to work perfectly without requiring me to greatly refactor or otherwise change global settings in my code. I gave it a quick-and-dirty test drive locally, and it does seem to work fine, but that's obviously a long way from being properly tested.

   If that approach sounds reasonable, I can open a PR.

   👍React with 👍1Reacted by Cameron Collver
4. alexfi1in commented on Mar 7, 2022

   

   alexfi1in

   on Mar 7, 2022

   Contributor

   More actions

   Hi folks,

   Thanks for pointing this out to us. It's a good enhancement of the Configuration subsystem.

   👍React with 👍2Reacted by JordanAtBridgit and Cameron Collver
5. need-response-app

   removed

   STATE: Need responseAn issue that requires a response or attention from the team.An issue that requires a response or attention from the team.

   on Mar 7, 2022
6. alex-fournier commented on Apr 6, 2023

   

   alex-fournier

   on Apr 6, 2023

   More actions

   Hello, a PR has been submitted: #7614

   🚀React with 🚀1Reacted by Mark
7. need-response-app

   added

   STATE: Need responseAn issue that requires a response or attention from the team.An issue that requires a response or attention from the team.

   on Apr 6, 2023
8. Aleksey28

   removed

   STATE: Need responseAn issue that requires a response or attention from the team.An issue that requires a response or attention from the team.

   on Apr 10, 2023
9. miherlosev

   closed this as completedin #7614on May 3, 2023
10. miherlosev

    added a commit that references this issue on May 3, 2023

    Add possibility to load config file from cjs file (#7614)

    ...

    This issue will close once commit 2e6dee3 is merged into the 'master' branch.

    2e6dee3
11. github-actions commented on May 5, 2023

    

    github-actionsBot

    on May 5, 2023

    More actions

    Release v2.6.0-rc.1 addresses this.