From 913006e549fbbb68a3e234616617d5c7b5e34cce Mon Sep 17 00:00:00 2001 From: Austin Cheney Date: Tue, 8 Sep 2015 21:05:57 -0500 Subject: [PATCH] Created Add an unsupported language using an existing beautifier (markdown) --- Add-an-unsupported-language-using-an-existing-beautifier.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 Add-an-unsupported-language-using-an-existing-beautifier.md diff --git a/Add-an-unsupported-language-using-an-existing-beautifier.md b/Add-an-unsupported-language-using-an-existing-beautifier.md new file mode 100644 index 0000000..89482bb --- /dev/null +++ b/Add-an-unsupported-language-using-an-existing-beautifier.md @@ -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:.