Merge branch 'nathdwek-fix-python-typo'

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Next
+- Breaking change to `pybeautifier`: Fix typo, change `formater` to `formatter`. See [#1898](https://github.com/Glavin001/atom-beautify/pull/1898).
 - Fixes [#1773](https://github.com/Glavin001/atom-beautify/issues/1773) and [#793](https://github.com/Glavin001/atom-beautify/issues/793). ruby-beautify with Rubocop now respects `Exclude` settings, and properly loads inherited config files (like `~/.rubocop.yml`)
 - Fix [#1862](https://github.com/Glavin001/atom-beautify/issues/1862) Add support for ocp-indent as an executable
 - See [#601](https://github.com/Glavin001/atom-beautify/issues/1862) Add support for tsx files

docs/options.md

@@ -9974,7 +9974,7 @@ Automatically beautify Puppet files on save
 | `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
-| `formater` | :white_check_mark: | :white_check_mark: | :x: |
+| `formatter` | :white_check_mark: | :white_check_mark: | :x: |
 | `ignore` | :white_check_mark: | :white_check_mark: | :x: |
 | `indent_size` | :white_check_mark: | :white_check_mark: | :x: |
 | `max_line_length` | :white_check_mark: | :white_check_mark: | :x: |
@@ -10041,11 +10041,11 @@ Automatically beautify Python files on save
 2. Go into *Packages* and search for "*Atom Beautify*" package.
 3. Find the option "*Beautify On Save*" and change it to your desired configuration.
 
-#####  [Formater](#formater) 
+#####  [Formatter](#formatter) 
 
 **Namespace**: `python`
 
-**Key**: `formater`
+**Key**: `formatter`
 
 **Default**: `autopep8`
 
@@ -10064,7 +10064,7 @@ formatter used by pybeautifier (Supported by autopep8, pybeautifier)
 ```json
 {
     "python": {
-        "formater": "autopep8"
+        "formatter": "autopep8"
     }
 }
 ```
@@ -18645,11 +18645,11 @@ do not fix these errors/warnings (Supported by autopep8, pybeautifier)
 }
 ```
 
-#####  [Formater](#formater) 
+#####  [Formatter](#formatter) 
 
 **Namespace**: `python`
 
-**Key**: `formater`
+**Key**: `formatter`
 
 **Default**: `autopep8`
 
@@ -18668,7 +18668,7 @@ formatter used by pybeautifier (Supported by autopep8, pybeautifier)
 ```json
 {
     "python": {
-        "formater": "autopep8"
+        "formatter": "autopep8"
     }
 }
 ```
@@ -18998,11 +18998,11 @@ do not fix these errors/warnings (Supported by autopep8, pybeautifier)
 }
 ```
 
-#####  [Formater](#formater) 
+#####  [Formatter](#formatter) 
 
 **Namespace**: `python`
 
-**Key**: `formater`
+**Key**: `formatter`
 
 **Default**: `autopep8`
 
@@ -19021,7 +19021,7 @@ formatter used by pybeautifier (Supported by autopep8, pybeautifier)
 ```json
 {
     "python": {
-        "formater": "autopep8"
+        "formatter": "autopep8"
     }
 }
 ```

src/beautifiers/pybeautifier.coffee

@@ -14,7 +14,7 @@ MULTI_LINE_OUTPUT_TABLE = {
   'NOQA': 6
 }
 
-format = (data, formaters) ->
+format = (data, formatters) ->
   return new Promise (resolve, reject) ->
     client = new net.Socket()
     client.on 'error', (error) ->
@@ -22,7 +22,7 @@ format = (data, formaters) ->
       reject(error)
     client.connect PORT, HOST, ->
       client.setEncoding('utf8')
-      client.write(JSON.stringify({'data': data, 'formaters': formaters}))
+      client.write(JSON.stringify({'data': data, 'formatters': formatters}))
       response = ''
       client.on 'data', (chunk) ->
         response += chunk
@@ -45,22 +45,22 @@ module.exports = class PythonBeautifier extends Beautifier
   }
 
   beautify: (text, language, options) ->
-    formater = {'name': options.formater}
-    if options.formater == 'autopep8'
-      formater.config = {
+    formatter = {'name': options.formatter}
+    if options.formatter == 'autopep8'
+      formatter.config = {
         'ignore': options.ignore
         'max_line_length': options.max_line_length
       }
-    else if options.formater == 'yapf'
-      formater.config = {'style_config': options.style_config}
-    formaters = [formater]
+    else if options.formatter == 'yapf'
+      formatter.config = {'style_config': options.style_config}
+    formatters = [formatter]
     if options.sort_imports
       multi_line_output = MULTI_LINE_OUTPUT_TABLE[options.multi_line_output]
-      formaters.push
+      formatters.push
         'name': 'isort'
         'config': {'multi_line_output': multi_line_output}
     return new @Promise (resolve, reject) ->
-      format(text, formaters)
+      format(text, formatters)
       .then (data) ->
         resolve(data)
       .catch (error) ->

src/languages/python.coffee

@@ -34,7 +34,7 @@ module.exports = {
       items:
         type: 'string'
       description: "do not fix these errors/warnings"
-    formater:
+    formatter:
       type: 'string'
       default: 'autopep8'
       enum: ['autopep8', 'yapf']

src/options.json

@@ -5925,7 +5925,7 @@
           "namespace": "python"
         }
       },
-      "formater": {
+      "formatter": {
         "type": "string",
         "default": "autopep8",
         "enum": [
@@ -5933,12 +5933,12 @@
           "yapf"
         ],
         "description": "formatter used by pybeautifier (Supported by autopep8, pybeautifier)",
-        "title": "Formater",
+        "title": "Formatter",
         "beautifiers": [
           "autopep8",
           "pybeautifier"
         ],
-        "key": "formater",
+        "key": "formatter",
         "language": {
           "name": "Python",
           "namespace": "python"