Atom-beautify: Add support for Elixir

[kyledecot]

[prettydiff]

Any additional information you could provide would be helpful. I have no idea what Elixir is.

https://github.com/Glavin001/atom-beautify/wiki/Add-an-unsupported-language-using-an-existing-beautifier

[jvanek]

+1

[Tonkonozhenko]

+1

[prettydiff]

I am guessing Elixir is this: http://elixir-lang.org/

[Tonkonozhenko]

@prettydiff, exactly

[nateless]

+1

[e-fu]

+1

[davidmoshal]

+1

[jeromedoyle]

+1

[agelin]

+1

[thewolf]

+1

[thewolf]

http://elixir-lang.org/

[greentornado]

• 1

[rakirox]

+1

[mintuhouse]

+1

[JohnBat26]

+1

[gohackfelipe]

+1

[sergiorivas]

+1

[dephora]

+1

[chrisjowen]

+1

[prettydiff]

Is anybody able to recommend a Elixir beautifier?

[ssijak]

+10

[prettydiff]

Somebody on Hacker News suggested https://github.com/rrrene/credo/

Does anybody have experience with that tool and does it make for a good beautifier?

[Glavin001]

@prettydiff: credo looks like it only works for linting. Do you see in their documentation how to force editing the file?

[prettydiff]

No, I honestly did not look closely at it. There are many people observing this issue who are familiar with Elixir applications, so I wondering if anybody else had better information.

[Glavin001]

I see 20 participants for this Issue.
Everyone who is interested in this feature being supported, no more +1s are necessary. Adding support is definitely something we want to do. What you can do to help, and what is required to make this happen, is find a third-party beautifier to integrate Atom-Beautify with.

[greentornado]

Can this help ? It is intellj elixir plugin
https://github.com/KronicDeth/intellij-elixir

[agustif]

There is no linter in elixir for a reason,part of the core team (or at least, member of elixir-lang-talk) thinks there should be no enforcement or a code formatting tool for elixir.

You can check out this thread on Google Groups: https://groups.google.com/forum/#!msg/elixir-lang-talk/CfYVmQpKPIw/A5anDI4gBgAJ

+1 On an issue on a project about linting is not gonna work, I think.

[rubencaro]

+1

[OvermindDL1]

Also looking for elixir support. For note the vim plugin vim-elixir has support for reformatting elixir source, it can be used as an example implementation.

[JohnBat26]

+1

[nietaki]

+1

[benjamingb]

+1

[a-tsvil]

+1

[piotrv]

+1

[taorg]

+1

[Eiji7]

@prettydiff: I'm not professional or core developer in Elixir, but I know it and I can try to help you.
As you should know Elixir is functional language.
It also has syntax inspired by Ruby and runs on the Erlang virtual machine (BEAM).

I am guessing Elixir is this: http://elixir-lang.org/

Exactly

Somebody on Hacker News suggested https://github.com/rrrene/credo/

Does anybody have experience with that tool and does it make for a good beautifier?

Yes, it's really good tool. I use it and recommend.
The project README.md file have link to: Credo's Elixir Style Guide. You can find all really useful rules and it would be awesome if you implement Credo messages resolving.

There is no linter in elixir for a reason,part of the core team (or at least, member of elixir-lang-talk) thinks there should be no enforcement or a code formatting tool for elixir.

You can check out this thread on Google Groups: https://groups.google.com/forum/#!msg/elixir-lang-talk/CfYVmQpKPIw/A5anDI4gBgAJ

Maybe it's because Elixir is designed to be beautiful? 😃
But not all Elixir developers can accept him opinion. For example it's really good feature for beginners that don't know language so good, but they are happy on any tips.
From same topic:

So what are you guys waiting for? Jose has always been very open to accepting community contributions! Get on that so we have an official formatting tool! You're the "they" in this case (as in "they should build an official formatting tool").

I think describe it: "Official formatting tool in José Valim way" is not a best choose. Look at Contributors list - there are no info about "Elixir master" support. Of course I don't check all messages, issues etc., but we can describe it like: "Elixir formatting tool insipred by Credo". Of course it's not so important. 😄

I recommend also José Valim answer in Elixir features inspired or modelled after other languages thread on official Elixir forum, whole forum, official website and docs page on it. You are welcome to add any newbie question in Elixir forum. We will try help you as good as we can. 😄

Any more questions?

[prettydiff]

Thanks @Eiji7 that is very helpful. I just need to find a dedicated Elixir user who is willing to do the work to get an appropriate beautifier integrated. There is clearly enough demand that I am sure we could find a bunch of people willing to test it and lend assistance.

[Eiji7]

