Modified Vedmaka's PR with Jeffrey's suggestions

.github/CI-SETUP.md

@@ -0,0 +1,144 @@
+# CI Setup - Docker-Based Local Testing
+
+## ✅ Prerequisites
+
+- Docker
+- Docker Compose  
+- Make
+- Git
+
+## 🚀 Quick Start (Recommended)
+
+### 1. Add docker-compose-ci as submodule
+```bash
+cd /home/greg/src/CrawlerProtection
+
+# Remove build/ from .gitignore if present (it's a submodule now)
+sed -i '/^build\/$/d' .gitignore
+
+# Add the submodule
+git submodule add https://github.com/gesinn-it-pub/docker-compose-ci.git build
+git add .gitignore .gitmodules build Makefile
+git commit -m "Add docker-compose-ci for local testing"
+```
+
+### 2. Initialize submodule (for fresh clones)
+```bash
+# When cloning the repo in the future, use:
+git clone --recursive https://github.com/freephile/CrawlerProtection.git
+
+# Or if already cloned without --recursive:
+git submodule update --init --recursive
+```
+
+### 3. Run CI Tests
+The `Makefile` is already configured. Just run:
+```bash
+make ci              # Run all CI checks
+make ci-coverage     # Run with coverage
+make bash            # Enter container to run commands manually
+make down            # Stop containers
+```
+
+## 🔧 What Gets Tested
+
+The `make ci` command runs:
+- **Lint** - PHP syntax checking (parallel-lint)
+- **PHPCS** - Code style validation (MediaWiki standards)
+- **PHPUnit** - Unit tests
+
+All in a container with the correct PHP version, extensions, and MediaWiki setup!
+
+## 📋 Common Commands
+
+```bash
+# Run all tests
+make ci
+
+# Run specific tests inside container
+make bash
+> composer phpcs                    # Code style check
+> composer phpcbf                   # Auto-fix code style
+> composer phpunit                  # Run PHPUnit tests
+> composer test                     # Run phpcs + phpunit
+
+# Test with different MediaWiki versions
+MW_VERSION=1.39 make ci
+MW_VERSION=1.43 PHP_VERSION=8.3 make ci
+
+# Clean up
+make down
+make clean
+```
+
+## 🌐 Access Wiki in Browser
+
+Create `build/docker-compose.override.yml`:
+```yaml
+services:
+  wiki:
+    ports:
+      - 8080:8080
+```
+
+Then start: `make up` and visit http://localhost:8080
+
+## 🔄 Update Docker CI
+
+```bash
+git submodule update --init --remote
+```
+
+## 📝 Environment Variables
+
+Create `.env` file to customize:
+```bash
+MW_VERSION=1.43
+PHP_VERSION=8.2
+DB_TYPE=sqlite
+EXTENSION=CrawlerProtection
+```
+
+## ⚡ Quick Fixes Before Commit
+
+```bash
+# Auto-fix code style issues
+make bash
+> composer phpcbf
+
+# Check what will fail in CI
+make ci
+```
+
+## 🐛 Troubleshooting
+
+**"build directory not found"**
+```bash
+git submodule update --init --remote
+```
+
+**"Container keeps restarting"**
+```bash
+make down
+make clean
+make ci
+```
+
+**"Permission denied"**
+```bash
+sudo chmod -R 777 cache/
+```
+
+## 🎯 GitHub Actions Setup
+
+Your `.github/workflows/ci.yml` already exists and will run automatically on:
+- Pushes to `main` or `specialPageList` branches
+- All pull requests
+
+Check results at: https://github.com/freephile/CrawlerProtection/actions
+
+## 🔗 Resources
+
+- [docker-compose-ci documentation](https://github.com/gesinn-it-pub/docker-compose-ci)
+- [MediaWiki coding conventions](https://www.mediawiki.org/wiki/Manual:Coding_conventions)
+- Your GitHub Actions: https://github.com/freephile/CrawlerProtection/actions

.github/DOCKER-CI-QUICKREF.md

@@ -0,0 +1,56 @@
+# Docker CI Quick Reference
+
+## Setup (One Time)
+```bash
+git submodule add https://github.com/gesinn-it-pub/docker-compose-ci.git build
+git add .gitignore .gitmodules build Makefile TESTING.md
+git commit -m "Add docker-compose-ci for local testing"
+```
+
+## Daily Use
+
+```bash
+make ci              # Run all checks (before commit)
+make bash            # Fix issues manually
+  > composer phpcbf  # Auto-fix code style
+make down            # Clean up
+```
+
+## All Commands
+
+| Command | Purpose |
+|---------|---------|
+| `make ci` | Run all CI checks (lint, phpcs, phpunit) |
+| `make bash` | Enter container shell |
+| `make up` | Start wiki (http://localhost:8080) |
+| `make down` | Stop all containers |
+| `make clean` | Remove all containers and volumes |
+
+## Inside Container (`make bash`)
+
+| Command | Purpose |
+|---------|---------|
+| `composer test` | Run phpcs + phpunit |
+| `composer phpcs` | Check code style |
+| `composer phpcbf` | Fix code style automatically |
+| `composer phpunit` | Run unit tests |
+
+## Test Different Versions
+
+```bash
+MW_VERSION=1.39 PHP_VERSION=8.1 make ci    # Test MW 1.39 + PHP 8.1
+MW_VERSION=1.43 PHP_VERSION=8.3 make ci    # Test MW 1.43 + PHP 8.3
+```
+
+## Troubleshooting
+
+```bash
+make down && make clean    # Nuclear option: clean everything
+git submodule update --init --remote    # Update docker-compose-ci
+```
+
+## See Also
+
+- Full docs: `.github/CI-SETUP.md`
+- Testing guide: `TESTING.md`
+- Your CI runs: https://github.com/freephile/CrawlerProtection/actions

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - main
+      - specialPageList  # Add your development branch
   pull_request:
 
 env:
@@ -58,7 +59,7 @@ jobs:
       - name: Lint
         run: ./vendor/bin/parallel-lint --exclude node_modules --exclude vendor extensions/${{ env.EXTNAME }}
       - name: PHP Code Sniffer
-        run: ./vendor/bin/phpcs -sp --standard=vendor/mediawiki/mediawiki-codesniffer/MediaWiki extensions/${{ env.EXTNAME }}
+        run: cd extensions/${{ env.EXTNAME }} && ../../vendor/bin/phpcs -sp
 
   security:
     name: Static Analysis

.gitignore

@@ -8,7 +8,8 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
+# do not ignore build because it is a submodule
+# build/
 develop-eggs/
 dist/
 downloads/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "build"]
+	path = build
+	url = https://github.com/gesinn-it-pub/docker-compose-ci.git

.phpcs.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<ruleset name="CrawlerProtection">
+	<description>MediaWiki coding standards for CrawlerProtection extension</description>
+
+	<rule ref="../../vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
+		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
+	</rule>
+
+	<!-- Paths to check -->
+	<file>.</file>
+
+	<!-- Paths to ignore -->
+	<exclude-pattern>*/build/*</exclude-pattern>
+	<exclude-pattern>*/vendor/*</exclude-pattern>
+	<exclude-pattern>*/node_modules/*</exclude-pattern>
+	<exclude-pattern>*.phan/*</exclude-pattern>
+
+	<!-- Show progress -->
+	<arg name="colors"/>
+	<arg name="encoding" value="UTF-8"/>
+	<arg name="extensions" value="php"/>
+	<arg value="sp"/>
+
+	<!-- Memory limit -->
+	<ini name="memory_limit" value="512M"/>
+</ruleset>

Makefile

@@ -0,0 +1,27 @@
+-include .env
+export
+
+# setup for docker-compose-ci build directory
+ifeq (,$(wildcard ./build/))
+    $(shell git submodule update --init --remote)
+endif
+
+EXTENSION=CrawlerProtection
+
+# docker images
+MW_VERSION?=1.43
+PHP_VERSION?=8.2
+DB_TYPE?=mysql
+DB_IMAGE?="mariadb:11.2"
+
+# composer
+# Enables "composer update" inside of extension
+# Leave empty/unset to disable, set to "true" to enable
+COMPOSER_EXT?=
+
+# nodejs
+# Enables node.js related tests and "npm install"
+# Leave empty/unset to disable, set to "true" to enable
+NODE_JS?=
+
+include build/Makefile

README.md

@@ -1,2 +1,22 @@
 # CrawlerProtection
-Protect wikis against crawler bots
+
+Protect wikis against crawler bots. CrawlerProtection denies **anonymous** user
+access to certain MediaWiki action URLs and SpecialPages which are resource
+intensive.
+
+# Configuration
+
+* `$wgCrawlerProtectedSpecialPages` - array of special pages to protect
+  (default: `[ 'mobilediff', 'recentchangeslinked', 'whatlinkshere' ]`).
+  Supported values are special page names or their aliases regardless of case.
+  You do not need to use the 'Special:' prefix. Note that you can fetch a full
+  list of SpecialPages defined by your wiki using the API and jq with a simple
+  bash one-liner like
+  `curl -s "[YOURWIKI]api.php?action=query&meta=siteinfo&siprop=specialpagealiases&format=json" | jq -r '.query.specialpagealiases[].aliases[]' | sort`
+  Of course certain Specials MUST be allowed like Special:Login so do not block
+  everything.
+* `$wgCrawlerProtectionUse418` - drop denied requests in a quick way via
+  `die();` with
+  [418 I'm a teapot](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/418)
+  code (default: `false`)
+

TESTING.md

@@ -0,0 +1,67 @@
+# Local CI Testing with Docker
+
+This extension uses [docker-compose-ci](https://github.com/gesinn-it-pub/docker-compose-ci) for local testing.
+
+## Quick Start
+
+```bash
+# One-time setup (if not already done)
+git submodule update --init --recursive
+
+# Run all CI checks (lint, phpcs, phpunit)
+make ci
+
+# Auto-fix code style issues
+make bash
+> composer phpcbf
+
+# Stop containers
+make down
+```
+
+## Why Docker?
+
+- ✅ Same environment as GitHub Actions CI
+- ✅ Correct PHP version, extensions, and MediaWiki automatically
+- ✅ No need to install MediaWiki locally
+- ✅ Test against multiple MW/PHP versions easily
+- ✅ Isolated from your local system
+
+## Common Commands
+
+```bash
+make ci              # Run all CI checks
+make bash            # Enter container shell
+make up              # Start wiki (http://localhost:8080)
+make down            # Stop containers
+make clean           # Remove containers and volumes
+```
+
+## Test Different Versions
+
+```bash
+# Test with MediaWiki 1.39 and PHP 8.1
+MW_VERSION=1.39 PHP_VERSION=8.1 make ci
+
+# Test with MediaWiki 1.43 and PHP 8.3
+MW_VERSION=1.43 PHP_VERSION=8.3 make ci
+```
+
+## Available Composer Scripts
+
+Inside the container (`make bash`):
+
+```bash
+composer test        # Run phpcs + phpunit
+composer phpcs       # Check code style
+composer phpcbf      # Fix code style
+composer phpunit     # Run unit tests
+```
+
+## Update Docker CI
+
+```bash
+git submodule update --init --remote
+```
+
+See `.github/CI-SETUP.md` and `.github/DOCKER-CI-QUICKREF.md` for more details.