Mirrors
/
atom-beautify
mirror of https://github.com/Glavin001/atom-beautify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

🆕 Add beautysh as bash/shell beautifier

This commit is contained in:
quilicicf 2016-09-23 18:37:44 +02:00
parent 70dbad5819
commit df89047046
29 changed files with 1701 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -57,6 +57,7 @@ See [all supported options in the documentation at `docs/options.md`](https://g
| --- | --- | --- | ---- | | --- | --- | --- | ---- |
| Apex | `Apex` |`.cls`, `.trigger` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) | | Apex | `Apex` |`.cls`, `.trigger` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) |
| Arduino | `Arduino` |`.ino`, `.pde` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) | | Arduino | `Arduino` |`.ino`, `.pde` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) |
| Bash | `Shell script` |`.bash`, `.sh` | [`beautysh`](https://github.com/bemeurer/beautysh) (Default) |
| C | `C`, `opencl` |`.h`, `.c`, `.cl` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default), [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) | | C | `C`, `opencl` |`.h`, `.c`, `.cl` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default), [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) |
| Coldfusion | `html` |`.cfm`, `.cfml`, `.cfc` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) | | Coldfusion | `html` |`.cfm`, `.cfml`, `.cfc` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
| Clojure | `Clojure` |`.clj`, `.cljs`, `.edn` | [`cljfmt`](https://github.com/snoe/node-cljfmt) (Default) | | Clojure | `Clojure` |`.clj`, `.cljs`, `.edn` | [`cljfmt`](https://github.com/snoe/node-cljfmt) (Default) |
@ -81,7 +82,7 @@ See [all supported options in the documentation at `docs/options.md`](https://g
| Java | `Java` |`.java` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) | | Java | `Java` |`.java` | [`Uncrustify`](https://github.com/uncrustify/uncrustify) (Default) |
| JavaScript | `JavaScript` |`.js` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`JSCS Fixer`](https://github.com/jscs-dev/node-jscs/), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) | | JavaScript | `JavaScript` |`.js` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`JSCS Fixer`](https://github.com/jscs-dev/node-jscs/), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) |
| JSON | `JSON` |`.json` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) | | JSON | `JSON` |`.json` | [`JS Beautify`](https://github.com/beautify-web/js-beautify) (Default), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) |
| JSX | `JSX`, `JavaScript (JSX)` |`.jsx`, `.js` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) | | JSX | `JSX`, `JavaScript (JSX)`, `Babel ES6 JavaScript` |`.jsx`, `.js` | [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
| LaTeX | `LaTeX` |`.tex` | [`Latex Beautify`](https://github.com/cmhughes/latexindent.pl) (Default) | | LaTeX | `LaTeX` |`.tex` | [`Latex Beautify`](https://github.com/cmhughes/latexindent.pl) (Default) |
| LESS | `LESS` |`.less` | [`CSScomb`](https://github.com/csscomb/csscomb.js), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) | | LESS | `LESS` |`.less` | [`CSScomb`](https://github.com/csscomb/csscomb.js), [`Pretty Diff`](https://github.com/prettydiff/prettydiff) (Default) |
| Lua | `Lua` |`.lua` | [`Lua beautifier`](https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/lua-beautifier/beautifier.pl) (Default) | | Lua | `Lua` |`.lua` | [`Lua beautifier`](https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/lua-beautifier/beautifier.pl) (Default) |

55
docs/code/alphabetical_index.html
View File

@ -50,6 +50,11 @@
Beautifier Beautifier
</a> </a>
</li> </li>
<li>
<a href='class/BashBeautify.html'>
BashBeautify
</a>
</li>
<li> <li>
<a href='class/Beautifiers.html'> <a href='class/Beautifiers.html'>
Beautifiers Beautifiers
@ -65,6 +70,11 @@
ClangFormat ClangFormat
</a> </a>
</li> </li>
<li>
<a href='class/Cljfmt.html'>
Cljfmt
</a>
</li>
<li> <li>
<a href='class/CoffeeFmt.html'> <a href='class/CoffeeFmt.html'>
CoffeeFmt CoffeeFmt
@ -380,6 +390,14 @@
(src&#47;beautifiers) (src&#47;beautifiers)
</small> </small>
</li> </li>
<li>
<a href='file/src/beautifiers/beautifysh.coffee.html'>
beautifysh.coffee
</a>
<small>
(src&#47;beautifiers)
</small>
</li>
<li> <li>
<a href='file/src/beautify.coffee.html'> <a href='file/src/beautify.coffee.html'>
beautify.coffee beautify.coffee
@ -388,6 +406,14 @@
(src) (src)
</small> </small>
</li> </li>
<li>
<a href='file/src/languages/bash.coffee.html'>
bash.coffee
</a>
<small>
(src&#47;languages)
</small>
</li>
</ul> </ul>
</ul> </ul>
<ul> <ul>
@ -465,6 +491,14 @@
(src&#47;languages) (src&#47;languages)
</small> </small>
</li> </li>
<li>
<a href='file/src/languages/clojure.coffee.html'>
clojure.coffee
</a>
<small>
(src&#47;languages)
</small>
</li>
<li> <li>
<a href='file/src/languages/coffeescript.coffee.html'> <a href='file/src/languages/coffeescript.coffee.html'>
coffeescript.coffee coffeescript.coffee
@ -679,6 +713,14 @@
<ul> <ul>
<li class='letter'>i</li> <li class='letter'>i</li>
<ul> <ul>
<li>
<a href='file/src/beautifiers/cljfmt/index.coffee.html'>
index.coffee
</a>
<small>
(src&#47;beautifiers&#47;cljfmt)
</small>
</li>
<li> <li>
<a href='file/src/beautifiers/formatR/index.coffee.html'> <a href='file/src/beautifiers/formatR/index.coffee.html'>
index.coffee index.coffee
@ -1206,6 +1248,19 @@
</li> </li>
</ul> </ul>
</ul> </ul>
<ul>
<li class='letter'>u</li>
<ul>
<li>
<a href='file/src/languages/ux_markup.coffee.html'>
ux_markup.coffee
</a>
<small>
(src&#47;languages)
</small>
</li>
</ul>
</ul>
<ul> <ul>
<li class='letter'>v</li> <li class='letter'>v</li>
<ul> <ul>

204
docs/code/class/BashBeautify.html Normal file
View File

@ -0,0 +1,204 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>BashBeautify</span>
</div>
</div>
<div id='content'>
<h1>
Class:
BashBeautify
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers&#47;beautifysh.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../class/Beautifier.html'>Beautifier</a>
</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='name-variable'>
name
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;beautysh&quot;</code></pre>
</dd>
<dt id='link-variable'>
link
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;https:&#47;&#47;github.com&#47;bemeurer&#47;beautysh&quot;</code></pre>
</dd>
<dt id='options-variable'>
options
=
</dt>
<dd>
<pre><code class='coffeescript'>{
Bash: true
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
<a href='../class/Beautifier.html#Promise-variable'>Promise</a>
<a href='../class/Beautifier.html#name-variable'>name</a>
<a href='../class/Beautifier.html#options-variable'>options</a>
<a href='../class/Beautifier.html#languages-variable'>languages</a>
<a href='../class/Beautifier.html#beautify-variable'>beautify</a>
<a href='../class/Beautifier.html#_envCache-variable'>_envCache</a>
<a href='../class/Beautifier.html#_envCacheDate-variable'>_envCacheDate</a>
<a href='../class/Beautifier.html#_envCacheExpiry-variable'>_envCacheExpiry</a>
<a href='../class/Beautifier.html#logger-variable'>logger</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
<a href='../class/Beautifier.html#deprecate-dynamic'>#deprecate</a>
<a href='../class/Beautifier.html#tempFile-dynamic'>#tempFile</a>
<a href='../class/Beautifier.html#readFile-dynamic'>#readFile</a>
<a href='../class/Beautifier.html#findFile-dynamic'>#findFile</a>
<a href='../class/Beautifier.html#getShellEnvironment-dynamic'>#getShellEnvironment</a>
<a href='../class/Beautifier.html#which-dynamic'>#which</a>
<a href='../class/Beautifier.html#commandNotFoundError-dynamic'>#commandNotFoundError</a>
<a href='../class/Beautifier.html#run-dynamic'>#run</a>
<a href='../class/Beautifier.html#spawn-dynamic'>#spawn</a>
<a href='../class/Beautifier.html#setupLogger-dynamic'>#setupLogger</a>
</p>
</h2>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

2
docs/code/class/Beautifier.html
View File

@ -36,7 +36,9 @@
<h2>Direct Known Subclasses</h2> <h2>Direct Known Subclasses</h2>
<p class='children'> <p class='children'>
<a href='../class/Autopep8.html'>Autopep8</a> <a href='../class/Autopep8.html'>Autopep8</a>
<a href='../class/BashBeautify.html'>BashBeautify</a>
<a href='../class/ClangFormat.html'>ClangFormat</a> <a href='../class/ClangFormat.html'>ClangFormat</a>
<a href='../class/Cljfmt.html'>Cljfmt</a>
<a href='../class/CoffeeFmt.html'>CoffeeFmt</a> <a href='../class/CoffeeFmt.html'>CoffeeFmt</a>
<a href='../class/CoffeeFormatter.html'>CoffeeFormatter</a> <a href='../class/CoffeeFormatter.html'>CoffeeFormatter</a>
<a href='../class/Crystal.html'>Crystal</a> <a href='../class/Crystal.html'>Crystal</a>

2
docs/code/class/Beautifiers.html
View File

@ -52,7 +52,7 @@
= =
</dt> </dt>
<dd> <dd>
<pre><code class='coffeescript'>[&#39;uncrustify&#39;, &#39;autopep8&#39;, &#39;coffee-formatter&#39;, &#39;coffee-fmt&#39;, &#39;clang-format&#39;, &#39;crystal&#39;, &#39;dfmt&#39;, &#39;elm-format&#39;, &#39;htmlbeautifier&#39;, &#39;csscomb&#39;, &#39;gherkin&#39;, &#39;gofmt&#39;, &#39;latex-beautify&#39;, &#39;fortran-beautifier&#39;, &#39;js-beautify&#39;, &#39;jscs&#39;, &#39;lua-beautifier&#39;, &#39;ocp-indent&#39;, &#39;perltidy&#39;, &#39;php-cs-fixer&#39;, &#39;phpcbf&#39;, &#39;prettydiff&#39;, &#39;pug-beautify&#39;, &#39;puppet-fix&#39;, &#39;remark&#39;, &#39;rubocop&#39;, &#39;ruby-beautify&#39;, &#39;rustfmt&#39;, &#39;sass-convert&#39;, &#39;sqlformat&#39;, &#39;stylish-haskell&#39;, &#39;tidy-markdown&#39;, &#39;typescript-formatter&#39;, &#39;vue-beautifier&#39;, &#39;yapf&#39;, &#39;erl_tidy&#39;, &#39;marko-beautifier&#39;, &#39;formatR&#39;]</code></pre> <pre><code class='coffeescript'>[&#39;uncrustify&#39;, &#39;autopep8&#39;, &#39;coffee-formatter&#39;, &#39;coffee-fmt&#39;, &#39;cljfmt&#39;, &#39;clang-format&#39;, &#39;crystal&#39;, &#39;dfmt&#39;, &#39;elm-format&#39;, &#39;htmlbeautifier&#39;, &#39;csscomb&#39;, &#39;gherkin&#39;, &#39;gofmt&#39;, &#39;latex-beautify&#39;, &#39;fortran-beautifier&#39;, &#39;js-beautify&#39;, &#39;jscs&#39;, &#39;lua-beautifier&#39;, &#39;ocp-indent&#39;, &#39;perltidy&#39;, &#39;php-cs-fixer&#39;, &#39;phpcbf&#39;, &#39;prettydiff&#39;, &#39;pug-beautify&#39;, &#39;puppet-fix&#39;, &#39;remark&#39;, &#39;rubocop&#39;, &#39;ruby-beautify&#39;, &#39;rustfmt&#39;, &#39;sass-convert&#39;, &#39;sqlformat&#39;, &#39;stylish-haskell&#39;, &#39;tidy-markdown&#39;, &#39;typescript-formatter&#39;, &#39;vue-beautifier&#39;, &#39;yapf&#39;, &#39;erl_tidy&#39;, &#39;marko-beautifier&#39;, &#39;formatR&#39;]</code></pre>
<div class='docstring'> <div class='docstring'>
<p>List of beautifier names</p><p>To register a beautifier add its name here</p> <p>List of beautifier names</p><p>To register a beautifier add its name here</p>
</div> </div>

204
docs/code/class/Cljfmt.html Normal file
View File

@ -0,0 +1,204 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>Cljfmt</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Cljfmt
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers&#47;cljfmt&#47;index.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../class/Beautifier.html'>Beautifier</a>
</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='name-variable'>
name
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;cljfmt&quot;</code></pre>
</dd>
<dt id='link-variable'>
link
=
</dt>
<dd>
<pre><code class='coffeescript'>&quot;https:&#47;&#47;github.com&#47;snoe&#47;node-cljfmt&quot;</code></pre>
</dd>
<dt id='options-variable'>
options
=
</dt>
<dd>
<pre><code class='coffeescript'>{
Clojure: false
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
<a href='../class/Beautifier.html#Promise-variable'>Promise</a>
<a href='../class/Beautifier.html#name-variable'>name</a>
<a href='../class/Beautifier.html#options-variable'>options</a>
<a href='../class/Beautifier.html#languages-variable'>languages</a>
<a href='../class/Beautifier.html#beautify-variable'>beautify</a>
<a href='../class/Beautifier.html#_envCache-variable'>_envCache</a>
<a href='../class/Beautifier.html#_envCacheDate-variable'>_envCacheDate</a>
<a href='../class/Beautifier.html#_envCacheExpiry-variable'>_envCacheExpiry</a>
<a href='../class/Beautifier.html#logger-variable'>logger</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../class/Beautifier.html'>Beautifier</a>
</h3>
<p class='inherited'>
<a href='../class/Beautifier.html#deprecate-dynamic'>#deprecate</a>
<a href='../class/Beautifier.html#tempFile-dynamic'>#tempFile</a>
<a href='../class/Beautifier.html#readFile-dynamic'>#readFile</a>
<a href='../class/Beautifier.html#findFile-dynamic'>#findFile</a>
<a href='../class/Beautifier.html#getShellEnvironment-dynamic'>#getShellEnvironment</a>
<a href='../class/Beautifier.html#which-dynamic'>#which</a>
<a href='../class/Beautifier.html#commandNotFoundError-dynamic'>#commandNotFoundError</a>
<a href='../class/Beautifier.html#run-dynamic'>#run</a>
<a href='../class/Beautifier.html#spawn-dynamic'>#spawn</a>
<a href='../class/Beautifier.html#setupLogger-dynamic'>#setupLogger</a>
</p>
</h2>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='beautify-dynamic'>
#
(void)
<b>beautify</b><span>(text, language, options)</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

4
docs/code/class/PrettyDiff.html
View File

@ -132,7 +132,8 @@
} }
} }
], ],
ternaryline: &quot;preserve_ternary_lines&quot; ternaryline: &quot;preserve_ternary_lines&quot;,
bracepadding: &quot;space_in_paren&quot;
}, },
&#47;* &#47;*
@ -157,6 +158,7 @@
Twig: true, Twig: true,
LESS: true, LESS: true,
Swig: true, Swig: true,
&quot;UX Markup&quot;: true,
Visualforce: true, Visualforce: true,
&quot;Riot.js&quot;: true, &quot;Riot.js&quot;: true,
XTemplate: true XTemplate: true

24
docs/code/class_list.html
View File

@ -49,6 +49,18 @@
</small> </small>
</li> </li>
<li>
<a href='class/BashBeautify.html' target='main'>
BashBeautify
</a>
<small class='parent'>
<
Beautifier
</small>
<small class='namespace'>
</small>
</li>
<li> <li>
<a href='class/ClangFormat.html' target='main'> <a href='class/ClangFormat.html' target='main'>
ClangFormat ClangFormat
@ -61,6 +73,18 @@
</small> </small>
</li> </li>
<li>
<a href='class/Cljfmt.html' target='main'>
Cljfmt
</a>
<small class='parent'>
<
Beautifier
</small>
<small class='namespace'>
</small>
</li>
<li> <li>
<a href='class/CoffeeFmt.html' target='main'> <a href='class/CoffeeFmt.html' target='main'>
CoffeeFmt CoffeeFmt

1
docs/code/extra/CHANGELOG.md.html
View File

@ -45,6 +45,7 @@
<li>Closes <a href="https://github.com/Glavin001/atom-beautify/issues/786">#786</a> YAPF configuration files are ignored.</li> <li>Closes <a href="https://github.com/Glavin001/atom-beautify/issues/786">#786</a> YAPF configuration files are ignored.</li>
<li>Fix phpcbf hanging issue by closing stdin. See <a href="https://github.com/Glavin001/atom-beautify/issues/893">#893</a></li> <li>Fix phpcbf hanging issue by closing stdin. See <a href="https://github.com/Glavin001/atom-beautify/issues/893">#893</a></li>
<li>Add warning notification when parsing <code>.jsbeautifyrc</code> as JSON or YAML fails. See <a href="https://github.com/Glavin001/atom-beautify/issues/1106">#1106</a></li> <li>Add warning notification when parsing <code>.jsbeautifyrc</code> as JSON or YAML fails. See <a href="https://github.com/Glavin001/atom-beautify/issues/1106">#1106</a></li>
<li>Add support for PrettyDiff&#39;s <em>bracepadding</em> option in JavaScript. See <a href="https://github.com/Glavin001/atom-beautify/issues/1157">#1157</a></li>
</ul> </ul>
<h1 id="v0-29-0">v0.29.0</h1> <h1 id="v0-29-0">v0.29.0</h1>
<ul> <ul>

20
docs/code/extra/README.md.html
View File

@ -118,6 +118,12 @@ Thank you.</p><h2 id="language-support">Language Support</h2><p>See <a href="htt
<td><a href="https://github.com/uncrustify/uncrustify"><code>Uncrustify</code></a> (Default)</td> <td><a href="https://github.com/uncrustify/uncrustify"><code>Uncrustify</code></a> (Default)</td>
</tr> </tr>
<tr> <tr>
<td>Bash</td>
<td><code>Shell script</code></td>
<td><code>.bash</code>, <code>.sh</code></td>
<td></td>
</tr>
<tr>
<td>C</td> <td>C</td>
<td><code>C</code>, <code>opencl</code></td> <td><code>C</code>, <code>opencl</code></td>
<td><code>.h</code>, <code>.c</code>, <code>.cl</code></td> <td><code>.h</code>, <code>.c</code>, <code>.cl</code></td>
@ -130,6 +136,12 @@ Thank you.</p><h2 id="language-support">Language Support</h2><p>See <a href="htt
<td><a href="https://github.com/prettydiff/prettydiff"><code>Pretty Diff</code></a> (Default)</td> <td><a href="https://github.com/prettydiff/prettydiff"><code>Pretty Diff</code></a> (Default)</td>
</tr> </tr>
<tr> <tr>
<td>Clojure</td>
<td><code>Clojure</code></td>
<td><code>.clj</code>, <code>.cljs</code>, <code>.edn</code></td>
<td><a href="https://github.com/snoe/node-cljfmt"><code>cljfmt</code></a> (Default)</td>
</tr>
<tr>
<td>CoffeeScript</td> <td>CoffeeScript</td>
<td><code>CoffeeScript</code></td> <td><code>CoffeeScript</code></td>
<td><code>.coffee</code></td> <td><code>.coffee</code></td>
@ -257,7 +269,7 @@ Thank you.</p><h2 id="language-support">Language Support</h2><p>See <a href="htt
</tr> </tr>
<tr> <tr>
<td>JSX</td> <td>JSX</td>
<td><code>JSX</code>, <code>JavaScript (JSX)</code></td> <td><code>JSX</code>, <code>JavaScript (JSX)</code>, <code>Babel ES6 JavaScript</code></td>
<td><code>.jsx</code>, <code>.js</code></td> <td><code>.jsx</code>, <code>.js</code></td>
<td><a href="https://github.com/prettydiff/prettydiff"><code>Pretty Diff</code></a> (Default)</td> <td><a href="https://github.com/prettydiff/prettydiff"><code>Pretty Diff</code></a> (Default)</td>
</tr> </tr>
@ -424,6 +436,12 @@ Thank you.</p><h2 id="language-support">Language Support</h2><p>See <a href="htt
<td><a href="https://github.com/vvakame/typescript-formatter"><code>TypeScript Formatter</code></a> (Default)</td> <td><a href="https://github.com/vvakame/typescript-formatter"><code>TypeScript Formatter</code></a> (Default)</td>
</tr> </tr>
<tr> <tr>
<td>UX Markup</td>
<td><code>UX</code></td>
<td><code>.ux</code></td>
<td><a href="https://github.com/prettydiff/prettydiff"><code>Pretty Diff</code></a> (Default)</td>
</tr>
<tr>
<td>Vala</td> <td>Vala</td>
<td><code>Vala</code></td> <td><code>Vala</code></td>
<td><code>.vala</code>, <code>.vapi</code></td> <td><code>.vala</code>, <code>.vapi</code></td>

123
docs/code/file/src/beautifiers/bash-beautify.coffee.html Normal file
View File

@ -0,0 +1,123 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>beautifiers</span>
&raquo;
<span class='title'>bash-beautify.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
bash-beautify.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers</td>
</tr>
<tr>
<td>
Classes:
</td>
<td>
<a href='../../../class/BashBeautify.html'>
BashBeautify
</a>
</td>
</tr>
</table>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

123
docs/code/file/src/beautifiers/beautifysh.coffee.html Normal file
View File

@ -0,0 +1,123 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>beautifiers</span>
&raquo;
<span class='title'>beautifysh.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
beautifysh.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers</td>
</tr>
<tr>
<td>
Classes:
</td>
<td>
<a href='../../../class/BashBeautify.html'>
BashBeautify
</a>
</td>
</tr>
</table>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

125
docs/code/file/src/beautifiers/cljfmt/index.coffee.html Normal file
View File

@ -0,0 +1,125 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../../javascript/application.js'></script>
<script src='../../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>beautifiers</span>
&raquo;
<span class='title'>cljfmt</span>
&raquo;
<span class='title'>index.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
index.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;beautifiers&#47;cljfmt</td>
</tr>
<tr>
<td>
Classes:
</td>
<td>
<a href='../../../../class/Cljfmt.html'>
Cljfmt
</a>
</td>
</tr>
</table>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

144
docs/code/file/src/languages/bash.coffee.html Normal file
View File

@ -0,0 +1,144 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>languages</span>
&raquo;
<span class='title'>bash.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
bash.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;languages</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='module.exports-variable'>
module.exports
=
</dt>
<dd>
<pre><code class='coffeescript'>{
name: &quot;Bash&quot;,
namespace: &quot;bash&quot;,
&#47;*
Supported Grammars
*&#47;
grammars: [&quot;Shell script&quot;],
&#47;*
Supported extensions
*&#47;
extensions: [&quot;bash&quot;, &quot;sh&quot;],
options: {
configPath: {
type: &#39;string&#39;,
&quot;default&quot;: &quot;&quot;,
description: &quot;Path to uncrustify config file. i.e. uncrustify.cfg&quot;
}
}
}</code></pre>
</dd>
</dl>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

138
docs/code/file/src/languages/clojure.coffee.html Normal file
View File

@ -0,0 +1,138 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>languages</span>
&raquo;
<span class='title'>clojure.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
clojure.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;languages</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='module.exports-variable'>
module.exports
=
</dt>
<dd>
<pre><code class='coffeescript'>{
name: &quot;Clojure&quot;,
namespace: &quot;clj&quot;,
&#47;*
Supported Grammars
*&#47;
grammars: [&quot;Clojure&quot;],
&#47;*
Supported extensions
*&#47;
extensions: [&#39;clj&#39;, &#39;cljs&#39;, &#39;edn&#39;],
defaultBeautifier: &quot;cljfmt&quot;
}</code></pre>
</dd>
</dl>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

2
docs/code/file/src/languages/jsx.coffee.html
View File

@ -52,7 +52,7 @@
&#47;* &#47;*
Supported Grammars Supported Grammars
*&#47; *&#47;
grammars: [&quot;JSX&quot;, &quot;JavaScript (JSX)&quot;], grammars: [&quot;JSX&quot;, &quot;JavaScript (JSX)&quot;, &quot;Babel ES6 JavaScript&quot;],
&#47;* &#47;*
Supported extensions Supported extensions

139
docs/code/file/src/languages/ux_markup.coffee.html Normal file
View File

@ -0,0 +1,139 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Atom-Beautify Documentation</title>
<script src='../../../javascript/application.js'></script>
<script src='../../../javascript/search.js'></script>
<link rel='stylesheet' href='../../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../../extra/README.md.html' title='Atom-Beautify'>
Atom-Beautify
</a>
&raquo;
<a href='../../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>src</span>
&raquo;
<span class='title'>languages</span>
&raquo;
<span class='title'>ux_markup.coffee</span>
</div>
</div>
<div id='content'>
<h1>
File:
ux_markup.coffee
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src&#47;languages</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='module.exports-variable'>
module.exports
=
</dt>
<dd>
<pre><code class='coffeescript'>{
name: &quot;UX Markup&quot;,
namespace: &quot;ux&quot;,
fallback: [&#39;html&#39;],
&#47;*
Supported Grammars
*&#47;
grammars: [&quot;UX&quot;],
&#47;*
Supported extensions
*&#47;
extensions: [&quot;ux&quot;],
defaultBeautifier: &quot;Pretty Diff&quot;
}</code></pre>
</dd>
</dl>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>

48
docs/code/file_list.html
View File

@ -57,6 +57,14 @@
src&#47;beautifiers src&#47;beautifiers
</small> </small>
</li> </li>
<li>
<a href='file/src/beautifiers/beautifysh.coffee.html' target='main'>
beautifysh.coffee
</a>
<small class='namespace'>
src&#47;beautifiers
</small>
</li>
<li> <li>
<a href='file/src/beautifiers/clang-format.coffee.html' target='main'> <a href='file/src/beautifiers/clang-format.coffee.html' target='main'>
clang-format.coffee clang-format.coffee
@ -65,6 +73,22 @@
src&#47;beautifiers src&#47;beautifiers
</small> </small>
</li> </li>
<li>
<span>
cljfmt
</span>
</li>
<ul>
<li>
<a href='file/src/beautifiers/cljfmt/index.coffee.html' target='main'>
index.coffee
</a>
<small class='namespace'>
src&#47;beautifiers&#47;cljfmt
</small>
</li>
</ul>
<li> <li>
<a href='file/src/beautifiers/coffee-fmt.coffee.html' target='main'> <a href='file/src/beautifiers/coffee-fmt.coffee.html' target='main'>
coffee-fmt.coffee coffee-fmt.coffee
@ -441,6 +465,14 @@
src&#47;languages src&#47;languages
</small> </small>
</li> </li>
<li>
<a href='file/src/languages/bash.coffee.html' target='main'>
bash.coffee
</a>
<small class='namespace'>
src&#47;languages
</small>
</li>
<li> <li>
<a href='file/src/languages/c-sharp.coffee.html' target='main'> <a href='file/src/languages/c-sharp.coffee.html' target='main'>
c-sharp.coffee c-sharp.coffee
@ -457,6 +489,14 @@
src&#47;languages src&#47;languages
</small> </small>
</li> </li>
<li>
<a href='file/src/languages/clojure.coffee.html' target='main'>
clojure.coffee
</a>
<small class='namespace'>
src&#47;languages
</small>
</li>
<li> <li>
<a href='file/src/languages/coffeescript.coffee.html' target='main'> <a href='file/src/languages/coffeescript.coffee.html' target='main'>
coffeescript.coffee coffeescript.coffee
@ -857,6 +897,14 @@
src&#47;languages src&#47;languages
</small> </small>
</li> </li>
<li>
<a href='file/src/languages/ux_markup.coffee.html' target='main'>
ux_markup.coffee
</a>
<small class='namespace'>
src&#47;languages
</small>
</li>
<li> <li>
<a href='file/src/languages/vala.coffee.html' target='main'> <a href='file/src/languages/vala.coffee.html' target='main'>
vala.coffee vala.coffee

2
docs/code/javascript/search.js
View File

File diff suppressed because one or more lines are too long

282
docs/code/method_list.html
View File

@ -38,11 +38,75 @@
</small> </small>
</li> </li>
<li> <li>
<a href='class/Gofmt.html#beautify-dynamic' target='main' title='beautify'> <a href='class/Beautifiers.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
</a> </a>
<small> <small>
(Gofmt) (Beautifiers)
</small>
</li>
<li>
<a href='class/PuppetFix.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PuppetFix)
</small>
</li>
<li>
<a href='class/PugBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PugBeautify)
</small>
</li>
<li>
<a href='file/src/beautify.coffee.html#beautify-' target='main' title='beautify'>
~beautify
</a>
<small>
(src&#47;beautify.coffee)
</small>
</li>
<li>
<a href='class/PrettyDiff.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PrettyDiff)
</small>
</li>
<li>
<a href='class/PHPCBF.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PHPCBF)
</small>
</li>
<li>
<a href='class/PHPCSFixer.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PHPCSFixer)
</small>
</li>
<li>
<a href='class/PerlTidy.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PerlTidy)
</small>
</li>
<li>
<a href='class/Autopep8.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Autopep8)
</small> </small>
</li> </li>
<li> <li>
@ -54,11 +118,11 @@
</small> </small>
</li> </li>
<li> <li>
<a href='file/src/beautify.coffee.html#beautify-' target='main' title='beautify'> <a href='class/Remark.html#beautify-dynamic' target='main' title='beautify'>
~beautify #beautify
</a> </a>
<small> <small>
(src&#47;beautify.coffee) (Remark)
</small> </small>
</li> </li>
<li> <li>
@ -86,19 +150,11 @@
</small> </small>
</li> </li>
<li> <li>
<a href='class/Rustfmt.html#beautify-dynamic' target='main' title='beautify'> <a href='class/Rubocop.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
</a> </a>
<small> <small>
(Rustfmt) (Rubocop)
</small>
</li>
<li>
<a href='class/Autopep8.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Autopep8)
</small> </small>
</li> </li>
<li> <li>
@ -109,14 +165,6 @@
(JSCSFixer) (JSCSFixer)
</small> </small>
</li> </li>
<li>
<a href='class/RubyBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(RubyBeautify)
</small>
</li>
<li> <li>
<a href='class/JSBeautify.html#beautify-dynamic' target='main' title='beautify'> <a href='class/JSBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
@ -125,54 +173,6 @@
(JSBeautify) (JSBeautify)
</small> </small>
</li> </li>
<li>
<a href='class/PHPCSFixer.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PHPCSFixer)
</small>
</li>
<li>
<a href='class/Rubocop.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Rubocop)
</small>
</li>
<li>
<a href='class/SassConvert.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(SassConvert)
</small>
</li>
<li>
<a href='class/PHPCBF.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PHPCBF)
</small>
</li>
<li>
<a href='class/PrettyDiff.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PrettyDiff)
</small>
</li>
<li>
<a href='class/PugBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PugBeautify)
</small>
</li>
<li> <li>
<a href='class/Yapf.html#beautify-dynamic' target='main' title='beautify'> <a href='class/Yapf.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
@ -182,19 +182,35 @@
</small> </small>
</li> </li>
<li> <li>
<a href='class/Sqlformat.html#beautify-dynamic' target='main' title='beautify'> <a href='class/VueBeautifier.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
</a> </a>
<small> <small>
(Sqlformat) (VueBeautifier)
</small> </small>
</li> </li>
<li> <li>
<a href='class/StylishHaskell.html#beautify-dynamic' target='main' title='beautify'> <a href='class/RubyBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
</a> </a>
<small> <small>
(StylishHaskell) (RubyBeautify)
</small>
</li>
<li>
<a href='class/BashBeautify.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(BashBeautify)
</small>
</li>
<li>
<a href='class/Rustfmt.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Rustfmt)
</small> </small>
</li> </li>
<li> <li>
@ -205,6 +221,14 @@
(ClangFormat) (ClangFormat)
</small> </small>
</li> </li>
<li>
<a href='class/Cljfmt.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Cljfmt)
</small>
</li>
<li> <li>
<a href='class/CoffeeFmt.html#beautify-dynamic' target='main' title='beautify'> <a href='class/CoffeeFmt.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
@ -286,11 +310,11 @@
</small> </small>
</li> </li>
<li> <li>
<a href='class/Beautifiers.html#beautify-dynamic' target='main' title='beautify'> <a href='class/Gofmt.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
</a> </a>
<small> <small>
(Beautifiers) (Gofmt)
</small> </small>
</li> </li>
<li> <li>
@ -301,6 +325,30 @@
(HTMLBeautifier) (HTMLBeautifier)
</small> </small>
</li> </li>
<li>
<a href='class/SassConvert.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(SassConvert)
</small>
</li>
<li>
<a href='class/Sqlformat.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Sqlformat)
</small>
</li>
<li>
<a href='class/StylishHaskell.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(StylishHaskell)
</small>
</li>
<li> <li>
<a href='class/TidyMarkdown.html#beautify-dynamic' target='main' title='beautify'> <a href='class/TidyMarkdown.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
@ -317,14 +365,6 @@
(TypeScriptFormatter) (TypeScriptFormatter)
</small> </small>
</li> </li>
<li>
<a href='class/Remark.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(Remark)
</small>
</li>
<li> <li>
<a href='class/Uncrustify.html#beautify-dynamic' target='main' title='beautify'> <a href='class/Uncrustify.html#beautify-dynamic' target='main' title='beautify'>
#beautify #beautify
@ -333,30 +373,6 @@
(Uncrustify) (Uncrustify)
</small> </small>
</li> </li>
<li>
<a href='class/PuppetFix.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PuppetFix)
</small>
</li>
<li>
<a href='class/VueBeautifier.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(VueBeautifier)
</small>
</li>
<li>
<a href='class/PerlTidy.html#beautify-dynamic' target='main' title='beautify'>
#beautify
</a>
<small>
(PerlTidy)
</small>
</li>
<li> <li>
<a href='file/src/beautify.coffee.html#beautifyDirectory-' target='main' title='beautifyDirectory'> <a href='file/src/beautify.coffee.html#beautifyDirectory-' target='main' title='beautifyDirectory'>
~beautifyDirectory ~beautifyDirectory
@ -397,14 +413,6 @@
(MessageView) (MessageView)
</small> </small>
</li> </li>
<li>
<a href='class/PerlTidy.html#cli-dynamic' target='main' title='cli'>
#cli
</a>
<small>
(PerlTidy)
</small>
</li>
<li> <li>
<a href='class/PuppetFix.html#cli-dynamic' target='main' title='cli'> <a href='class/PuppetFix.html#cli-dynamic' target='main' title='cli'>
#cli #cli
@ -413,6 +421,14 @@
(PuppetFix) (PuppetFix)
</small> </small>
</li> </li>
<li>
<a href='class/PerlTidy.html#cli-dynamic' target='main' title='cli'>
#cli
</a>
<small>
(PerlTidy)
</small>
</li>
<li> <li>
<a href='class/MessageView.html#close-dynamic' target='main' title='close'> <a href='class/MessageView.html#close-dynamic' target='main' title='close'>
#close #close
@ -437,14 +453,6 @@
(MessageView) (MessageView)
</small> </small>
</li> </li>
<li>
<a href='class/Beautifier.html#constructor-dynamic' target='main' title='constructor'>
#constructor
</a>
<small>
(Beautifier)
</small>
</li>
<li> <li>
<a href='class/Beautifiers.html#constructor-dynamic' target='main' title='constructor'> <a href='class/Beautifiers.html#constructor-dynamic' target='main' title='constructor'>
#constructor #constructor
@ -453,6 +461,14 @@
(Beautifiers) (Beautifiers)
</small> </small>
</li> </li>
<li>
<a href='class/Beautifier.html#constructor-dynamic' target='main' title='constructor'>
#constructor
</a>
<small>
(Beautifier)
</small>
</li>
<li> <li>
<a href='class/MessageView.html#content-static' target='main' title='content'> <a href='class/MessageView.html#content-static' target='main' title='content'>
.content .content
@ -517,14 +533,6 @@
(Beautifiers) (Beautifiers)
</small> </small>
</li> </li>
<li>
<a href='class/Beautifier.html#findFile-dynamic' target='main' title='findFile'>
#findFile
</a>
<small>
(Beautifier)
</small>
</li>
<li> <li>
<a href='class/Beautifiers.html#findFile-dynamic' target='main' title='findFile'> <a href='class/Beautifiers.html#findFile-dynamic' target='main' title='findFile'>
#findFile #findFile
@ -533,6 +541,14 @@
(Beautifiers) (Beautifiers)
</small> </small>
</li> </li>
<li>
<a href='class/Beautifier.html#findFile-dynamic' target='main' title='findFile'>
#findFile
</a>
<small>
(Beautifier)
</small>
</li>
<li> <li>
<a href='class/Beautifiers.html#getBeautifierForLanguage-dynamic' target='main' title='getBeautifierForLanguage'> <a href='class/Beautifiers.html#getBeautifierForLanguage-dynamic' target='main' title='getBeautifierForLanguage'>
#getBeautifierForLanguage #getBeautifierForLanguage

121
docs/options.md
View File

@ -319,6 +319,100 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
} }
``` ```
#### [Bash](#bash)
**Supported Beautifiers**: [`beautysh`](#beautysh)
| Option | beautysh |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Bash
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Bash Beautification
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
##### [Default Beautifier](#default-beautifier)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `beautysh`
**Type**: `string`
**Enum**: `beautysh`
**Description**:
Default Beautifier to be used for Bash
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
##### [Beautify On Save](#beautify-on-save)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Automatically beautify Bash files on save
**How to Configure**
1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*.
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Config Path](#config-path)
**Namespace**: `bash`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`beautysh`](#beautysh)
**Description**:
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by beautysh)
**Example `.jsbeautifyrc` Configuration**
```json
{
"bash": {
"configPath": ""
}
}
```
#### [C](#c) #### [C](#c)
**Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`clang-format`](#clang-format) **Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`clang-format`](#clang-format)
@ -16877,6 +16971,33 @@ sort imports (requires isort installed) (Supported by autopep8)
``` ```
### beautysh
##### [Config Path](#config-path)
**Namespace**: `bash`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`beautysh`](#beautysh)
**Description**:
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by beautysh)
**Example `.jsbeautifyrc` Configuration**
```json
{
"bash": {
"configPath": ""
}
}
```
### coffee-fmt ### coffee-fmt
##### [Indent size](#indent-size) ##### [Indent size](#indent-size)

11
examples/beautysh/bash/expected/netinfo.sh Normal file
View File

@ -0,0 +1,11 @@
# Displays information about the network configuration
netinfo() {
printf '--------------- Network Information ---------------\n'
/sbin/ifconfig | awk /'inet addr/ {print $2}'
/sbin/ifconfig | awk /'Bcast/ {print $3}'
/sbin/ifconfig | awk /'inet addr/ {print $4}'
/sbin/ifconfig | awk /'HWaddr/ {print $4,$5}'
myIP =$(wget -qO- http://ipecho.net/plain)
printf 'Public: %s\n' "$myIP"
printf '---------------------------------------------------'
}

11
examples/beautysh/bash/original/netinfo.sh Normal file
View File

@ -0,0 +1,11 @@
# Displays information about the network configuration
netinfo() {
printf '--------------- Network Information ---------------\n'
/sbin/ifconfig | awk /'inet addr/ {print $2}'
/sbin/ifconfig | awk /'Bcast/ {print $3}'
/sbin/ifconfig | awk /'inet addr/ {print $4}'
/sbin/ifconfig | awk /'HWaddr/ {print $4,$5}'
myIP =$(wget -qO- http://ipecho.net/plain)
printf 'Public: %s\n' "$myIP"
printf '---------------------------------------------------'
}

4
package.json
View File

@ -284,7 +284,9 @@
"clojure beautifier", "clojure beautifier",
"nunjucks", "nunjucks",
"ux markup", "ux markup",
"cljfmt" "cljfmt",
"bash",
"beautysh"
], ],
"devDependencies": { "devDependencies": {
"coffeelint": "^1.10.1", "coffeelint": "^1.10.1",

2
script/build-options.js
View File

@ -11,6 +11,8 @@ _plus = require('underscore-plus');
require("coffee-script/register"); require("coffee-script/register");
logger = require('../src/logger')(__filename)
Beautifiers = require("../src/beautifiers"); Beautifiers = require("../src/beautifiers");
buildOptionsForBeautifiers = function(beautifiers, allLanguages) { buildOptionsForBeautifiers = function(beautifiers, allLanguages) {

14
src/beautifiers/beautysh.coffee Normal file
View File

@ -0,0 +1,14 @@
"use strict"
Beautifier = require('./beautifier')
module.exports = class BashBeautify extends Beautifier
name: "beautysh"
link: "https://github.com/bemeurer/beautysh"
options: {
Bash: true
}
beautify: (text, language, options) ->
file = @tempFile("input", text)
@run('beautysh', [ file ], help: { link: "https://github.com/bemeurer/beautysh" })
.then(=> @readFile file)

1
src/beautifiers/index.coffee
View File

@ -73,6 +73,7 @@ module.exports = class Beautifiers extends EventEmitter
'erl_tidy' 'erl_tidy'
'marko-beautifier' 'marko-beautifier'
'formatR' 'formatR'
'beautysh'
] ]
### ###

29
src/languages/bash.coffee Normal file
View File

@ -0,0 +1,29 @@
module.exports = {
name: "Bash"
namespace: "bash"
###
Supported Grammars
###
grammars: [
"Shell script"
]
defaultBeautifier: "beautysh"
###
Supported extensions
###
extensions: [
"bash"
"sh"
]
options:
configPath:
type: 'string'
default: ""
description: "Path to uncrustify config file. i.e. uncrustify.cfg"
}

1
src/languages/index.coffee
View File

@ -14,6 +14,7 @@ module.exports = class Languages
languageNames: [ languageNames: [
"apex" "apex"
"arduino" "arduino"
"bash"
"c-sharp" "c-sharp"
"c" "c"
"clojure" "clojure"