Add automated compatibility check for npm dependencies during template updates

[benjaminloerincz]

Is your feature request related to a problem? Please describe.
Currently, I’m running into issues where npm install fails right after generating a new Salesforce project using the templates provided by salesforcedx-templates.

sf project generate --name mynewproject && cd mynewproject && npm install

In the past, updates on package.json crashed multiple times the project generation and now it is crashing again due to incompatible or outdated versions of dependencies in package.json. This makes the initial developer experience frustrating and leads to manual fixes or dependency debugging before any code is written.

Describe the solution you’d like
I’d like to see automated checks (e.g. via a GitHub Action) added to this repo that validate the package.json dependencies and run npm install (or npm ci) to ensure compatibility after any update to dependencies or template files.
The goal is to catch these issues early and avoid broken templates being shipped.

Additional context
Inspired by:

• Downgrade prettier-plugin-apex #446
• ESLint 9 not supported by @lwc/eslint-plugin-lwc #619
• Add support for ESLint v9 salesforce/eslint-config-lwc#128

Thanks for maintaining these templates. Making the setup process smoother would be a big win for developer experience!