Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell committed Sep 6, 2021
1 parent d8c2895 commit 3ec232f
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions cli-tool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CLI Tool

The StyleCI CLI Tool requires [PHP](https://php.net) 7.2.5 or higher, and can be installed either directly downloading the phar, orby using [Composer](https://getcomposer.org/). The tool will allow you to analyze your code using StyleCI, before you push. This tool is licensed under [The Apache License 2.0](https://github.com/StyleCI/CLI/blob/1.1/LICENSE).
The StyleCI CLI Tool requires [PHP](https://php.net) 7.2.5 or higher, and can be installed either directly downloading the phar, orby using [Composer](https://getcomposer.org/). The tool will allow you to analyze your code using StyleCI, before you push. This tool is licensed under [The Apache License 2.0](https://github.com/StyleCI/CLI/blob/1.2/LICENSE).

<a name="installation"></a>
## Installation
Expand All @@ -10,7 +10,7 @@ The StyleCI CLI Tool requires [PHP](https://php.net) 7.2.5 or higher, and can be
Global installation:

```bash
$ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v1.1.2/styleci.phar \
$ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v1.2.0/styleci.phar \
&& chmod +x styleci.phar && sudo mv styleci.phar /usr/local/bin/styleci
```

Expand All @@ -19,13 +19,13 @@ $ curl -SsLo styleci.phar https://github.com/StyleCI/CLI/releases/download/v1.1.
Local installation:

```bash
$ composer require styleci/cli:^1.1 --dev
$ composer require styleci/cli:^1.2 --dev
```

Global installation:

```bash
$ composer global require styleci/cli:^1.1
$ composer global require styleci/cli:^1.2
```

## First Time Setup
Expand Down
2 changes: 1 addition & 1 deletion configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Our default (PHP-only) configuration looks like this:

```yaml
risky: false
version: 7
version: 7.4
preset: recommended
finder:
exclude:
Expand Down
2 changes: 1 addition & 1 deletion finder.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Take a look at the below example of a PHP-only configuration:
```yaml
risky: false

version: 7
version: 7.4

presets: recommended

Expand Down
8 changes: 4 additions & 4 deletions multi-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The configuration for each language must now fall under the relevant name. For i
```yaml
php:
risky: true
version: 7
version: 7.4
preset: laravel
enabled:
- ternary_to_elvis_operator
Expand Down Expand Up @@ -66,7 +66,7 @@ Setting `php: true` translates to the following:
```yaml
php:
risky: false
version: 7
version: 7.4
preset: recommended
tab-width: 4
use-tabs: false
Expand Down Expand Up @@ -228,7 +228,7 @@ Setting `py: true` translates to the following:

```yaml
py:
version: 3
version: 3.9
preset: pep8
options:
tab-width: 4
Expand All @@ -246,7 +246,7 @@ py:
name: "*.py"
```

* The `version` key specifies the Python grammar version to use. `2` and `3` are allowed values, `3` being the default.
* The `version` key specifies the Python grammar version to use. `2.7` and `3.9` are allowed values, `3.9` being the default, and additionally, `2` is an alias for `2.7` and `3` is an alias for `3.9`.
* Valid values for the `preset` key are `pep8`, `google`, `chromium` or `facebook`. We'd recommend either `pep8` or `google`.
* The `options` key contains several suboptions for further, fine-tuned customizations. These options are as follows:
* Valid values for `tab-width` are `2` and `4`.
Expand Down
4 changes: 2 additions & 2 deletions standalone-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To demonstrate this, below is the contents of an example `.styleci.yml` file, us
```yaml
risky: false

version: 7
version: 7.4

preset: recommended

Expand Down Expand Up @@ -55,7 +55,7 @@ Some of our fixers do things that can change code behavior, by design. Risky mod
<a name="version"></a>
## Version

It is possible to set the PHP version your code will be parsed using using the `version` option. `7` and `8` are allowed values, `7` being the default. Choosing `7` will parse your code as PHP 7.4 syntax, and choosing `8` parse your code as PHP 8.0 syntax. PHP 8 support is currently in beta, so use with care!
It is possible to set the PHP version your code will be parsed using using the `version` option. `7.4`, `8.0`, and `8.1` are the allowed values, and additionally, `7` is an alias for `7.4` and `8` is an alias for `8.0`. PHP version 7.4 support is stable and is the default version. 8.0 support is currently in beta and 8.1 support is in alpha, so use with care!

<a name="presets"></a>
## Presets
Expand Down

0 comments on commit 3ec232f

Please sign in to comment.