See #1607. Add support for PHP-CS-Fixer 1, along with version 2.
This commit is contained in:
Glavin Wiechert
parent
45a93451b6
commit
652c0ceb1a
178
docs/options.md
178
docs/options.md
|
|
@ -31,25 +31,6 @@ Unique identifier for this user for tracking usage analytics
|
|||
2. Go into *Packages* and search for "*Atom Beautify*" package.
|
||||
3. Find the option "*Analytics User Id*" and change it to your desired configuration.
|
||||
|
||||
##### [Anonymous Analytics](#anonymous-analytics)
|
||||
|
||||
**Important**: This option is only configurable from within Atom Beautify's setting panel.
|
||||
|
||||
**Default**: `true`
|
||||
|
||||
**Type**: `boolean`
|
||||
|
||||
**Description**:
|
||||
|
||||
[Google Analytics](http://www.google.com/analytics/) is used to track what languages are being used the most and causing the most errors, as well as other stats such as performance. Everything is anonymized and no personal information, such as source code, is sent. See https://github.com/Glavin001/atom-beautify/issues/47 for more details.
|
||||
|
||||
**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 "*Anonymous Analytics*" and change it to your desired configuration.
|
||||
|
||||
##### [Beautify Entire File On Save](#beautify-entire-file-on-save)
|
||||
|
||||
**Important**: This option is only configurable from within Atom Beautify's setting panel.
|
||||
|
|
@ -9590,6 +9571,9 @@ Specify a configuration file which will override the default name of .perltidyrc
|
|||
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||
| `cs_fixer_path` | :white_check_mark: | :x: | :x: |
|
||||
| `cs_fixer_version` | :white_check_mark: | :x: | :x: |
|
||||
| `fixers` | :white_check_mark: | :x: | :x: |
|
||||
| `level` | :white_check_mark: | :x: | :x: |
|
||||
| `phpcbf_path` | :white_check_mark: | :x: | :x: |
|
||||
| `rules` | :white_check_mark: | :x: | :x: |
|
||||
| `standard` | :white_check_mark: | :white_check_mark: | :x: |
|
||||
|
|
@ -9677,6 +9661,82 @@ Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
|
|||
}
|
||||
```
|
||||
|
||||
##### [PHP-CS-Fixer Version](#php-cs-fixer-version)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `cs_fixer_version`
|
||||
|
||||
**Default**: `2`
|
||||
|
||||
**Type**: `integer`
|
||||
|
||||
**Enum**: `1` `2`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
undefined (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"cs_fixer_version": 2
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [Fixers](#fixers)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `fixers`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"fixers": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [Level](#level)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `level`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"level": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [PHPCBF Path](#phpcbf-path)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
|
@ -9713,7 +9773,7 @@ Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
|
|||
|
||||
**Description**:
|
||||
|
||||
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (Supported by PHP-CS-Fixer)
|
||||
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
|
|
@ -17261,6 +17321,82 @@ Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
|
|||
}
|
||||
```
|
||||
|
||||
##### [PHP-CS-Fixer Version](#php-cs-fixer-version)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `cs_fixer_version`
|
||||
|
||||
**Default**: `2`
|
||||
|
||||
**Type**: `integer`
|
||||
|
||||
**Enum**: `1` `2`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
undefined (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"cs_fixer_version": 2
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [Fixers](#fixers)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `fixers`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"fixers": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [Level](#level)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
||||
**Key**: `level`
|
||||
|
||||
**Type**: `string`
|
||||
|
||||
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
|
||||
|
||||
**Description**:
|
||||
|
||||
By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
```json
|
||||
{
|
||||
"php": {
|
||||
"level": ""
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### [Rules](#rules)
|
||||
|
||||
**Namespace**: `php`
|
||||
|
|
@ -17273,7 +17409,7 @@ Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
|
|||
|
||||
**Description**:
|
||||
|
||||
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (Supported by PHP-CS-Fixer)
|
||||
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
|
||||
|
||||
**Example `.jsbeautifyrc` Configuration**
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ module.exports = class PHPCSFixer extends Beautifier
|
|||
|
||||
beautify: (text, language, options, context) ->
|
||||
@debug('php-cs-fixer', options)
|
||||
version = options.cs_fixer_version
|
||||
|
||||
configFile = if context? and context.filePath? then @findFile(path.dirname(context.filePath), '.php_cs')
|
||||
phpCsFixerOptions = [
|
||||
|
|
@ -25,6 +26,13 @@ module.exports = class PHPCSFixer extends Beautifier
|
|||
"--config=#{configFile}" if configFile
|
||||
"--using-cache=no"
|
||||
]
|
||||
if version is 1
|
||||
phpCsFixerOptions = [
|
||||
"fix"
|
||||
"--level=#{options.level}" if options.level
|
||||
"--fixers=#{options.fixers}" if options.fixers
|
||||
"--config-file=#{configFile}" if configFile
|
||||
]
|
||||
runOptions = {
|
||||
ignoreReturnCode: true
|
||||
help: {
|
||||
|
|
|
|||
|
|
@ -27,10 +27,23 @@ module.exports = {
|
|||
type: 'string'
|
||||
default: ""
|
||||
description: "Absolute path to the `php-cs-fixer` CLI executable"
|
||||
cs_fixer_version:
|
||||
title: "PHP-CS-Fixer Version"
|
||||
type: 'integer'
|
||||
default: 2
|
||||
enum: [1, 2]
|
||||
fixers:
|
||||
type: 'string'
|
||||
default: ""
|
||||
description: "Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only)"
|
||||
level:
|
||||
type: 'string'
|
||||
default: ""
|
||||
description: "By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only)"
|
||||
rules:
|
||||
type: 'string'
|
||||
default: ""
|
||||
description: "Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2"
|
||||
description: "Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only)"
|
||||
phpcbf_path:
|
||||
title: "PHPCBF Path"
|
||||
type: 'string'
|
||||
|
|
|
|||
|
|
@ -5792,10 +5792,56 @@
|
|||
"namespace": "php"
|
||||
}
|
||||
},
|
||||
"cs_fixer_version": {
|
||||
"title": "PHP-CS-Fixer Version",
|
||||
"type": "integer",
|
||||
"default": 2,
|
||||
"enum": [
|
||||
1,
|
||||
2
|
||||
],
|
||||
"beautifiers": [
|
||||
"PHP-CS-Fixer"
|
||||
],
|
||||
"key": "cs_fixer_version",
|
||||
"language": {
|
||||
"name": "PHP",
|
||||
"namespace": "php"
|
||||
},
|
||||
"description": "undefined (Supported by PHP-CS-Fixer)"
|
||||
},
|
||||
"fixers": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)",
|
||||
"title": "Fixers",
|
||||
"beautifiers": [
|
||||
"PHP-CS-Fixer"
|
||||
],
|
||||
"key": "fixers",
|
||||
"language": {
|
||||
"name": "PHP",
|
||||
"namespace": "php"
|
||||
}
|
||||
},
|
||||
"level": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)",
|
||||
"title": "Level",
|
||||
"beautifiers": [
|
||||
"PHP-CS-Fixer"
|
||||
],
|
||||
"key": "level",
|
||||
"language": {
|
||||
"name": "PHP",
|
||||
"namespace": "php"
|
||||
}
|
||||
},
|
||||
"rules": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (Supported by PHP-CS-Fixer)",
|
||||
"description": "Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)",
|
||||
"title": "Rules",
|
||||
"beautifiers": [
|
||||
"PHP-CS-Fixer"
|
||||
|
|
|
|||
Loading…
Reference in New Issue