zostera / django-bootstrap5 / 35421626061

96%

push

github

Warn about settings in BOOTSTRAP5 that the package does not use (#871)

An unknown key in settings.BOOTSTRAP5 was accepted and ignored, so a setting
removed in an earlier release, or carried over from django-bootstrap3 or
django-bootstrap4, went on looking effective while doing nothing.

Adds django_bootstrap5.apps with a system check registered against
django.core.checks. It compares the keys of settings.BOOTSTRAP5 against
BOOTSTRAP5_DEFAULTS and reports each key that is not there as
django_bootstrap5.W001, so it surfaces in manage.py check, runserver and CI,
and can be silenced with SILENCED_SYSTEM_CHECKS. REMOVED_SETTINGS gives a
specific hint for use_i18n, base_url, include_jquery and jquery_url. A
Warning rather than an Error, since an extra key is not fatal.

The AppConfig is found automatically since Django 3.2, so existing users need
no change to INSTALLED_APPS.

BOOTSTRAP5_DEFAULTS gains inline_field_class, which was missing from it while
being read by FieldRenderer and documented in settings.rst. Without this the
check would warn about a setting that does work. The value is None, which is
what get_bootstrap_setting already returned for it, so the effective default
stays col-12 through get_inline_field_class.

Closes #867

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>

197 of 210 branches covered (93.81%)

Branch coverage included in aggregate %.

16 of 16 new or added lines in 1 file covered. (100.0%)

680 of 702 relevant lines covered (96.87%)

13.56 hits per line