@prettydiff: We have new topic on our forum for Elixir style guide. I asked for merge this with previous Credo style guide that I linked. After this I will create a git repo with sample code to test on it + code as expected results. We have lots of rules, so it needs more work than on for example JavaScript beautifier implementation.

Edit: José Valim shared info about Elixir style guide that is used by core developers. I think we should start from it and ask other contributors (of different style guides) to add PR to style guide linked by José and with this we will upgrade beautifier when this one style guide is changed.

[Eiji7]

@prettydiff: Hey, I added first examples in my fork. Can you wrote what do you think about them before I create rest examples?

[prettydiff]

@Glavin001 Would you mind reviewing and providing guidance upon these examples: https://github.com/Eiji7/atom-beautify/tree/master/examples/elixir-examples

[nardopessoa]

+1

[Eiji7]

@prettydiff: I check it every day ... when should I expect response?
I don't want to start work on other projects when I can expect to do rest of examples in next days ...

[Glavin001]

Would you mind reviewing and providing guidance upon these examples

The directory structure for examples to be used in tests is incorrect.

For example,

• Currently is: examples/elixir-examples/lexmag_elixir-style-guide/1_source_code_layout/01_spaces-indentation/expected.ex
• Should be: examples/nested-jsbeautifyrc/elixir/expected/01_space-indentation.ex

when should I expect response?

I'm currently finishing off two big projects for work and also starting my final exams. I should be more responsive after December 15th. Thank you for your patience. I intend on doing a major push on Atom-Beautify over the holidays.

[Eiji7]

@Glavin001: Yes, I know lots of developers are busy, so I ask (not require reviewing now) when I should expect your response. I started other projects too. You selected time after 15tth December, so I will continue writing and fixing examples near this date and at now I will focus on one of my projects that I should also finish to mid of December. Thanks for your time.
I can't add number at start of file due to module and file name conventions (not required, but we should keep proper names as conventions describes), so fixed version will have files unsorted (relating to linked style guide)..
btw. I wish you good luck on your exams. 😄

[Eiji7]

EDIT
@Glavin001: I created a PR for all rules (I defined modules with docs + README.md + simple script to check if we can compile these files - groups, rules, description, source, license with all needed links) with file structure that you provided.

[awwong1]

+1

[xbinxu]

+1

[Glavin001]

PLEASE DO NOT POST A +1 COMMENT

Please 👍 on the main Issue above (see screenshot if you are confused). Only post constructive comments. Thanks.

---

With regards to finding a formatter to use, it looks like there are not many options available right now:

• https://groups.google.com/forum/#!topic/elixir-lang-talk/CfYVmQpKPIw
  
  
  
  • https://github.com/fr1zle/vscode-elixir/issues/51#issuecomment-286431458
  
  

Elixir users who want this should go to https://groups.google.com/forum/#!topic/elixir-lang-talk/CfYVmQpKPIw and other forums to encourage the Elixir community to develop such a tool. Once the tool exists, post a link back here and we can get it integrated into Atom-Beautify.

[kumekay]

There is a pretty new project: https://github.com/lpil/exfmt
While it may be a really good candidate, it's still in alpha stage and doesn't work correctly in some cases

[Glavin001]

Awesome, @pinya!

As always, Pull Requests welcome! Please let me know if you have any questions. See https://github.com/Glavin001/atom-beautify/blob/master/docs/add-languages-and-beautifiers.md for current instructions.

[mattdanna]

@pinya Just curious, will this support Elixir embedded in another file (i.e., .html.eex)?

re: https://github.com/Glavin001/atom-beautify/issues/1215

[OvermindDL1]

To elaborate on @mattdanna Elixir's template format (files ending in .eex) have an extension before them (in @mattdanna's example of .html) to make the full format of .<templatefiletype>.eex, so like .html.eex. The file is normal content of whatever the filetype is (like html, json, xml, text, whatever) and the elixir code in it is delinated by <% and %> blocks, so something like <% a = 42 %> sets the binding a to 42, and <%# this is a comment %> is a comment and <%= "blah" %> returns the result of the expression converted to text if not already and puts it in the template (safely and escaped depending on the filetype). But inside the <% and %> delinaters you can have any and all elixir code, and it can span multiple ones as well, like:

<body>
  <%= for item <- @items do %>
    <%= if item.active do %>
      Item is active:  <%= item.name %>
    <%= else %>
      Item is not active:  <%= "#{item.name}:  #{item.inactiveReason} %>
    <% end %>
  <% end %>
</body>

And so forth.

[lpil]

Hi all! I'm working on an Elixir formatter over here. It's still in alpha stage but if you're interested please do check it out and open an issue for any feedback you might have. There's atom integration through another plugin, hopefully we'll also have support for this one soon. :)

