avh4/elm-format

Learn about the IntelliJ requirements for code formatting plugins

Open

#198 opened on Jun 8, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (148 forks)batch import
IDE integrationhelp wanted

Repository metrics

Stars
 (1,329 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Questions to answer:

  • What are IntelliJ's requirements for supporting code formatting for a language?
  • Supposedly the Haskforce plugin does formatting via an external tool (https://github.com/avh4/elm-format/issues/182#issuecomment-230946090), can that approach be used for the elm plugin? Does the elm plugin author not like that approach, and if so, could a separate elm-format plugin be created?
  • What API needs to be implemented in the IntelliJ plugin?
  • How can we generate the required formatting code from the elm-format source?

Contributor guide

Research direction
Investigate IntelliJ's code formatting plugin requirements and evaluate how elm format can be integrated as an external tool or via the formatting API. Review linked issues and SDK documentation.
Tech stack
haskelljava
Domain
toolingdeveloper experience
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60