Implement config files

CHANGELOG.md

@@ -14,6 +14,7 @@ Features/fixes:
 * Run checks on RunSQL migration operations
 * Rename the RunPython data migration lint checks for improved consistency
 * Refactor and commonise the loggers, so that all modules the `django_migration_linter` logger
+* Allow using configuration file for linter options
 
 Others:
 * Switched from Travis CI to GitHub Actions for tests

django_migration_linter/management/commands/lintmigrations.py

@@ -1,3 +1,4 @@
+import configparser
 import logging
 import os
 import sys
@@ -9,6 +10,15 @@ from ...constants import __version__
 from ...migration_linter import MessageType, MigrationLinter
 from ..utils import register_linting_configuration_options
 
+CONFIG_NAME = "django_migration_linter"
+DEFAULT_CONFIG_FILES = (
+    ".{}.cfg".format(CONFIG_NAME),
+    "pyproject.toml",
+    "setup.cfg",
+    "tox.ini",
+    ".editorconfig",
+)
+
 
 class Command(BaseCommand):
     help = "Lint your migrations"
@@ -107,20 +117,60 @@ class Command(BaseCommand):
         else:
             logging.basicConfig(format="%(message)s")
 
+        config_parser = configparser.ConfigParser()
+        config_parser.read(DEFAULT_CONFIG_FILES)
+
+        ignore_name_contains = options["ignore_name_contains"] or config_parser.get(
+            CONFIG_NAME, "ignore_name_contains", fallback=None
+        )
+        ignore_name = options["ignore_name"] or config_parser.get(
+            CONFIG_NAME, "ignore_name", fallback=None
+        )
+        include_apps = options["include_apps"] or config_parser.get(
+            CONFIG_NAME, "include_apps", fallback=None
+        )
+        exclude_apps = options["exclude_apps"] or config_parser.get(
+            CONFIG_NAME, "exclude_apps", fallback=None
+        )
+        database = options["database"] or config_parser.get(
+            CONFIG_NAME, "database", fallback=None
+        )
+        cache_path = options["cache_path"] or config_parser.get(
+            CONFIG_NAME, "cache_path", fallback=None
+        )
+        no_cache = options["no_cache"] or config_parser.get(
+            CONFIG_NAME, "no_cache", fallback=None
+        )
+        applied_migrations = options["applied_migrations"] or config_parser.get(
+            CONFIG_NAME, "applied_migrations", fallback=None
+        )
+        unapplied_migrations = options["unapplied_migrations"] or config_parser.get(
+            CONFIG_NAME, "unapplied_migrations", fallback=None
+        )
+        exclude_migration_tests = options[
+            "exclude_migration_tests"
+        ] or config_parser.get(CONFIG_NAME, "exclude_migration_tests", fallback=None)
+        quiet = options["quiet"] or config_parser.get(
+            CONFIG_NAME, "quiet", fallback=None
+        )
+        warnings_as_errors = options["warnings_as_errors"] or config_parser.get(
+            CONFIG_NAME, "warnings_as_errors", fallback=None
+        )
+
         linter = MigrationLinter(
             settings_path,
-            ignore_name_contains=options["ignore_name_contains"],
+            ignore_name_contains=ignore_name_contains,
-            ignore_name=options["ignore_name"],
+            ignore_name=ignore_name,
-            include_apps=options["include_apps"],
+            include_apps=include_apps,
-            exclude_apps=options["exclude_apps"],
+            exclude_apps=exclude_apps,
-            database=options["database"],
+            database=database,
-            cache_path=options["cache_path"],
+            cache_path=cache_path,
-            no_cache=options["no_cache"],
+            no_cache=no_cache,
-            only_applied_migrations=options["applied_migrations"],
+            only_applied_migrations=applied_migrations,
-            only_unapplied_migrations=options["unapplied_migrations"],
+            only_unapplied_migrations=unapplied_migrations,
-            exclude_migration_tests=options["exclude_migration_tests"],
+            exclude_migration_tests=exclude_migration_tests,
-            quiet=options["quiet"],
+            quiet=quiet,
-            warnings_as_errors=options["warnings_as_errors"],
+            warnings_as_errors=warnings_as_errors,
         )
         linter.lint_all_migrations(
             git_commit_id=options["commit_id"],

docs/usage.md

@@ -6,7 +6,7 @@ The linter is installed as a Django app and is integrated through the Django man
 
 `python manage.py lintmigrations [GIT_COMMIT_ID] ...`
 
-Detailed command line options:
+Below the detailed command line options, which can all also be defined using a config file (`setup.cfg`, `tox.ini`, `myproject.toml`, `.editorconfig`, `.django_migration_linter.cfg`):
 
 |                   Parameter                                  |                                        Description                                                                          |
 |--------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
@@ -27,6 +27,16 @@ Detailed command line options:
 |`--quiet or -q {ok,ignore,warning,error}`                     | Suppress certain output messages, instead of writing them to stdout.                                                        |
 |`--warnings-as-errors`                                        | Handle warnings as errors and therefore return an error status code if we should.                                           |
 
+## File configuration
+
+Example `setup.cfg` file:
+
+```
+[django_migration_linter]
+no_cache = True
+exclude_apps = users
+```
+
 ## Ignoring migrations
 
 You can also ignore migrations by adding an `IgnoreMigration()` to your migration operations: