Uploaded image for project: 'Jalview'
  1. Jalview
  2. JAL-3828

Should we use editorconfig to format code instead of CodeStyle?

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 2.11.1, 2.11.2
    • Fix Version/s: 2.12.0
    • Component/s: Dev and Dep
    • Labels:

      Description

      Currently we (encourage) development using Eclipse IDE as configuration for many of Eclipse's tools has been made. One configuration in particular is a set coding style which is automatically applied by Eclipse using the JalviewCodeStyle.xml configuration.
      The automatically applied CodeStyle formatting is incredibly useful in keeping merge conflicts to a minimum, as well as allowing a consistent code style to be kept in the repo when a developer might code with a variant style (e.g. me!).

      Whilst exploring configuration for an alternative IDE (IntelliJ IDEA) which can also apply CodeStyle changes (although not _exactly_ the same as the configuration we have for Eclipse) I came across editorconfig (IntelliJ has native support for .editorconfig files).
      See https://editorconfig.org/

      This is a third party system to do something very similar to CodeStyle (perhaps with more of an emphasis on format checking) which has support across MANY text editors and IDEs, including IntelliJ IDEA (built-in), Eclipse (a plugin), Vim (a plugin) and many more: See
      https://editorconfig.org/#pre-installed
      and
      https://editorconfig.org/#download
      It also has a gradle plugin for checking and re-formatting (similar to the spotless plugin) https://github.com/ec4j/editorconfig-gradle-plugin

      This would allow development/editing within other (many other) editors (e.g. a quick fix in vim) to fit in with main development in Eclipse, with consistent code style always applied.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              soares Ben Soares
              Reporter:
              soares Ben Soares
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated: