パッケージの詳細

See https://github.com/nukisman/elm-format-short

elm-format-short formats your code like elm-format but:

• Without extra blank lines
• Without extra line breaks
• Without extra indents
• With shorter and better visual representations of case-of, if-then-else, let-in, etc.

elm-format-short formats Elm source code according to a standard set of rules in shorter way than elm-format.

The benefits of elm-format-short are same as of elm-format:

• It makes code easier to write, because you never have to worry about minor formatting concerns while powering out new code.
• It makes code easier to read, because there are no longer distracting minor stylistic differences between different code bases. As such, your brain can map more efficiently from source to mental model.
• It makes code easier to maintain, because you can no longer have diffs related only to formatting; every diff necessarily involves a material change.
• It saves your team time debating how to format things, because there is a standard tool that formats everything the same way.
• It saves you time because you don't have to nitpick over formatting details of your code.

Plus benefits in contrast to elm-format:

• It makes code easier to read, because you can see more code without scrolling.
• It makes code easier to navigate, because you have not to scroll needless empty space by mouse or arrows on keyboard.
• It makes code easier to write, because it is easier to read and easier to navigate.
• It makes code easier to debug, because your lines of code commented out for debug purposes are not surrounded by needless blank lines above and below.
• It saves your money, because you can still use your display. It not require you to buy new display with vertical resolution of 1000000000 pixels to see tons of blank lines.

Example formatting

See dreamwriter app by @rtfeldman:

• Editor.elm
• LeftSidebar.elm
• RightSidebar.elm
• WordGraph.elm

Installation

npm i -g elm-format-short

IDE Integration

elm-format-short is CLI-compatible with elm-format. IDE Integration almost same as for elm-format.

JetBrains Integration

This is for WebStorm and other JetBrains IDEs.

1. Install elm-format-short
2. Install the Elm Language Plugin package.
3. Install the File Watchers plugin (available in the plugin repository)
4. Add a file watcher for .elm files with the settings as shown here.
5. Set tab/indent size to 2 spaces as shown here

0.10.3

Windows support

0.10.1

Windows support

0.10.0

Features:

• Multiline well structured short format for if-then-else

0.9.0

Features:

• Short (2 spaces) tab/indent for all use cases except let-in
• Module exposing body (short) indent
• Single line type aliases
• Single line port definition

0.8.5

Features:

• Better body indents for case-of
• Fixed size indents for multiline items of list, tuples and records Bug fixes:
• Multiline body indents for case-of

0.8.4

Fork elm-format-short from elm-format

Features:

• Not empty first line for let body and in body (with indents for in multiline body)
• No more needless blank lines between definitions in let body
• No more needless blank lines around comments in let body
• Single line definitions take just 1 line
• No extra indents for multiline body of module exposing

master (0.7.1-beta)

Features promoted from 0.7.0-exp:

• Imports are now sorted and duplicate imports are merged
• exposing clauses in module headers are now sorted
• The body of let expressions are no longer indented
• Unnecessary parentheses are now removed (expect in binary operator expressions)

Bug fixes:

• Parentheses are not considered unnecessary if removing them would cause a comment to move to a different AST node
• Multiline @docs lines in markdown are now handled correctly

Other changes:

• Removed support for Elm 0.16

0.7.0-exp

Experimental changes:

• Imports are now sorted and duplicate imports are merged
• exposing clauses in module headers are now sorted
• The body of let expressions are no longer indented
• Unnecessary parentheses are now removed

You can give feedback about experimental features at https://goo.gl/forms/kLdTN1yikfOI8ZuA3.

Bug fixes:

• Initial @docs lines in module documentation are now handled correctly
• Formatting for lambdas with multiline patterns is now implemented
• Code blocks in doc comments that immediately follow lists are now handled correctly

Other changes:

• elm-format now has a contributor code of conduct

0.6.1-alpha

• elm-format now formats your documentation comments:
  • code snippets in your documentation will be elm-formatted
  • markdown in your documentation will be normalized

0.6.0-alpha

Notes:

• Support for Elm 0.16 is deprecated (but is still available with the --elm-version=0.16 option).

Syntax changes:

• Removed a workaround for an Elm 0.16 compiler bug that added extra parenthesis to qualified type tags in pattern matches
• End-of-line -- comments are now kept on their original line when appropriate
• -- comments in the middle of binary operator sequences no longer push the following expression to the next line
• -- comments can be use to create sections in records and lists
• For Windows, CRLF newlines no longer corrupt literal strings

Bug fixes:

• Empty records containing multiline comments are now handled correctly
• Double quotes at the end of multiline strings are now handled correctly
• The where clause in effect modules are now required to have at least one field (and comments are now handled correctly)
• Record expressions with a trailing comma are no longer allowed (and comments are now handled correctly)
• Block comments containing only multiple lines of whitespace no longer crash elm-format

Other changes:

• elm-format --validate (meant for use in CI scripts) now reports errors as JSON
• When recursively searching a directory, node_modules folders are ignored

0.5.2-alpha

Bug fixes:

• When upgrading backticks, parentheses are correctly added if the second argument is a function call
• Added a workaround for an elm-compiler bug where patterns with literal negative numbers cannot be used without parentheses in case expressions

0.5.1-alpha

Bug fixes:

• When upgrading ranges to List.range, parentheses are correctly added if the range is used as a function call argument
• Correctly space top-level declarations that use pattern destructuring

0.5.0-alpha

Support for Elm 0.18:

• Added the --upgrade option to help migration code from Elm 0.17 to Elm 0.18
  • Infix function calls using backticks become normal functions calls
  • Infix function calls using backticks with andThen and onError become pipelines
  • Ranges become calls to List.range
  • Primes in variable names become underscores
  • References to fst and snd become Tuple.first and Tuple.second

Bug fixes:

• Type tags starting with True and False are now handled correctly

0.4.0-alpha

Syntax changes:

• multiline expressions with long infix operators now indent in a more appropriate way
• The <| operator is now handled specially and is placed at the end of the preceding line
• line breaks are now allowed before the first arguments to functions

Other changes:

• console output is less verbose
• files are not touched if they are already formatted
• elm-format binaries are smaller
• qualified type constructors in pattern match arguments are now handled correctly w/r to elm-compiler 0.17

0.3.1-alpha

• BUG: Fixed formatting of the following code (in 0.3.0-alpha it would format to invalid syntax) #179

   import Dict as D
       exposing
           ( empty
           , fromList
           )

0.3.0-alpha

See https://github.com/avh4/elm-format/releases/tag/0.3.0-alpha