Skip to content

Commit 0f18809

Browse files
authored
Merge pull request #1 from PHPCSStandards/feature/docs-update-for-new-home
Update for Composer name + docs for new repo home
2 parents 7763e2e + c855348 commit 0f18809

File tree

630 files changed

+671
-662
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

630 files changed

+671
-662
lines changed

.github/workflows/manage-labels.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ on:
1212
jobs:
1313
on-issue-close:
1414
runs-on: ubuntu-latest
15-
if: github.repository_owner == 'squizlabs' && github.event.issue.state == 'closed'
15+
if: github.repository_owner == 'PHPCSStandards' && github.event.issue.state == 'closed'
1616

1717
name: Clean up labels on issue close
1818

@@ -28,7 +28,7 @@ jobs:
2828
2929
on-pr-merge:
3030
runs-on: ubuntu-latest
31-
if: github.repository_owner == 'squizlabs' && github.event.pull_request.merged == true
31+
if: github.repository_owner == 'PHPCSStandards' && github.event.pull_request.merged == true
3232

3333
name: Clean up labels on PR merge
3434

@@ -44,7 +44,7 @@ jobs:
4444
4545
on-pr-close:
4646
runs-on: ubuntu-latest
47-
if: github.repository_owner == 'squizlabs' && github.event_name == 'pull_request_target' && github.event.pull_request.merged == false
47+
if: github.repository_owner == 'PHPCSStandards' && github.event_name == 'pull_request_target' && github.event.pull_request.merged == false
4848

4949
name: Clean up labels on PR close
5050

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22

33
PHP_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
44

