Skip to content

Commit 8d79cb2

Browse files
author
Michael Babker
authored
Merge pull request #257 from perry-contribs/master
typo fix - README.md, fixes #256
2 parents 687c050 + 3118b0a commit 8d79cb2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ If you want to contribute and improve this documentation, you can find the sourc
1414
* PHP 5.3+
1515
* [PHP Codesniffer](https://github.com/squizlabs/PHP_CodeSniffer) 2.8+
1616

17-
**Important note**: currently the latest PHPCS is the 3.x series. There is [a development branch](https://github.com/joomla/coding-standards/tree/3.x-dev) for the Joomla custom sniffs Which is compatible with the PHPCS 3.x series. Although PEAR and composer give you the option to install PHPCS 3.x by default the Joomla custom sniffs releases are currently only compatable with PHPCS 2.x and will not work, so we remind you to always install the PHPCS 2.x series if you are using the Joomla custom sniffs.
17+
**Important note**: currently the latest PHPCS is the 3.x series. There is [a development branch](https://github.com/joomla/coding-standards/tree/3.x-dev) for the Joomla custom sniffs Which is compatible with the PHPCS 3.x series. Although PEAR and composer give you the option to install PHPCS 3.x by default the Joomla custom sniffs releases are currently only compatible with PHPCS 2.x and will not work, so we remind you to always install the PHPCS 2.x series if you are using the Joomla custom sniffs.
1818
If you want to test the [Joomla Code Standard development branch for PHPCS 3.x](https://github.com/joomla/coding-standards/tree/3.x-dev), please manually install the 3.x branch.
1919

2020
## Installation via Composer
@@ -62,8 +62,8 @@ Once you have the coding standard files you can tell PHPCS where the standard fo
6262
```sh
6363
phpcs --config-set installed_paths /path/to/joomla-coding-standards
6464
```
65-
Note: the composer scripts will run when the standard is installed globally, but not when it's a dependancy. As such, you may want to run PHPCS config-set. When you run PHPCS config-set it will always overwrite the previous values. Use `--config-show` to check previous values before using `--config-set`
66-
So instead of overwriting the existing paths you should copy the existing paths revealed with `--config-show` and add each one seperated by a comma:
65+
Note: the composer scripts will run when the standard is installed globally, but not when it's a dependency. As such, you may want to run PHPCS config-set. When you run PHPCS config-set it will always overwrite the previous values. Use `--config-show` to check previous values before using `--config-set`
66+
So instead of overwriting the existing paths you should copy the existing paths revealed with `--config-show` and add each one separated by a comma:
6767
`phpcs --config-set installed_paths [path_1],[path_2],[/path/to/joomla-coding-standards]`
6868

6969
## Running
@@ -80,7 +80,7 @@ Alternatively if it isn't installed you can still reference it by path like:
8080

8181
For consuming packages there are some items that will typically result in creating their own project ruleset.xml, rather than just directly using the Joomla ruleset.xml. A project ruleset.xml allows the coding standard to be selectively applied for excluding 3rd party libraries, for consideration of backwards compatibility in existing projects, or for adjustments necessary for projects that do not need PHP 5.3 compatibility (which will be removed in a future version of the Joomla Coding Standard in connection of the end of PHP 5.3 support in all active Joomla Projects).
8282

83-
For information on [selectivly applying rules read details in the PHP CodeSniffer wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml#selectively-applying-rules)
83+
For information on [selectively applying rules read details in the PHP CodeSniffer wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml#selectively-applying-rules)
8484

8585
#### Common Rule Set Adjustments
8686

@@ -134,8 +134,8 @@ You have to tell you can tell PHPCS where the example ruleset folder is (i.e. in
134134
```sh
135135
phpcs --config-set installed_paths /path/to/joomla/coding-standards/Example-Rulesets
136136
```
137-
Note: the composer scripts will run when the standard is installed globally, but not when it's a dependancy. As such, you may want to run PHPCS config-set. When you run PHPCS config-set it will always overwrite the previous values. Use `--config-show` to check previous values before using `--config-set`
138-
So instead of overwriting the existing paths you should copy the existing paths revealed with `--config-show` and add each one seperated by a comma:
137+
Note: the composer scripts will run when the standard is installed globally, but not when it's a dependency. As such, you may want to run PHPCS config-set. When you run PHPCS config-set it will always overwrite the previous values. Use `--config-show` to check previous values before using `--config-set`
138+
So instead of overwriting the existing paths you should copy the existing paths revealed with `--config-show` and add each one separated by a comma:
139139
`phpcs --config-set installed_paths [path_1],[path_2],[/path/to/joomla-coding-standards],[/path/to/joomla/coding-standards/Example-Rulesets]`
140140

141141
## IDE autoformatters

0 commit comments

Comments
 (0)