generator-langium: Transform generated project to npm workspace - Githubissues

eclipse-langium / langium

Next-gen language engineering / DSL framework

https://langium.org/

MIT License

663 stars 61 forks source link

generator-langium: Transform generated project to npm workspace #1520

Open kaisalmen opened 1 month ago

kaisalmen commented 1 month ago

TODO:

[x] Align template structure with target structure
[x] Integrate a global tsconfig.build.json in target project
[x] Unify how build and compile is done in target project
[x] Update to the latest version of the wrapper lib stack
[x] Fix Build issues: Create index files and export code to other packages
[x] Fix regular generator-langium unit tests
[x] Add new test that check the complete structure
[x] Option test not yet included even if selected
[x] tsconfig.build.json needs to be dynamically created. Sources not contained should not be included as it leads to build failures otherwise.
[x] Align dependencies and update vitest
[x] Remove the need to use http-server

Fixes #1495

TODO: from review:

[x] Update langium-quickstart.md
[x] Add clean script and build:clean to all packages

kaisalmen commented 4 weeks ago

@msujew @Yokozuna59 the generated workspace project builds again. Now, I need to fix the open points above ⬆️

kaisalmen commented 2 weeks ago

@msujew @Yokozuna59 this is now ready for review. The only thing left is from the list is removing the need for http-server in the web package, because vite preview should do the job. But this is not blocking the review.

Lotes commented 2 weeks ago

For me workspaces were hard to work with in the beginning, because I was switching to the packages folders to run npm run X. Would be good to have some documentation on our website, I think. Like workspace 101, especially with the -w flag to address packages. Does it change anything for the existing documentation?

kaisalmen commented 2 weeks ago

Does it change anything for the existing documentation?

Very likely 🙂 We need to update it once this is merged.

kaisalmen commented 2 weeks ago

Like workspace 101

The generated project is the blueprint. 👍 It features all facets: TS with specific test configs, VSCode eslint compatibility (root tsconfig.json per package), workspace eslint check, global build and top-level scripts that directly execute package scripts.

kaisalmen commented 2 weeks ago

All points are resolved. I also fix an issue with the web example. I broke the configuration during this update. It is working again.

kaisalmen commented 2 weeks ago

@Yokozuna59 thank you for the review. I still need to implement the two bigger points (added to the description) and then I am done. Any further enhancements should go to a next PR, because this one is already quite large, but there was no way around.

kaisalmen commented 2 weeks ago

@Yokozuna59 and @msujew all TODOs are done. We need to update tutorials and docs on the website as well. This change has some impact.

kaisalmen commented 1 week ago

I rebased the branch after Langium 3.1.0 release to resolve the conflicts.

kaisalmen commented 1 day ago

@msujew I just updated to the latest wrapper version. Do you have time to review it this week?