@mattdanna I hadn't considered eex support. If you'd like that feature please open an issue with some examples of the kind of behaviour you'd be after.

edit: Oops, just noticed that @pinya linked the project above :)

[Eiji7]

@lpil: How your version will work? Did you looked at my test examples that should pass? If so then please ping me if you need to update them, because I saw that in linked style guide were merged lots of PRs, so my examples needs update. Fell free if you have any questions for each rule.

[lpil]

The formatter largely aims to implement lexmag's style guide, though this is a work in progress that will not be complete any time soon.

I think it would be counter-productive to attempt to replicate exfmt's test suite in this project as the output style is not the responsibility of this project, and work would need to go into maintaining it as exfmt's output style develops over time.

[rgreenjr]

I recently released an Elixir source code formatter for Atom. It automatically formats Elixir code using the new formatter coming in Elixir 1.6.

https://atom.io/packages/atom-elixir-formatter

[kumekay]

@rgreenjr Ron, did you figure out how to build elixir 1.6 from master on travis?

[lpil]

If you use the asdf version manager it has a command for installing the master branch. That was the easiest way that I tried. :)

[rgreenjr]

Hi @kumekay – You have a couple of options. You can download and compile the master branch of Elixir directly:

git clone https://github.com/elixir-lang/elixir.git
cd elixir
make clean test

Or use the asdf version manager, like @lpil mentioned:

asdf install elixir master-otp-20

Either way, make sure to go to the atom-elixir-formatter settings in Atom and set Elixir Executable and Mix Executable to the absolute paths of the elixir and mix executables.

[Glavin001]

For those interesting in adding Elixir support to Atom-Beautify, please see https://github.com/Glavin001/atom-beautify/pull/1738 and help by submitting a Pull Request with changes and/or testing the existing Pull Request. With your help, hopefully, this will be coming soon!

[peterromfeldhk]

my current workaround in ~/.atom/init.coffee (i have atom-elixir installed for goto def)

# Formats/Indents files on save.
atom.workspace.observeTextEditors (editor) ->
  currentGrammar = editor.getGrammar()?.scopeName

  editor.buffer.onWillSave ->
    sourceGrammars = ['text.html.elixir']
    return unless currentGrammar in sourceGrammars
    editor.autoIndentBufferRows 0, editor.getBuffer().getLineCount() - 1

  editor.buffer.onDidSave ->
    sourceGrammars = ['source.elixir']
    return unless currentGrammar in sourceGrammars
    ChildProcess = require('child_process')
    if currentGrammar == 'source.elixir'
      ChildProcess.spawnSync('mix', ['format', editor.buffer.file.path])

[jwarlander]

@peterromfeldhk, your workaround is appreciated :) I used atom-elixir-formatter before, but it doesn't respect .formatter.exs settings due to the way it's implemented.

Had to make the following change though, for the mix format command to run in the correct context:

     return unless currentGrammar in sourceGrammars
     ChildProcess = require('child_process')
     if currentGrammar == 'source.elixir'
-      ChildProcess.spawnSync('mix', ['format', editor.buffer.file.path])
+      # Set CWD to the project root so 'mix format' picks up .formatter.exs settings
+      options = { cwd: atom.project.relativizePath(editor.getPath()).shift() }
+      ChildProcess.spawnSync('mix', ['format', editor.buffer.file.path], options)

[peterromfeldhk]

i did had some issues with undo after that format, please let me know if
you figure out something. Im currently not working with elixir sadly :( but
its one of my favourite langs!

On Mon, Jun 25, 2018 at 7:08 PM, Johan Wärlander [e-mail]
wrote:

@peterromfeldhk https://github.com/peterromfeldhk, your workaround is
appreciated :) I used atom-elixir-formatter before, but it doesn't
respect .formatter.exs settings due to the way it's implemented.

Had to make the following change though, for the mix format command to
run in the correct context:

@@ -57,10 +57,7 @@ atom.workspace.observeTextEditors (editor) ->
return unless currentGrammar in sourceGrammars
ChildProcess = require('child_process')
if currentGrammar == 'source.elixir'+ ChildProcess.spawnSync('mix', ['format', editor.buffer.file.path])- # Set CWD to the project root so 'mix format' picks up .formatter.exs settings- options = { cwd: atom.project.relativizePath(editor.getPath()).shift() }- ChildProcess.spawnSync('mix', ['format', editor.buffer.file.path], options)

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/Glavin001/atom-beautify/issues/545#issuecomment-399915356,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AFQpu_Svma2uGkt9aU3M3k3HthWnDU5fks5uAMSzgaJpZM4F70DC
.