grammar formatter

[parrt]

grammar formatter.

one alt: all on one line unless too long.

1 alt: line up the pipe symbol.

[jasonnn]

I'm going to start working on a formatter.

[parrt]

Sounds good. not easy to get it right ;)

[KvanTTT]

Are any news appeared? I found another tool for grammar formatting Antlr4Formatter by @teverett.

[parrt]

Tom said it was just a toy. I haven't bumped up this in priority yet. Sorry.

Sent from my iPhone

On Dec 21, 2015, at 8:06 AM, Ivan Kochurkin notifications@github.com wrote:

Are any news appeared? I found another tool for grammar formatting Antlr4Formatter by @teverett.

—
Reply to this email directly or view it on GitHub.

[teverett]

I haven't had time guys, work is busy.

On Mon, Dec 21, 2015 at 10:14 AM, Terence Parr notifications@github.com
wrote:

Tom said it was just a toy. I haven't bumped up this in priority yet.
Sorry.

Sent from my iPhone

On Dec 21, 2015, at 8:06 AM, Ivan Kochurkin notifications@github.com
wrote:

Are any news appeared? I found another tool for grammar formatting
Antlr4Formatter by @teverett.

—
Reply to this email directly or view it on GitHub.

—
Reply to this email directly or view it on GitHub
#97 (comment)
.

A better world shall emerge based on faith and understanding - Douglas
MacArthur

[matthiasbalke]

I think it would be a good idea to focus all manpower to one formatter project. @teverett already merged some of my PRs so we have a formatter library which can be included in other projects. Also we are working on unit tests for the formatter and get rid of some smaller bugs. I already integrated the formatter into diffplug/spotless a very good build tool integration of various formatters. After fixing the remaining bugs I would love to make the formatting configurable, so people could define their own grammar format. If we all work on this project I think we can achieve these features in a very short time.

[bjansen]

The IntelliJ SDK has its own formatting framework. I agree it would be a good thing to share code as much as possible, but I don't think it will be easy at all to plug an external formatter in the IntelliJ plugin.

In fact, code formatting in IntelliJ is much more that simply formatting a whole file. It also means formatting a chunk of code you selected, formatting a code block when you close a curly brace or paste code, formatting a statement when you invoke the Complete Current Statement action, etc. I don't think a generic formatter would handle all these cases.

[matthiasbalke]

@bjansen sorry I just stumbled upon this issue on my mobile and didn't realize that it is 5 years old 😄 . Can you give me a hint where to find the the formatting part of the plugin? Reading the SDK guide you linked I would say it's the content of the PSI package, right. Just to see how some cases are handled.

[bjansen]

At the moment the ANTLR plugin has no formatter. However I can show you an example of another plugin I wrote: https://github.com/eclipse/ceylon-ide-intellij/blob/master/source/org/eclipse/ceylon/ide/intellij/formatting/CeylonBlock.ceylon#L271

A big part of the work is deciding what kind of spacing/indatation/alignment to use between two token types. It's a bit tedious, and needs a lot of unit tests to make sure you don't introduce regressions every time you modify the formatter :)

[parrt]

I think @teverett's formatter could at work, even if we brute force and rewrite the text and reparse.

[teverett]

A couple comments.

Firstly, thanks for your interest in Antlr4Formatter. I have no issue with it being used in the Intellij plugin, and no issue with someone else building something better. I only ask that whatever we do also be standalone b/c some of us don't use Intellij.

With respect to the current version, the code is inelegant, and sorta-functional. I am happy to accept PR's and fixes. I do write some code, but from this experience I feel that I'm not an expert in writing code formatters :) Additionally, like everyone else, I do have a FT job which places some limits on my spare time.

In order to come with a more elegant implementation I started a version 2. I'm much happier with the version 2 so far. If you would like to jump in and help me get it into a usable state, that would be fantastic. The v2 code is here:

https://github.com/teverett/Antlr4Formatter/tree/v2

Thanks again for your interest and PR's.

[teverett]

The v2 Antlr4Formatter is now ready for pull, and review:

https://github.com/teverett/Antlr4Formatter/tree/v2

The community is welcome to use it in intellij-plugin-v4