Merge pull request #4 from 18F/eg-add-linting

Linting setup

Author: eric-gade

.dir-locals.el

@@ -0,0 +1,11 @@
+((web-mode . (
+              (web-mode-markup-indent-offset . 2)
+              (web-mode-code-indent-offset . 2)
+              (python-flymake-command '("docker compose exec web flake8 ."))
+              (eval web-mode-set-engine 'django)
+              (eval drupal-mode)
+              (eval electric-pair-mode nil)
+              (eval hl-line-mode)))
+ (auto-mode-alist . (
+                     ("\\.html\\'" . web-mode)
+                     ("\\.py\\'" . python-ts-mode))))

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+max-line-length = 120
+max-complexity = 10
+# E203 Whitespace before ':'
+extend-ignore = E203
+# F401 Module imported but unused
+# F403 'from module import *' used
+# E402 Module level import not at top of file
+per-file-ignores = __init__.py:F401,F403,E402
+exclude =
+        .venv
+        weather.gov

Makefile

@@ -28,3 +28,15 @@ pause:
 
 build-css: # Build CSS
 	docker compose run --rm uswds npx gulp compile
+
+python-lint:
+	docker compose exec web python -m black .
+	docker compose exec web python -m flake8 .
+
+template-lint:
+	docker compose exec web djlint weather/templates/ --extension=html
+
+template-format:
+	docker compose exec web djlint weather/templates/ --reformat --extension=html
+
+lint: python-lint template-format template-lint

manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'weathergov.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "weathergov.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +18,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.black]
+line-length=120
+unstable=true
+
+[tool.djlint]
+# H030 Consider adding a meta description.
+# H031 Consider adding meta keywords.
+# H006 img tag should have height and width attributes.
+# H023 Do not use entity references.
+# H020 Empty tag pair found. Consider removing.
+# H021 Inline styles should be avoided.
+ignore="H030,H031,H006,H023,H020,H021"
+indent=2
+
+
+[tool.mypy]
+ignore_missing_imports = true

requirements.txt

@@ -2,3 +2,6 @@ Django>=5.0
 psycopg2>=2.8
 mysqlclient>=2.2
 requests
+black
+djlint
+flake8

weather/admin.py

@@ -1,3 +1,3 @@
-from django.contrib import admin
+# from django.contrib import admin
 
 # Register your models here.

weather/apps.py

@@ -2,5 +2,5 @@
 
 
 class WeatherConfig(AppConfig):
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'weather'
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "weather"

weather/context_processors.py

@@ -1,9 +1,10 @@
 from django.conf import settings
 
+
 def route_info(request):
     return {
-        'path_name': request.resolver_match.view_name,
-        'site_name': settings.SITE_NAME,
-        'site_slogan': settings.SITE_SLOGAN,
-        'site_logo': settings.SITE_LOGO
+        "path_name": request.resolver_match.view_name,
+        "site_name": settings.SITE_NAME,
+        "site_slogan": settings.SITE_SLOGAN,
+        "site_logo": settings.SITE_LOGO,
     }

weather/models.py

@@ -1,3 +1,3 @@
-from django.db import models
+# from django.db import models
 
 # Create your models here.