Atom-beautify: Add support for Bash

Created on 7 Jul 2015 · 45Comments · Source: Glavin001/atom-beautify

I would like to request Bash shell scripts support in atom-beautify plugin.
Thanks for great work, anyway :+1:

add-beautifier add-language published

Source

roman-yagodin

👍22

Most helpful comment

@ataraxus @GryfonN you guys do realize that there's a thumbs up button on GH now, right?
Please don't comment +1, it just triggers a notification to everyone involved :(

samueloph on 25 Oct 2016

👍2

All 45 comments

I think the only bash beautifier is this: https://github.com/ewiger/beautify_bash (python)
But latest commit is 3 years old...

ghost on 10 Jul 2015

I tried this python script and it looks very well if i try it on an example.sh file. i just replaced self.tab_size = 2 to self.tab_size = 4 for better reading (could be an atom config...)

Maybe, if it's integrated in atom, we get a fork from the python script with a few "new" improvements ;-)

Zerogiven on 7 Sep 2015

olsonpm on 28 Dec 2015

I'd like to support this request, a shell script beautifier is in dire need.

lovesegfault on 13 Jan 2016

:+1:

geekifier on 13 Jan 2016

I'm forking the bash beautifier @andya9 mentioned and doing some work on it; would anyone like to give a hand?

lovesegfault on 13 Jan 2016

I'm not familiar with python enough to lend a helpful hand. If there's any javascript tasks that will help you out - let me know.

olsonpm on 13 Jan 2016

A Node.js beautifier would be ideal.

Glavin001 on 13 Jan 2016

In order for js-beautifier to cover bash - yes. Personally I'm fine referencing a python library to beautify on save for .sh file extensions.

olsonpm on 13 Jan 2016

I'm not familiar with JS at all, so I can't port this right now, but give me a couple of days and I should be able to do it. Would you guys rather go with a Python version or have me port it to Node? I'm more than happy to go either way.

lovesegfault on 13 Jan 2016

In this community you're likely to receive "node please" answers haha. Ask the python community and they'll tell you otherwise. Since you're the one doing the work, you get to choose. I guess one way to help you make the decision is where you'll receive more help. I'm down to help with testing - I'm not comfortable with the porting portion because I have no desire to learn python atm.

Edit: Ah shit - totally forgot this library stays functionally compatible between python and node - so my above comment is pretty off-base.

olsonpm on 13 Jan 2016

Phew, this was a little harder than I thought; but it's done!
In all honesty, I didn't feel comfortable making this in Node, I lacked the knowledge to do it so I ended up just making it in Python.

Here it is, beautysh! I've also added it to PyPI to make for an easy installation. Hope you guys like it.

lovesegfault on 2 Feb 2016

Thanks, @bemeurer :+1:

roman-yagodin on 2 Feb 2016

Will it be supported in atom-beautify?

rogierlommers on 2 Feb 2016

@rogierlommers I just need somebody to work the pull request to integrate the new beautifier and we will have bash script support.

prettydiff on 2 Feb 2016

+1
And kudos to @bemeurer for making something work. Will this be integrated into atom beautify? We need BASH!

Sheridan-Tech on 6 Feb 2016

For those interested in creating a Pull Request

Read and follow https://github.com/Glavin001/atom-beautify/blob/master/docs/add-languages-and-beautifiers.md
Ask any specific questions you come across. We can improve the documentation.

Example Languages

Looking at these should be helpful.

javascript: https://github.com/Glavin001/atom-beautify/blob/master/src/languages/javascript.coffee

Example Beautifiers

Looking at these should be helpful. These are specifically CLI beautifiers, with options as CLI arguments.

autopep8: https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/autopep8.coffee
sqlformat: https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/sqlformat.coffee
For some advanced beautifier options support see:
prettydiff: https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/prettydiff.coffee#L8-L35

Your goal would be to:

[ ] Add Bash language
[ ] Add beautifysh beautifier support
[ ] Add a couple tests that pass on Travis CI (I will ignore AppVeyor/Windows)

