Skip to content

AGENTS.md

Latest commit

 

History

History
73 lines (44 loc) · 3.06 KB

AGENTS.md

File metadata and controls

73 lines (44 loc) · 3.06 KB

AGENTS.md

Overview

TabberNeue is a MediaWiki extension (requires MW 1.43+) that provides <tabber> and <tabbertransclude> parser tags for creating tabbed content. It uses PHP for parsing and rendering, Mustache templates, LESS for styles, and vanilla JS for client-side tab switching via MediaWiki's ResourceLoader. Optional Scribunto (Lua) integration is available.

Verification

Run only what's relevant to the files you changed.

Files changed Command
*.php composer preflight (lint, style, and Phan)
*.js npm run lint:js
*.less, *.css npm run lint:styles
i18n/ npm run lint:i18n

Auto-fix commands: composer fix (PHP), npm run lint:fix:js (JS), npm run lint:fix:styles (styles).

Preflight: Run npm run preflight to execute all Node-based lints in one command. Run composer preflight from within a MediaWiki installation to execute all PHP lints, style checks, and Phan static analysis.

Always run the relevant checks before committing. Read the full output — PHPCS warnings must be fixed, not just errors. The command exits 0 even with warnings, so do not treat exit code alone as a pass.

Dev environment

This project's standard dev environment is the MediaWiki Docker setup defined in the parent mediawiki/ directory. The user may be using a different environment. Ask the user for their dev environment URL and how to run commands if not already known.

To run composer commands in the standard Docker environment:

docker compose exec mediawiki bash -c "cd /var/www/html/w/extensions/TabberNeue && composer preflight"

Phan

Phan requires a full MediaWiki installation at ../../ for type resolution. The .phan/config.php conditionally includes Scribunto for type resolution when available.

docker compose exec mediawiki bash -c "cd /var/www/html/w/extensions/TabberNeue && composer phan"

Coding conventions

PHP

  • All files start with declare( strict_types=1 );
  • Use native PHP types (properties, parameters, return values); use PHPDoc only for collection types like string[]
  • Always use MediaWiki-namespaced imports (use MediaWiki\Title\Title;), never legacy shims (use Title;)

JavaScript

  • CommonJS modules: require() for imports, module.exports for exports

LESS/CSS

  • Styles live in modules/

extension.json

extension.json is the source of truth for how the extension is wired — ResourceLoader modules, hooks, config variables, and dependencies are all declared here.

  • When adding or removing files under modules/, update the corresponding packageFiles or styles list in extension.json
  • Config variables are declared under config in extension.json (prefixed wgTabberNeue)

Commits

  • Use Conventional Commits (e.g. fix:, feat:, refactor:)
  • Use ci: or chore: for non-user-facing changes (tooling, config, dependencies)

i18n

  • Any user-facing string needs a message key in i18n/en.json
  • Every key in en.json must also have a documentation entry in i18n/qqq.json