Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use MediaWiki CodeSniffer for code style checks #88

Merged
merged 6 commits into from
Nov 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.DS_Store
.DS_Store
composer.lock
vendor/*
42 changes: 42 additions & 0 deletions .phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?xml version="1.0"?>
<ruleset name="MediaWiki">
<file>.</file>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">

<!-- These exclusions taken from Extension:Echo and should be re-assessed -->
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />

<!-- Allow non-wg prefix (e.g. $egWatchAnalyticsPageCounter) -->
<exclude name="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix" />
<!-- Same as above, but for PHP 5.6 (using MW CodeSniffer 19.1.0) -->
<exclude name="MediaWiki.NamingConventions.ValidGlobalName.wgPrefix" />

<!-- Allow type-hinting for scalars (e.g. int $myInt, string $myString) -->
<exclude name="MediaWiki.PHP70Features.ScalarTypeHintUsage.Found" />
<exclude name="MediaWiki.PHP70Features.ScalarTypeHintUsage.ReturnTypeFound" />

<!--
Consider fixing while( $var = something() ) due to this:
https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Assignment_expressions
-->
<exclude name="MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures" />

<!--
This exclusion required because we use the database query() function directly rather
than using select() or other more specific functions
-->
<exclude name="MediaWiki.Usage.DbrQueryUsage.DbrQueryFound" />
</rule>
<rule ref="Generic.Files.LineLength">
<properties>
<property name="lineLimit" value="140" />
</properties>
</rule>
<arg name="encoding" value="UTF-8" />
<arg name="extensions" value="php,php5,inc" />
<arg name="colors" />
</ruleset>
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ php:
before_script:
# ref: https://stackoverflow.com/questions/45213498/how-to-syntax-check-php-files-in-travis-ci
- '! find . -type f -name "*.php" -exec php -d error_reporting=32767 -l {} \; 2>&1 >&- | grep "^"'
- composer install
script:
- composer test
- bash ./build/travis/run-tests.sh

25 changes: 12 additions & 13 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,22 @@
}
],
"support": {
"issues": "https://github.com/jamesmontalvo3/WatchAnalytics/issues",
"issues": "https://github.com/enterprisemediawiki/WatchAnalytics/issues",
"wiki": "https://www.mediawiki.org/wiki/Extension:WatchAnalytics",
"source": "https://github.com/jamesmontalvo3/WatchAnalytics"
"source": "https://github.com/enterprisemediawiki/WatchAnalytics"
},
"require": {
"php": ">=5.3.0",
"composer/installers": "1.*,>=1.0.1"
"php": ">=5.6.0"
},
"autoload": {
"files" : [
"WatchAnalytics.php"
]
},
"config": {
"process-timeout": 0
"require-dev": {
"mediawiki/mediawiki-codesniffer": "19.1.0 || 23.0.0"
},
"scripts": {
"phpunit": "php ../../tests/phpunit/phpunit.php -c phpunit.xml.dist"
"test": [
"phpcs -p -s"
],
"fix": [
"phpcbf"
]
}
}
}