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

See #282. Update README for new options and language requirements

This commit is contained in:
Glavin Wiechert 2015-05-02 20:25:04 -03:00
parent 48af4a3ff6
commit 20ff7e2d1b
2 changed files with 11 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE.md
View File

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2014 Donald Pipowitch
Copyright (c) 2015 Glavin Wiechert
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the

61
README.md
View File

@ -2,8 +2,7 @@
[![Build Status](https://travis-ci.org/Glavin001/atom-beautify.svg?branch=master)](https://travis-ci.org/Glavin001/atom-beautify)
[![Gitter chat](https://badges.gitter.im/Glavin001/atom-beautify.svg)](https://gitter.im/Glavin001/atom-beautify)
[![Issue Stats](http://issuestats.com/github/glavin001/atom-beautify/badge/pr?style=flat)](http://issuestats.com/github/glavin001/atom-beautify)
[![Issue Stats](http://issuestats.com/github/glavin001/atom-beautify/badge/issue?style=flat)](http://issuestats.com/github/glavin001/atom-beautify)
[![donate](http://img.shields.io/gratipay/Glavin001.svg)](https://gratipay.com/Glavin001/)
> [Beautify](https://github.com/einars/js-beautify)
HTML (including [Handlebars](http://handlebarsjs.com/)),
@ -18,20 +17,6 @@ apm install atom-beautify
Or Settings/Preferences ➔ Packages ➔ Search for `atom-beautify`
## Donations [![donate](http://img.shields.io/gratipay/Glavin001.svg)](https://gratipay.com/Glavin001/)
Looking at the list of issues on Atom Beautify, at the time of writing this, there are 51 open and 155 closed.
I see and strongly feel that Atom Beautify needs a more love than I currently have allocated time to give it, after work, school, and family.
I am now accepting donations to support the development of Atom Beautify.
Being the [sole maintainer of Atom Beautify, I](https://github.com/Glavin001) thank you very much for any support and for using Atom Beautify.
These donations will help me continue with my contributions to the community while providing me with some much needed financial support for living expenses and my education.
You can donate at https://gratipay.com/Glavin001/
Thank you. [Glavin Wiechert](https://github.com/Glavin001)
## Language Support
- [x] JavaScript and JSON
@ -48,9 +33,9 @@ Thank you. [Glavin Wiechert](https://github.com/Glavin001)
- [LESS](http://lesscss.org/)
- [x] [SQL](https://github.com/Glavin001/atom-beautify/pull/67)
- Requires [python-sqlparse](https://github.com/andialbrecht/sqlparse)
- [x] [Markdown](https://github.com/Glavin001/atom-beautify/issues/93#issuecomment-55642483)
- Requires [Pandoc](http://johnmacfarlane.net/pandoc/) to be already installed
- [X] [Perl](https://github.com/Glavin001/atom-beautify/issues/33)
- [x] [Markdown](https://github.com/Glavin001/atom-beautify/issues/292)
- [x] [Perl](https://github.com/Glavin001/atom-beautify/issues/33)
- Requires [perltidy](http://perltidy.sourceforge.net/)
- [x] [PHP](https://github.com/donaldpipowitch/atom-beautify/issues/26)
- Requires [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to be already installed.
- [x] [Python](https://github.com/donaldpipowitch/atom-beautify/issues/24)
@ -100,6 +85,11 @@ For example:
### Package Options
Each language and all of their respective beautifier's options
are fully documented in Atom Beautify Package Settings Panel.
There are much too many to document them all here.
Here are a few key options that you may use:
- `beautifyOnSave` (Default *false*)
You can also choose to beautify on every file save.
@ -109,11 +99,6 @@ However, when beautification occurs on save then it will
be forced to beautify the entire file's contents,
not just selected text.
- `disabledLanguages` (Default *empty array*)
An array of Grammar names to disable beautification for.
Note: If using the Atom's Package Settings then an array is
represented as comma-separated string.
- `muteUnsupportedLanguageErrors` (Default *false*)
Mute only *unsupported language* errors.
@ -204,32 +189,6 @@ See [examples/nested-jsbeautifyrc/.jsbeautifyrc](https://github.com/donaldpipowi
}
```
## Advanced Language Setup
### PHP
To use with PHP we require [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
and that you set the `Php cs fixer path` in the package settings.
#### Retrieve the path on Mac & Linux
Run `which php-cs-fixer` in your Terminal.
### Python
To use with Python we require [autopep8](https://github.com/hhatto/autopep8)
and that you set the `Python autopep8 path` in the package settings.
#### Retrieve the path on Mac & Linux
Run `which autopep8` in your Terminal.
### Markdown
To use with Markdown we require [pandoc](http://johnmacfarlane.net/pandoc/)
and you set the `Markdown Pandoc path` in the package settings.
## Contributing
[See all contributors on GitHub](https://github.com/donaldpipowitch/atom-beautify/graphs/contributors).
@ -240,4 +199,4 @@ and submit a [Pull Request on GitHub](https://help.github.com/articles/using-pul
## License
[MIT](https://github.com/donaldpipowitch/atom-beautify/blob/master/LICENSE.md) © [Donald Pipowitch](https://github.com/donaldpipowitch)
[MIT](https://github.com/donaldpipowitch/atom-beautify/blob/master/LICENSE.md) © [Glavin Wiechert](https://github.com/Glavin001)