5-
[![Build Status](https://github.com/squizlabs/PHP_CodeSniffer/workflows/Validate/badge.svg?branch=master)](https://github.com/squizlabs/PHP_CodeSniffer/actions)
6-
[![Build Status](https://github.com/squizlabs/PHP_CodeSniffer/workflows/Test/badge.svg?branch=master)](https://github.com/squizlabs/PHP_CodeSniffer/actions)
7-
[![Code consistency](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer/grade.svg)](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer)
8-
[![Join the chat at https://gitter.im/squizlabs/PHP_CodeSniffer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/squizlabs/PHP_CodeSniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5+
[![Build Status](https://github.com/PHPCSStandards/PHP_CodeSniffer/workflows/Validate/badge.svg?branch=master)](https://github.com/PHPCSStandards/PHP_CodeSniffer/actions)
6+
[![Build Status](https://github.com/PHPCSStandards/PHP_CodeSniffer/workflows/Test/badge.svg?branch=master)](https://github.com/PHPCSStandards/PHP_CodeSniffer/actions)
97

108
## Requirements
119

12-
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
10+
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
1311

14-
If you're using PHP_CodeSniffer as part of a team, or you're running it on a [CI](https://en.wikipedia.org/wiki/Continuous_integration) server, you may want to configure your project's settings [using a configuration file](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file).
12+
If you're using PHP_CodeSniffer as part of a team, or you're running it on a [CI](https://en.wikipedia.org/wiki/Continuous_integration) server, you may want to configure your project's settings [using a configuration file](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file).
1513

1614

1715
## Installation
@@ -34,16 +32,16 @@ php phpcbf.phar -h
3432
### Composer
3533
If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
3634
```bash
37-
composer global require "squizlabs/php_codesniffer=*"
35+
composer global require "phpcsstandards/php_codesniffer=*"
3836
```
3937
Make sure you have the composer bin dir in your PATH. The default value is `~/.composer/vendor/bin/`, but you can check the value that you need to use by running `composer global config bin-dir --absolute`.
4038

41-
Or alternatively, include a dependency for `squizlabs/php_codesniffer` in your `composer.json` file. For example:
39+
Or alternatively, include a dependency for `phpcsstandards/php_codesniffer` in your `composer.json` file. For example:
4240

4341
```json
4442
{
4543
"require-dev": {
46-
"squizlabs/php_codesniffer": "3.*"
44+
"phpcsstandards/php_codesniffer": "^3.0"
4745
}
4846
}
4947
```
@@ -72,7 +70,7 @@ pear install PHP_CodeSniffer
7270
### Git Clone
7371
You can also download the PHP_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
7472
```bash
75-
git clone https://github.com/squizlabs/PHP_CodeSniffer.git
73+
git clone https://github.com/PHPCSStandards/PHP_CodeSniffer.git
7674
cd PHP_CodeSniffer
7775
php bin/phpcs -h
7876
php bin/phpcbf -h
@@ -94,15 +92,15 @@ phpcs --standard=PSR12 /path/to/code-directory
9492

9593
If PHP_CodeSniffer finds any coding standard errors, a report will be shown after running the command.
9694

97-
Full usage information and example reports are available on the [usage page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage).
95+
Full usage information and example reports are available on the [usage page](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Usage).
9896

9997
## Documentation
10098

101-
The documentation for PHP_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
99+
The documentation for PHP_CodeSniffer is available on the [Github wiki](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki).
102100

103101
## Issues
104102

105-
Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/squizlabs/PHP_CodeSniffer/issues).
103+
Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/PHPCSStandards/PHP_CodeSniffer/issues).
106104

107105
## Contributing
108106

autoload.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*
1212
* @author Greg Sherwood <[email protected]>
1313
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
14-
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
14+
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
1515
*/
1616

1717
namespace PHP_CodeSniffer;

bin/phpcbf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* @author Greg Sherwood <[email protected]>
77
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
8-
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
8+
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
99
*/
1010

1111
if (is_file(__DIR__.'/../autoload.php') === true) {

bin/phpcbf.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ REM PHP Code Beautifier and Fixer fixes violations of a defined coding standard.
33
REM
44
REM @author Greg Sherwood <[email protected]>
55
REM @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
6-
REM @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
6+
REM @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
77

88
if "%PHP_PEAR_PHP_BIN%" neq "" (
99
set PHPBIN=%PHP_PEAR_PHP_BIN%

bin/phpcs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* @author Greg Sherwood <[email protected]>
77
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
8-
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
8+
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
99
*/
1010

1111
if (is_file(__DIR__.'/../autoload.php') === true) {

bin/phpcs.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ REM PHP_CodeSniffer detects violations of a defined coding standard.
33
REM
44
REM @author Greg Sherwood <[email protected]>
55
REM @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
6-
REM @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
6+
REM @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
77

88
if "%PHP_PEAR_PHP_BIN%" neq "" (
99
set PHPBIN=%PHP_PEAR_PHP_BIN%

composer.json

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
{
2-
"name": "squizlabs/php_codesniffer",
2+
"name": "phpcsstandards/php_codesniffer",
33
"description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
44
"type": "library",
55
"keywords": [
66
"phpcs",
77
"standards",
88
"static analysis"
99
],
10-
"homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
10+
"homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer",
1111
"license": "BSD-3-Clause",
1212
"authors": [
1313
{
1414
"name": "Greg Sherwood",
15-
"role": "lead"
15+
"role": "Former lead"
16+
},
17+
{
18+
"name": "Juliette Reinders Folmer",
19+
"role": "Current lead"
20+
},
21+
{
22+
"name" : "Contributors",
23+
"homepage" : "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors"
1624
}
1725
],
1826
"support": {
19-
"issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues",
20-
"wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki",
21-
"source": "https://github.com/squizlabs/PHP_CodeSniffer"
27+
"issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues",
28+
"wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki",
29+
"source": "https://github.com/PHPCSStandards/PHP_CodeSniffer"
2230
},
2331
"extra": {
2432
"branch-alias": {
@@ -34,6 +42,9 @@
3442
"require-dev": {
3543
"phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
3644
},
45+
"replace": {
46+
"squizlabs/php_codesniffer": "> 2.0"
47+
},
3748
"bin": [
3849
"bin/phpcs",
3950
"bin/phpcbf"

scripts/build-phar.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* @author Benjamin Pearson <[email protected]>
1111
* @author Greg Sherwood <[email protected]>
1212
* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
13-
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
13+
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
1414
* @link http://pear.php.net/package/PHP_CodeSniffer
1515
*/
1616

src/Config.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*
88
* @author Greg Sherwood <[email protected]>
99
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
10-
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
10+
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
1111
*/
1212

1313
namespace PHP_CodeSniffer;

0 commit comments

Comments
 (0)