professional-wiki/wikibase-faceted-search

Enhances MediaWiki's search with faceted search capabilities. Filter results based on instance type or statement values

dev-master 2025-01-21 21:50 UTC

Requires

• php: >=8.1
• composer/installers: ^2|^1.0.1
• opis/json-schema: ^2.3.0
• psr/log: ^1.1.4
• ruflin/elastica: ^7.1.0

Requires (Dev)

• mediawiki/mediawiki-codesniffer: ^45.0.0
• phpstan/phpstan: ^2.0.1

GPL-2.0-or-later

• Professional.Wiki

• search
• query
• elasticsearch
• mediawiki
• wikibase
• faceted search
• cirrussearch
• haswbstatement

README

Wikibase Faceted Search enhances MediaWiki's search with faceted search capabilities. Filter results based on instance type or statement values.

• Introduction to the extension
• Usage documentation
• Installation
• Configuration
• Development
• Release notes

Get professional support for this extension via Professional Wiki, its creators and maintainers. We provide MediaWiki Development, MediaWiki Hosting, and MediaWiki Consulting services.

Development

Run composer install in extensions/WikibaseFacetedSearch/ to make the code quality tools available.

Running Tests and CI Checks

You can use the Makefile by running make commands in the WikibaseFacetedSearch directory.

Commands to run in a MediaWiki environment/container:

• make or make ci: Run everything
• make test: Run all PHP tests
• make phpunit --filter FooBar: run only PHPUnit tests with FooBar in their name
• make cs: Run PHP style checks and static analysis
• make phpcs: Run PHP style checks
• make stan: Run PHP static analysis
• make stan-baseline: Update the PHPStan baseline file (which contains errors we wish to ignore)

Commands that use Docker:

• make jest Run JS tests
• make lint Lint JS, CSS, and i18n files
• make js Run all JS checks

Release Notes

Version 1.0.0 - TBD

• TODO
• Compatibility with MediaWiki 1.43
• Compatibility with PHP 8.1 up to (at least) 8.3