bpmn-io / form-js

View and visually edit JSON-based forms.
https://bpmn.io/toolkit/form-js/
Other
399 stars 102 forks source link

Make it easy to debug the project #1233

Open paule96 opened 1 month ago

paule96 commented 1 month ago

Is your feature request related to a problem? Please describe.

Currently, the only visible way for me to start this project is over karma which is a test framework. This makes it way too complicated to debug the project and try new things. It would be way better to have a normal npm run start, that will run a HTTP-server that serves an index.html that shows the editor, playground, etc...

That would help to use the integrated debugger in for example VsCode. Currently from my point of view, this seems to be impossible.

Skaiir commented 1 month ago

Hey there. So I guess it is a matter of preferences, but I we've gotten used to it here. There are ideas floating around about using vite across the project, something that might see a little more traction whenever we've done this restructuring of the codebase. I'm not sure if it handles vscode integrations well, but it does follow an index.html structure unlike what we do now.

For now though, there aren't any plans. If you really need this now and are willing to implement it, I'd ask for it to be done under something other than start, but I don't know how long we'll keep it to be fair. We'll keep it in mind for the future, but personally I haven't found issues working with karma once I've gotten used to it.

But yes, in an ideal future we would modernize the repo, I generally agree.

paule96 commented 3 weeks ago

@Skaiir after thinking some nights about it I'm also not so happy with my idea because this repository is mainly a frontend library and not a standalone product. So I guess I agree with you that a start or an index.html is not really needed, because you can just use the test to debug. (and force yourself into writing tests)

But still, the main feature request is to be true, to make it easier to debug the tests by providing pre-configured maybe vs code configs. (I don't want to force too much vscode, but we are on GitHub and so the default for many people are the dev containers that are vscode)

From my point of view, it is also a documentation issue.