|
| 1 | +import logging |
| 2 | + |
| 3 | +import click |
| 4 | + |
| 5 | +from .. import context, overrides |
| 6 | + |
| 7 | +logger = logging.getLogger(__name__) |
| 8 | + |
| 9 | + |
| 10 | +@click.command() |
| 11 | +@click.pass_obj |
| 12 | +def lint( |
| 13 | + wkctx: context.WorkContext, |
| 14 | +) -> None: |
| 15 | + """Review existing settings and overrides for potential configuration errors.""" |
| 16 | + errors = 0 |
| 17 | + |
| 18 | + logger.info(f"Checking patches in {wkctx.settings.patches_dir}...") |
| 19 | + for entry in wkctx.settings.patches_dir.glob("*"): |
| 20 | + logger.debug(entry) |
| 21 | + if "-" in entry.name: |
| 22 | + actual_package_name, _, version_str = entry.name.rpartition("-") |
| 23 | + expected_package_name = overrides.pkgname_to_override_module( |
| 24 | + actual_package_name |
| 25 | + ) |
| 26 | + if actual_package_name != expected_package_name: |
| 27 | + errors += 1 |
| 28 | + logger.error( |
| 29 | + f"ERROR: Patch directory {entry.name} should be {expected_package_name}-{version_str}" |
| 30 | + ) |
| 31 | + else: |
| 32 | + expected_package_name = overrides.pkgname_to_override_module(entry.name) |
| 33 | + if actual_package_name != expected_package_name: |
| 34 | + errors += 1 |
| 35 | + logger.error( |
| 36 | + f"ERROR: Patch directory {entry.name} should be {expected_package_name}" |
| 37 | + ) |
| 38 | + |
| 39 | + if wkctx.settings_dir is not None: |
| 40 | + logger.info(f"Checking settings files in {wkctx.settings_dir}...") |
| 41 | + for entry in wkctx.settings_dir.glob("*"): |
| 42 | + logger.debug(entry) |
| 43 | + if entry.suffix != ".yaml": |
| 44 | + errors += 1 |
| 45 | + logger.error( |
| 46 | + f"ERROR: settings file {entry.name} should use extension '.yaml'" |
| 47 | + ) |
| 48 | + expected_package_name = overrides.pkgname_to_override_module(entry.stem) |
| 49 | + if entry.stem != expected_package_name: |
| 50 | + errors += 1 |
| 51 | + logger.error( |
| 52 | + f"ERROR: Settings file {entry.name} should be {expected_package_name}.yaml" |
| 53 | + ) |
| 54 | + |
| 55 | + logger.info("Checking entry points...") |
| 56 | + exts = overrides._get_extensions() |
| 57 | + for name in exts.names(): |
| 58 | + logger.debug(name) |
| 59 | + expected_name = overrides.pkgname_to_override_module(name) |
| 60 | + if name != expected_name: |
| 61 | + errors += 1 |
| 62 | + logger.error(f"ERROR: plugin name {name} should be {expected_name}") |
| 63 | + |
| 64 | + if errors: |
| 65 | + raise SystemExit(f"Found {errors} errors") |
0 commit comments