How to contribute textual tooling for apache camel in several id es
0 likes274 views
The document discusses contributing textual tooling for Apache Camel across various IDEs, emphasizing the benefits of using the Language Server Protocol (LSP) to streamline code editing capabilities. It highlights the current state of LSP for Apache Camel, the complexity of supporting multiple IDEs, and various ways to contribute to the tooling. The author encourages community involvement in developing features such as code autocomplete, formatting, and document symbols to enhance the user experience for Apache Camel developers.
How to contribute textual tooling for apache camel in several id es
- 1. How to contribute textual tooling for Apache Camel in several IDEs Aurélien Pupier @apupier Principal Software Engineer in Red Hat Integration Tooling team ApacheCon @Home 2020 1
- 2. Textual tooling for Camel? 2
- 3. ● Route DSLs ○ Xml ○ Java ○ Yaml ○ (Groovy, JavaScript, Kotlin) ● Properties ○ Camel main ○ Camel Kafka connector Textual tooling for Camel 3
- 5. ● Eclipse Desktop Fuse Tooling ○ Textual and graphical tooling ○ Non-reusable code ● IntelliJ ○ Textual tooling ○ Non-reusable code ● What about other IDEs? Existing tooling 3 years ago 5
- 6. 6 Providing tooling for several IDEs... Complexity Eclipse Desktop IDE VS Code Emacs ... For Camel, N implementations with high skill required in Camel AND IDE extension
- 8. Write Code Editing capabilities once, run in all IDEs! The Promise of the Language Server Protocol 8
- 9. 9 Language Server More (unofficial) coming... N implementations with low skill for IDE + 1 implementations with high skill required in language only
- 10. Write limited set of Code Editing capabilities once, run in all most IDEs with a little setup The (real) Promise of the Language Server Protocol 10
- 11. ● Autocomplete ● Hover ● Code Lens ● Goto Definition/References ● Formatting / Coloring ● Renaming ● Code actions ● Highlighting ● Folding ● Diagnostic ● Document symbols Language Server Protocol Code Editing Capabilities 11
- 12. Current state of Language Server for Apache Camel 12
- 13. 13 Language Server Marketplaces clients Examples/readmes
- 14. ● Autocomplete ● Hover ● Code Lens ● Goto Definition/References ● Formatting / Coloring ● Renaming ● Code actions ● Highlighting ● Folding ● Diagnostic ● Document symbols LSP Code Editing Capabilities 14 Level of feature
- 15. Some figures 15 # of installations Eclipse Desktop 4500 (estimated) VS Code 8900 Atom 95 Che / CodeReady Workspaces / Sublime text / Theia / Vim /CodeMirror No metrics :-(
- 16. Demo 16
- 17. How to contribute Code Editing capabilities 17
- 18. ● Demo with Eclipse Desktop ○ Nice support of Language Server writing ○ Powerful Java support ● VS Code good too ● Any others IDE for Java. It will require manual configuration to test in an editor. Development Environment setup 18
- 19. https://github.com/camel-tooling/camel-language-server/blo b/master/Contributing.md Environment setup - Eclipse Desktop example 19
- 20. How to contribute a new IDE client 20
- 21. ● Specific to each IDE ● One-time effort ● If I knew it, ○ it would have been done ○ there would be no more need to do it You are on your own! 21
- 22. ● Standalone Jar to launch ● Connection through stdio or websocket ● File associations Not completely on your own :-) 22
- 23. Contribution ideas to Camel LSP 23
- 24. ● Implement Code Editing capabilities ● Create the client for your preferred IDE ● Provide new feature ideas! ● Help review Pull requests ● ... Ways of contributing 24
- 25. ● Autocomplete ● Hover ● Code Lens ● Goto Definition/References ● Formatting / Coloring ● Renaming ● Code actions ● Highlighting ● Folding ● Diagnostic ● Document symbols LSP Code Editing Capabilities 25 Level of feature
- 26. ● Renaming of direct/seda ids ● Folding of choice for Java ● Support of placeholder ● Autocomplete proposing some patterns ● Autocomplete in connected mode ● Support incremental mode ● Support Templated routes ● Provide icons for Document symbols ● Provide link to online documentation on hover ● Native version of the Language Server (Quarkus?) ● ... Language Server feature ideas 26
- 27. Create readmes Provide specific client in Marketplaces Improve readmes Provide specific client in Marketplaces Maintenance https://github.com/camel-tooling/ 27 camel-tooling/camel-langua ge-server new features / maintenance Your beloved IDE
- 28. ● Cross-Language Server for a tighter integration: ○ Jdt LS (Java) ○ Lemminx (xml) ● Other similar protocols: ○ Debug Adapter Protocol ○ Graphical Language Server Protocol Going further... 28
- 29. ● Spread the idea ● Migration ● Maintenance and governance Make it an Apache Camel subproject? 29
- 30. Go enhance the Language Server for Camel! Aurélien Pupier Principal Software Engineer @apupier ApacheCon @Home 2020 30