elyukai / optolith-client

Optolith Character Manager is a desktop application for The Dark Eye 5th Edition.
https://optolith.app
Other
161 stars 44 forks source link

Docs: Fix build command in package.json and Contributing #1592

Closed ziermach closed 1 year ago

ziermach commented 1 year ago

Just an small think i found when working with the client the build command is wrong in package.json and Contributing.md

docs: corrected build command for ts fix: fix build script to use ts:build and not re:build

elyukai commented 1 year ago

Thanks for noticing! I think the Reason/OCaml part is obsolete in general, since I've removed that part completely.

The TypeScript-Build is not necessary for building itself, because the transpilation is already done by Webpack. But it skips the type checker to make it a lot faster, but this also means it's not "save" to use without type checking separately.

The ts:build should not output any files either. Maybe it should be renamed to ts:check. But how to name the watcher then?

ziermach commented 1 year ago

you could just run tsc --noEmit and call it ts:validate or ts:type-check or something like this?

you can also add noEmit to the watch then it checks the types in watch mode

maybe call it then ts:validate:watch or ts:check:watch

elyukai commented 1 year ago

Hmm, yeah, I maybe have to think about the wording of script names in general; they should all follow the same pattern in the end … and I don’t have a good one right now, I think! πŸ™ƒπŸ™ˆ

Anyway, I will definitely accept your PR, because it at least partially fixes the problem. So, again, thank you! πŸ™πŸ»πŸ₯°