Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automation of code formatting for consistency #858

Open
maria77102 opened this issue Oct 23, 2024 · 0 comments
Open

Automation of code formatting for consistency #858

maria77102 opened this issue Oct 23, 2024 · 0 comments
Labels
enhancement New feature or request subject: UI This issue is about UI features, such as content assist, auto-completion, etc

Comments

@maria77102
Copy link

maria77102 commented Oct 23, 2024

The Rosetta IDE contains a ‘format code’ function, but since ‘beautifying’ the code is not mandatory, different contributions to one document can end up looking inconsistent- making it hard to read/review.

The goal is to create a standard formatting, which is going to be applied automatically after every contribution is submitted. This way, complex code is easier to read/review.

High level strategy:

  • Create a new service (e.g. CodeFormatterService) which accepts a collection of resources (i.e. Resource) and returns a collection of formatted resources
  • Implement the interface for Rune code formatting
  • Create a Java command line tool which accepts the path of a directory, containing the Rosetta files to be formatted
  • Create a Maven plugin to automate the formatting process - applying it after every contribution
  • Test the implementation to identify any issues and address them to ensure consistent code formatting.
@SimonCockx SimonCockx added enhancement New feature or request subject: UI This issue is about UI features, such as content assist, auto-completion, etc labels Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request subject: UI This issue is about UI features, such as content assist, auto-completion, etc
Projects
None yet
Development

No branches or pull requests

2 participants