diff --git a/docs/index.coffee b/docs/index.coffee index afbba77..b3218f9 100755 --- a/docs/index.coffee +++ b/docs/index.coffee @@ -1,3 +1,4 @@ + #!/usr/bin/env coffee # Dependencies @@ -11,7 +12,10 @@ pkg = require('../package.json') console.log('Generating options...') beautifier = new Beautifiers() languageOptions = beautifier.options +executableOptions = languageOptions.executables +delete languageOptions.executables packageOptions = require('../src/config.coffee') +packageOptions.executables = executableOptions # Build options by Beautifier beautifiersMap = _.keyBy(beautifier.beautifiers, 'name') languagesMap = _.keyBy(beautifier.languages.languages, 'name') diff --git a/docs/options.md b/docs/options.md index 440358c..a760c8c 100644 --- a/docs/options.md +++ b/docs/options.md @@ -124,13 +124,6 @@ Show loading view when beautifying 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Show Loading View*" and change it to your desired configuration. - -## Language Options - -Supported options for each language. - ---- - #### [Executables](#executables) **Description**: @@ -139,14 +132,10 @@ Configure executables used by beautifiers. ##### [Rscript](#rscript) -**Namespace**: `` - -**Key**: `Rscript` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`formatR`](#formatr) - **Description**: Options for Rscript executable. @@ -160,14 +149,10 @@ Options for Rscript executable. ##### [Emacs](#emacs) -**Namespace**: `` - -**Key**: `emacs` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) - **Description**: Options for Emacs executable. @@ -181,14 +166,10 @@ Options for Emacs executable. ##### [PHP](#php) -**Namespace**: `` - -**Key**: `php` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) - **Description**: Options for PHP executable. @@ -202,14 +183,10 @@ Options for PHP executable. ##### [PHP-CS-Fixer](#php-cs-fixer) -**Namespace**: `` - -**Key**: `php-cs-fixer` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) - **Description**: Options for PHP-CS-Fixer executable. @@ -223,14 +200,10 @@ Options for PHP-CS-Fixer executable. ##### [PHPCBF](#phpcbf) -**Namespace**: `` - -**Key**: `phpcbf` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) - **Description**: Options for PHPCBF executable. @@ -244,14 +217,10 @@ Options for PHPCBF executable. ##### [Uncrustify](#uncrustify) -**Namespace**: `` - -**Key**: `uncrustify` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `object` -**Supported Beautifiers**: [`Uncrustify`](#uncrustify) - **Description**: Options for Uncrustify executable. @@ -263,6 +232,13 @@ Options for Uncrustify executable. 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Uncrustify*" and change it to your desired configuration. + +## Language Options + +Supported options for each language. + +--- + #### [Apex](#apex) **Supported Beautifiers**: [`Uncrustify`](#uncrustify) @@ -15915,27 +15891,6 @@ Path to the emacs script (Supported by Fortran Beautifier) } ``` -##### [Emacs](#emacs) - -**Namespace**: `` - -**Key**: `emacs` - -**Type**: `object` - -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) - -**Description**: - -Options for Emacs executable. - -**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 "*Emacs*" and change it to your desired configuration. - ### Gherkin formatter @@ -17771,48 +17726,6 @@ Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer } ``` -##### [PHP](#php) - -**Namespace**: `` - -**Key**: `php` - -**Type**: `object` - -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) - -**Description**: - -Options for PHP executable. - -**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 "*PHP*" and change it to your desired configuration. - -##### [PHP-CS-Fixer](#php-cs-fixer) - -**Namespace**: `` - -**Key**: `php-cs-fixer` - -**Type**: `object` - -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) - -**Description**: - -Options for PHP-CS-Fixer executable. - -**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 "*PHP-CS-Fixer*" and change it to your desired configuration. - ### PHPCBF @@ -17894,27 +17807,6 @@ Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS ru } ``` -##### [PHPCBF](#phpcbf) - -**Namespace**: `` - -**Key**: `phpcbf` - -**Type**: `object` - -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) - -**Description**: - -Options for PHPCBF executable. - -**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 "*PHPCBF*" and change it to your desired configuration. - ### Perltidy @@ -19093,27 +18985,6 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) } ``` -##### [Uncrustify](#uncrustify) - -**Namespace**: `` - -**Key**: `uncrustify` - -**Type**: `object` - -**Supported Beautifiers**: [`Uncrustify`](#uncrustify) - -**Description**: - -Options for Uncrustify executable. - -**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 "*Uncrustify*" and change it to your desired configuration. - ### Vue Beautifier @@ -20228,27 +20099,6 @@ Indentation size/length (Supported by formatR) } ``` -##### [Rscript](#rscript) - -**Namespace**: `` - -**Key**: `Rscript` - -**Type**: `object` - -**Supported Beautifiers**: [`formatR`](#formatr) - -**Description**: - -Options for Rscript executable. - -**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 "*Rscript*" and change it to your desired configuration. - ### pybeautifier diff --git a/script/build-options.js b/script/build-options.js index 0bd8e6e..77c92b8 100644 --- a/script/build-options.js +++ b/script/build-options.js @@ -192,7 +192,7 @@ buildOptionsForExecutables = function(beautifiers) { type: "object", collapsed: true, description: `Options for ${name} executable.`, - beautifiers, + // beautifiers, properties: { path: { key: "path", diff --git a/src/options.json b/src/options.json index d07cd40..cd66dbc 100644 --- a/src/options.json +++ b/src/options.json @@ -9136,9 +9136,6 @@ "type": "object", "collapsed": true, "description": "Options for Uncrustify executable.", - "beautifiers": [ - "Uncrustify" - ], "properties": { "path": { "key": "path", @@ -9155,9 +9152,6 @@ "type": "object", "collapsed": true, "description": "Options for Emacs executable.", - "beautifiers": [ - "Fortran Beautifier" - ], "properties": { "path": { "key": "path", @@ -9174,9 +9168,6 @@ "type": "object", "collapsed": true, "description": "Options for PHP executable.", - "beautifiers": [ - "PHP-CS-Fixer" - ], "properties": { "path": { "key": "path", @@ -9193,9 +9184,6 @@ "type": "object", "collapsed": true, "description": "Options for PHP-CS-Fixer executable.", - "beautifiers": [ - "PHP-CS-Fixer" - ], "properties": { "path": { "key": "path", @@ -9212,9 +9200,6 @@ "type": "object", "collapsed": true, "description": "Options for PHPCBF executable.", - "beautifiers": [ - "PHPCBF" - ], "properties": { "path": { "key": "path", @@ -9231,9 +9216,6 @@ "type": "object", "collapsed": true, "description": "Options for Rscript executable.", - "beautifiers": [ - "formatR" - ], "properties": { "path": { "key": "path",