Implement Migration Checks

[softworkz]

Before implementing anything, we should build a list of checks that we want to perform on build automatically to prevent users who are migrating from previous versions, from running into issues due to incorrect project setup.

1. No package.json must be present in the project

Check

The project must not contain any file named package.json (neither package-lock.json)

Help Message

All properties from an existing package.json file must be specified as MSBuild properties in the project now.
(Link to Wiki docs)

Exception

The only exception is a package.json (and package-lock.json) in a folder named ElectronHostHook.

TODO: We may need to validate the contents of this package.json alongside any tsconfig.json if present

2. No electron-manifest.json must be present in the project

Check

The project must not contain any file named electron-manifest.json

Help Message

• All properties from an existing electron-manifest.json file must be specified as MSBuild properties in the project now.
  (Link to Wiki docs)
• The subtree from the "build" property must be moved to the electron-builder.json file inside the ./Properties folder
  (Link to Wiki docs)

3. Single electron-builder.json

Check

The project must contain a single electron-builder.json inside the ./Properties folder

Help Message

• The project must contain a single electron-builder.json inside the ./Properties folder

4. No parent-paths in electron-builder.json

Check

The electron-builder.json file must not contain any parent-path references

Help Message

• Explain how the project files need to be set up that they are being copied to the output so that they can be referenced via relative (non-parent) paths

[softworkz]

Note

Thinking about it: using npm for web/client related packages must still be possible, so that part needs consideration.