repo: update typescript references

[paul-marechal]

Signed-off-by: Paul Maréchal paul.marechal@ericsson.com

What it does

1. Update typescript references.
2. Add a CI script to check if typescript references are in sync.

How to test

• Run yarn test:references: it should work.
• Change a reference in any package to something bogus (non-existant path).
• Run yarn test:references: it should fail.

[paul-marechal]

Not sure if we should automate the script to compile references?

[vince-fugnitto]

Not sure if we should automate the script to compile references?

I think so, how will we know if a reference is missing? (how did we know in this case)

[paul-marechal]

@vince-fugnitto indeed, added a script to check if everything is in sync while running the tests. People will need to manually trigger the update script to make sure everything is in order if the check fails. On travis it will fail since there will be uncommitted changes then.

[akosyakov]

Why don't run references generation during prepare always, similarly how we prepare travis file when new project is added? Without dry runs and so on, one script which always rewrites references configuration to the proper state.

[paul-marechal]

@akosyakov the reason is that I believe human supervision is required should the script run. The script guaranties that our workspace layout it followed by TypeScript, but we can also add specific references that are out of this system and I'm "afraid" for those. Also I don't like scripts that crawl the disk to run when not needed, especially when they can modify your workspace.

edit: Looking into it, I guess I could make it like you said. I assumed people might want control over the references, but I imagine not.

[paul-marechal]

Updated, fingers crossed that the script will behave. Worst case ping me if something goes wrong.

[akosyakov]

the reason is that I believe human supervision is required should the script run

@marechal-p we can supervise output of a script and fix the script to behave. I don't want anything complex and additional npm scripts, script options and so on. It should establish links for all workspaces each time, we have another script to fail the build if somebody forgot to supervise output.

[paul-marechal]

@akosyakov that's done. The script now sets all ts references between our local repos, and only that. People shouldn't edit the references manually as it might get overridden by the script. Should someone think we need a different set of references, the script would have to be updated. Is this ok?

[akosyakov]

Should someone think we need a different set of references, the script would have to be updated. Is this ok?

yes, i think it is fine, we should discuss if someone wants something like that anyway, thank you

[akosyakov]

we should have copyright here?

[akosyakov]

ah, see it is below, not sure that it is correct, but anyway

[paul-marechal]

// @ts-check has to be at the top for it to work apparently

[akosyakov]

looks good to me, @marcdumais-work @vince-fugnitto could you have a look as well?

[vince-fugnitto]

I tested that the two scripts work correctly when there are outdated references:

yarn test:references

Result

(mp/ref-update ✓) theia yarn test:references
yarn run v1.19.1
$ node scripts/compile-references --dry-run
TypeScript references seem to be out of sync, run "yarn prepare:references" to fix.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

yarn prepare:references

Result

(mp/ref-update U:1 ✗) theia yarn prepare:references
yarn run v1.19.1
$ node scripts/compile-references.js
info: /home/evinfug/workspace/theia/examples/electron/compile.tsconfig.json updated.
TypeScript references were out of sync and got updated.
Done in 0.49s.

I also verified that the current state contains no outdated references 👍

[paul-marechal]

@vince-fugnitto I just improved logging a bit, thanks to your output.

I will now rebase, run the scripts again to see if anything needs updating, and finally merge when CI turns green.