npm run docs

This commit is contained in:
Tony Brix 2017-05-05 14:24:17 -05:00
parent fc10c7ee93
commit 04e3a826be
2 changed files with 74 additions and 23 deletions

View File

@ -9575,9 +9575,10 @@ Specify a configuration file which will override the default name of .perltidyrc
| `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: |
| `phpcbf_path` | :x: | :white_check_mark: | :x: |
| `phpcbf_version` | :x: | :white_check_mark: | :x: |
| `rules` | :white_check_mark: | :x: | :x: |
| `standard` | :white_check_mark: | :white_check_mark: | :x: |
| `standard` | :x: | :white_check_mark: | :x: |
**Description**:
@ -9774,11 +9775,11 @@ By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 o
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
Path to the `phpcbf` CLI executable (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**
@ -9790,6 +9791,34 @@ Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
}
```
##### [PHPCBF Version](#phpcbf-version)
**Namespace**: `php`
**Key**: `phpcbf_version`
**Default**: `2`
**Type**: `integer`
**Enum**: `1` `2` `3`
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
undefined (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"phpcbf_version": 2
}
}
```
##### [Rules](#rules)
**Namespace**: `php`
@ -9822,11 +9851,11 @@ Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Sup
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) [`PHPCBF`](#phpcbf)
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHP-CS-Fixer, PHPCBF)
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**
@ -17478,6 +17507,9 @@ allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer
}
```
### PHPCBF
##### [PHPCBF Path](#phpcbf-path)
**Namespace**: `php`
@ -17486,11 +17518,11 @@ allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer)
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
Path to the `phpcbf` CLI executable (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**
@ -17502,33 +17534,34 @@ Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
}
```
##### [PHPCBF Standard](#phpcbf-standard)
##### [PHPCBF Version](#phpcbf-version)
**Namespace**: `php`
**Key**: `standard`
**Key**: `phpcbf_version`
**Type**: `string`
**Default**: `2`
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) [`PHPCBF`](#phpcbf)
**Type**: `integer`
**Enum**: `1` `2` `3`
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHP-CS-Fixer, PHPCBF)
undefined (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"standard": ""
"phpcbf_version": 2
}
}
```
### PHPCBF
##### [PHPCBF Standard](#phpcbf-standard)
**Namespace**: `php`
@ -17537,11 +17570,11 @@ Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS ru
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) [`PHPCBF`](#phpcbf)
**Supported Beautifiers**: [`PHPCBF`](#phpcbf)
**Description**:
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHP-CS-Fixer, PHPCBF)
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF)
**Example `.jsbeautifyrc` Configuration**

View File

@ -5874,9 +5874,9 @@
"title": "PHPCBF Path",
"type": "string",
"default": "",
"description": "Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)",
"description": "Path to the `phpcbf` CLI executable (Supported by PHPCBF)",
"beautifiers": [
"PHP-CS-Fixer"
"PHPCBF"
],
"key": "phpcbf_path",
"language": {
@ -5884,13 +5884,31 @@
"namespace": "php"
}
},
"phpcbf_version": {
"title": "PHPCBF Version",
"type": "integer",
"default": 2,
"enum": [
1,
2,
3
],
"beautifiers": [
"PHPCBF"
],
"key": "phpcbf_version",
"language": {
"name": "PHP",
"namespace": "php"
},
"description": "undefined (Supported by PHPCBF)"
},
"standard": {
"title": "PHPCBF Standard",
"type": "string",
"default": "",
"description": "Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHP-CS-Fixer, PHPCBF)",
"description": "Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF)",
"beautifiers": [
"PHP-CS-Fixer",
"PHPCBF"
],
"key": "standard",