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

Created Add an unsupported language using an existing beautifier (markdown)

Austin Cheney 2015-09-08 21:05:57 -05:00
parent f244f8904d
commit 913006e549
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Add-an-unsupported-language-using-an-existing-beautifier.md Normal file

@ -0,0 +1,5 @@
1. Add the language to Atom Beautify. Read How to add a Language in https://github.com/Glavin001/atom-beautify/blob/master/docs/add-languages-and-beautifiers.md#how-to-add-a-language for details.
2. Add the chosen language support to your chosen beautifier. See https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/prettydiff.coffee#L30 for an example of Pretty Diff's beautifier code. You can simply add yourLanguageName: true and Atom Beautify will see that the Pretty Diff beautifier supports that language.
3. Determine which of the selected beautifier's supported languages works best for your chosen language. Go to the beautifier's website and play around with the supported options.
4. Properly handle the language and select the best options to use. Go to https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/prettydiff.coffee#L57-L91 (using Pretty Diff as an example) and add the language that you found worked best on http://prettydiff.com/ (that beautifier's website).
5. Read How to add a Beautifier for a Language step 4 for instructions on how to add test files. I insist that a simple test be added for a Pull Request to be merged :wink:.