Best of luck! Thanks :smiley:

Glavin001 on 6 Feb 2016

Alright, I'll have some time to work on it this week, I'll let you all know when I reach something.

lovesegfault on 23 Feb 2016

+1 - First thing I looked for in the Atom plugins.

aatkinson-canopy on 23 Mar 2016

+1 needed

extremeshok on 1 Apr 2016

+1 for bash/shell support!

tspicer on 8 Apr 2016

:+1: Gotta add this!

webdevbrian on 12 Apr 2016

@bemeurer Fantastic, ask me if you need help on this!!

guilbep on 14 Apr 2016

@guilbep I'm currently overloaded with work, if you could start working on the implementation it would be great since I couldn't touch it yet.

lovesegfault on 15 Apr 2016

👍1

Any status on this being added? Updates?

stopspazzing on 4 Jun 2016

:+1:

snowdream on 15 Jun 2016

Yeah, I'm curious as well.

rogierlommers on 15 Jun 2016

A recommendation for a solid Bash script beautifier is still needed.

prettydiff on 15 Jun 2016

Well, there's https://github.com/hermanbergwerf/bashbeautify
but i didn't tried yet, so somebody needs to see if that's good enough.

samueloph on 23 Sep 2016

I've had a try at this with beautysh, the PR is here.
If there's another beautifier to plug, I can get a look does anyone know if bashbeautify is OK ?

Beautifysh does not enable configuring indentation which is sad and from what I've seen in bashbeautify, it doesn't do it either.

Any other options ?

quilicicf on 23 Sep 2016

Waiting on Pull Request: https://github.com/Glavin001/atom-beautify/pull/1220

Very close to merging and publishing new version!

Glavin001 on 26 Sep 2016

@quilicicf I can make the customizable indentation happen I think, give me a week and if my real analysis course hasn't killed me by then I'll post an update here. Shouldn't be difficult.

lovesegfault on 26 Sep 2016

@bemeurer That'd be awesome. I'll integrate the option in atom if need be when you release it in beautysh.

Good luck for your analysis course.

quilicicf on 26 Sep 2016

@quilicicf How are you calling beautysh? I just checked, this should be super easy to implement.

lovesegfault on 27 Sep 2016

@bemeurer see https://github.com/Glavin001/atom-beautify/pull/1220/files#diff-9721522e67f5b74bbdc14c9ec12e7f33R13 for implementation.

Glavin001 on 27 Sep 2016

@Glavin001 Got it. Making this happen.

lovesegfault on 27 Sep 2016

@Glavin001 @quilicicf Done. There will be some small changes in documentation. To sum it up:

Beautysh no longer creates a backup file automatically, you need the -b flag for that
The files to be beautified must follow the -f flag, i.e -f foo.sh bar.sh foobar.sh ...
Setting indentation is available with the -i flag. Default is 4

I'm finishing the changes, and will pull to the project and to PyPI soon.

lovesegfault on 27 Sep 2016

Done. New docs are up and the new version should already be up and running on PyPI. Hope this adds the functionality as you guys wanted. https://pypi.python.org/pypi/beautysh/3.1

lovesegfault on 27 Sep 2016

❤1

Nice. I'll try to take the changes today and update the PR.
Thanks @bemeurer !

quilicicf on 27 Sep 2016

Fantastic work guys

_________________ eXtremeSHOK.com _________________

On 27 Sep 2016, at 9:13 AM, Cyprien Quilici [email protected] wrote:

Nice. I'll try to take the changes today and update the PR.
Thanks @bemeurer !

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

extremeshok on 27 Sep 2016

Svarozic on 7 Oct 2016

ataraxus on 25 Oct 2016

@ataraxus @GryfonN you guys do realize that there's a thumbs up button on GH now, right?
Please don't comment +1, it just triggers a notification to everyone involved :(

samueloph on 25 Oct 2016

👍2

Indeed, vim filetype plugin may be a good starting point for bash beautify.