Skip to content

Add dev tooling: composer, phpcs, Makefile, CI, .gitignore #71

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.

Sign up for GitHub

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

Merged
jmnote merged 1 commit into from
Sep 6, 2026
Merged

Add dev tooling: composer, phpcs, Makefile, CI, .gitignore #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 0 additions & 12 deletions .editorconfig
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions .github/workflows/contributors.yml
View file
Open in desktop

This file was deleted.

19 changes: 19 additions & 0 deletions .github/workflows/pull-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: pull-request

on:
pull_request:

jobs:
php:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: shivammathur/setup-php@v2
with:
php-version: '8.3'

- run: composer install --no-progress

- run: make checks
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules/
vendor/
composer.lock
hack/demo/temp/
13 changes: 13 additions & 0 deletions .phpcs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0"?>
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
</rule>
<file>.</file>
<exclude-pattern>\.stubs/</exclude-pattern>
<exclude-pattern>hack/</exclude-pattern>
<exclude-pattern>tests/</exclude-pattern>
<arg name="extensions" value="php"/>
<arg name="encoding" value="UTF-8"/>
</ruleset>
5 changes: 5 additions & 0 deletions .vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"wongjn.php-sniffer"
]
}
7 changes: 7 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"[php]": {
"editor.defaultFormatter": "wongjn.php-sniffer",
"editor.formatOnSave": true,
},
"phpSniffer.executablesFolder": "vendor/bin/"
}
9 changes: 9 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.PHONY: checks test phpcs

checks: test phpcs ## Everything CI runs before merging (needs `composer install`, PHP >= 8.2)

test: ## Run the pure-PHP test suites
php tests/QuotesTest.php

phpcs: ## parallel-lint + minus-x + phpcs against the MediaWiki coding standard
composer test
140 changes: 0 additions & 140 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,143 +101,3 @@ $wgHooks['SimpleMathJaxAttributes'][]
};
```

## Contributors

<!-- readme: collaborators,contributors -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/jmnote">
<img src="https://avatars.githubusercontent.com/u/2242405?v=4" width="48;" alt="jmnote"/>
<br />
<sub><b>jmnote</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/jamesmontalvo3">
<img src="https://avatars.githubusercontent.com/u/716482?v=4" width="48;" alt="jamesmontalvo3"/>
<br />
<sub><b>James Montalvo</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/hexmode">
<img src="https://avatars.githubusercontent.com/u/43581?v=4" width="48;" alt="hexmode"/>
<br />
<sub><b>Mark A. Hershberger</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/dummy-index">
<img src="https://avatars.githubusercontent.com/u/3407906?v=4" width="48;" alt="dummy-index"/>
<br />
<sub><b>dummy-index</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/lakejason0">
<img src="https://avatars.githubusercontent.com/u/36039861?v=4" width="48;" alt="lakejason0"/>
<br />
<sub><b>lakejason0</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/badshah400">
<img src="https://avatars.githubusercontent.com/u/3532467?v=4" width="48;" alt="badshah400"/>
<br />
<sub><b>Atri Bhattacharya</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/Nikerabbit">
<img src="https://avatars.githubusercontent.com/u/1109395?v=4" width="48;" alt="Nikerabbit"/>
<br />
<sub><b>Niklas Laxström</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/cubercsl">
<img src="https://avatars.githubusercontent.com/u/22931465?v=4" width="48;" alt="cubercsl"/>
<br />
<sub><b>cubercsl</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/liberaldev">
<img src="https://avatars.githubusercontent.com/u/56965274?v=4" width="48;" alt="liberaldev"/>
<br />
<sub><b>Liberal Dev</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Adnn">
<img src="https://avatars.githubusercontent.com/u/3911163?v=4" width="48;" alt="Adnn"/>
<br />
<sub><b>Adnn</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/dexgs">
<img src="https://avatars.githubusercontent.com/u/93449583?v=4" width="48;" alt="dexgs"/>
<br />
<sub><b>Dexter Gaon-Shatford</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/pastakhov">
<img src="https://avatars.githubusercontent.com/u/1772774?v=4" width="48;" alt="pastakhov"/>
<br />
<sub><b>Pavel Astakhov</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/v-gar">
<img src="https://avatars.githubusercontent.com/u/11472697?v=4" width="48;" alt="v-gar"/>
<br />
<sub><b>Viktor Garske</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/rickselby">
<img src="https://avatars.githubusercontent.com/u/1564517?v=4" width="48;" alt="rickselby"/>
<br />
<sub><b>Rick Selby</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/guyru">
<img src="https://avatars.githubusercontent.com/u/1255135?v=4" width="48;" alt="guyru"/>
<br />
<sub><b>guyru</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/poiega">
<img src="https://avatars.githubusercontent.com/u/110189813?v=4" width="48;" alt="poiega"/>
<br />
<sub><b>poiega</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/vedmaka">
<img src="https://avatars.githubusercontent.com/u/592009?v=4" width="48;" alt="vedmaka"/>
<br />
<sub><b>Vedmaka</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/yardenac">
<img src="https://avatars.githubusercontent.com/u/687943?v=4" width="48;" alt="yardenac"/>
<br />
<sub><b>Yardena Cohen</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: collaborators,contributors -end -->
27 changes: 27 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"require-dev": {
"mediawiki/mediawiki-codesniffer": "52.0.0",
"mediawiki/mediawiki-phan-config": "0.20.0",
"mediawiki/minus-x": "2.0.1",
"php-parallel-lint/php-console-highlighter": "1.0.0",
"php-parallel-lint/php-parallel-lint": "1.4.0"
},
"scripts": {
"fix": [
"minus-x fix .",
"phpcbf"
],
"test": [
"parallel-lint . --exclude vendor --exclude node_modules",
"minus-x check .",
"@phpcs"
],
"phan": "phan -d . --long-progress-bar",
"phpcs": "phpcs -sp"
},
"config": {
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true
}
}
}
Loading