fix(config): log error when config file has syntax error

[souravdasslg]

I have implemented this solution by matching if the error is an instance of SyntaxError. Is this how it expected to work?

I am still not able to reach 100% code coverage after many attempts. Some help is much needed.
Issue #4894

[claassistantio]

All committers have signed the CLA.

[rarkins]

I think it’s ok to skip giving full details and instead just log the full error and say “could not parse config file”. Also ok to skip coverage if you keep it simple.

[souravdasslg]

Made the changes accordingly :)

[rarkins]

What does an example error now look like?

[souravdasslg]

This is how the log message is looking like. I feel it is ugly.

$ babel-node --extensions ".ts,.js" -- lib/renovate.ts
FATAL: Could not parse config file
/Volumes/Felix/Work/renovate/config.js:8
"onboardingConfig": {
^^^^^^^^^^^^^^^^^^

   SyntaxError: Unexpected string
       at Module._compile (internal/modules/cjs/loader.js:895:18)
       at Module._compile (/Volumes/Felix/Work/Open Source/renovate/node_modules/pirates/lib/index.js:99:24)
       at Module._extensions..js (internal/modules/cjs/loader.js:995:10)
       at Object.newLoader [as .js] (/Volumes/Felix/Work/Open Source/renovate/node_modules/pirates/lib/index.js:104:7)
       at Module.load (internal/modules/cjs/loader.js:815:32)
       at Function.Module._load (internal/modules/cjs/loader.js:727:14)
       at Module.require (internal/modules/cjs/loader.js:852:19)
       at require (internal/modules/cjs/helpers.js:74:18)
       at Object.getConfig (/Volumes/Felix/Work/Open Source/renovate/lib/config/file.ts:15:14)
       at Object.parseConfigs (/Volumes/Felix/Work/Open Source/renovate/lib/config/index.ts:50:60)
       at processTicksAndRejections (internal/process/task_queues.js:93:5)
       at Object.start (/Volumes/Felix/Work/Open Source/renovate/lib/workers/global/index.ts:68:18)
       at /Volumes/Felix/Work/Open Source/renovate/lib/renovate.ts:9:22

FATAL: You must configure a GitHub personal access token
INFO: Renovate is exiting with a non-zero code due to the following logged errors
"loggerErrors": [
{
"name": "renovate",
"level": 60,
"msg": "Could not parse config file \n /Volumes/Felix/Work/renovate/config.js:8\n "onboardingConfig": {\n ^^^^^^^^^^^^^^^^^^\n\nSyntaxError: Unexpected string\n at Module._compile (internal/modules/cjs/loader.js:895:18)\n at Module._compile (/Volumes/Felix/Work/Open Source/renovate/node_modules/pirates/lib/index.js:99:24)\n at Module._extensions..js (internal/modules/cjs/loader.js:995:10)\n at Object.newLoader [as .js] (/Volumes/Felix/Work/Open Source/renovate/node_modules/pirates/lib/index.js:104:7)\n at Module.load (internal/modules/cjs/loader.js:815:32)\n at Function.Module._load (internal/modules/cjs/loader.js:727:14)\n at Module.require (internal/modules/cjs/loader.js:852:19)\n at require (internal/modules/cjs/helpers.js:74:18)\n at Object.getConfig (/Volumes/Felix/Work/Open Source/renovate/lib/config/file.ts:15:14)\n at Object.parseConfigs (/Volumes/Felix/Work/Open Source/renovate/lib/config/index.ts:50:60)\n at processTicksAndRejections (internal/process/task_queues.js:93:5)\n at Object.start (/Volumes/Felix/Work/Open Source/renovate/lib/workers/global/index.ts:68:18)\n at /Volumes/Felix/Work/Open Source/renovate/lib/renovate.ts:9:22"
},
{
"name": "renovate",
"level": 60,
"msg": "You must configure a GitHub personal access token"
}
]
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

[rarkins]

I think it’s ok to be ugly if it’s rare and should happen only once.

[rarkins]

Let's quit out (abort) instead of continuing. Otherwise a single typo could result in a complete change of config for 10s/100s/1000s of repos.

[souravdasslg]

I found out

1. Even if the config is wrong, with a valid token renovate continues to operate.That doesn't the fix for the problem.

2. I added the return to prevent the continuation

Do you want me to have process.exit(1) there ?

[rarkins]

Yes, process.exit

[souravdasslg]

Made the changes accordingly.Its the best way to solve this error
Also, the error message is more clear now.

[renovate-release]

🎉 This PR is included in version 19.89.4 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