pre-commit setup #238

ulgens · 2024-12-06T12:47:42Z

Resolves #237

Trying to import pre-commit config from https://github.com/django/djangoproject.com/blob/ede018f69a7ae5ecacb99978d067f53613d05353/.pre-commit-config.yaml

Differences:

Missing

file-contents-sorter: requirements.txt files already have a different and special ordering.
isort: Not being used by the repo
flake8: Not being used by the repo
djhtml: The repository doesn't have any Django templates
checkmake: Fixes don't seem useful for the repo

Changed

black doesn't exclude migration files
prettier excludes javascript and css files, in addition to already excluded file types

ulgens · 2024-12-06T13:19:42Z

@bmispelon This is still WIP but please let me know if there is something to update / change / fix.

bmispelon · 2024-12-06T15:28:43Z

This is looking very good so far, thanks for tackling it! 🎸

One thing I noted is that the template formatting doesn't seem to understand Trac's weird jinja configuration. See for example the changes proposed in trac-env/templates/site_head.html: I would argue that the indentation was correct since it reflects that we're inside an if "tag".

bmispelon · 2024-12-06T15:33:18Z

.pre-commit-config.yaml

+      - id: end-of-file-fixer
+        exclude_types: [json, sql]
+      - id: file-contents-sorter
+        files: ^(requirements/\w*.txt)$


In this project there's only a single requirements.txt file

Suggested change

files: ^(requirements/\w*.txt)$

files: ^requirements\.txt$

I updated the related commit, should be okay now.

I still see the old line

I guess I messed up the rebase, sorry. Double checked this time, looks okay.

It seems this hook doesn't add value to this repo. The requirements.txt file has a special organization, which gets destroyed when package names are ordered alphabetically. I removed it.

ulgens · 2024-12-06T19:15:06Z

I would argue that the indentation was correct since it reflects that we're inside an if "tag".

I agree with this. Since the files are Jinja templates for Trac, and the checker was looking for Django templates, I removed djhtml hook from teh config.

bmispelon

Excellent changes, thanks for working on this! 🎸

I found a few minor things, but overall this is very good 👍🏻

bmispelon · 2024-12-06T19:52:32Z

.pre-commit-config.yaml

@@ -0,0 +1,63 @@
+default_language_version:
+  python: python3


While comparing this configuration file to the one from djangoproject.com I noticed you're using 2 spaces for indentation while the other file has 4.

Could you change this file to 4 as well, it will make it easier for me to review this PR, and will also make it easier to integrate changes between the two files in the future.

I missed the .editorconfig file, sorry. Once it was in place, the indentation for yaml files became 4 spaces.

bmispelon · 2024-12-06T19:55:50Z

.pre-commit-config.yaml

+            # Trac needs psycopg2
+            # https://github.com/adamchainz/django-upgrade?tab=readme-ov-file#databases
+            --skip,
+            "settings_database_postgresql",


I might be misunderstanding what the settings_database_postgresql fixer does, but I don't think it has to do with psycopg2 vs. psycopg3. It's just a naming alias change and you can use django.db.backends.postgresql with psycopg2.

Addressed this under #243

Should be okay now.

bmispelon · 2024-12-06T20:31:44Z

.pre-commit-config.yaml

+      - id: end-of-file-fixer
+        exclude_types: [json, sql]
+      - id: file-contents-sorter
+        files: ^(requirements/\w*.txt)$


I still see the old line

https://github.com/asottile/pyupgrade?tab=readme-ov-file#yield--yield-from

https://github.com/asottile/pyupgrade?tab=readme-ov-file#super-calls

…ly fixes

bmispelon

This is looking great now, we're almost there! 🏁

I have one last question about the prettier commit hook: does it makes sense to keep it in this project (see comment above exclude_types).

Once that's clarified, I think we're good to go.

Thanks again for working on this!

.pre-commit-config.yaml

bmispelon

I think we're good to go, very nice work 👍🏻

bmispelon reviewed Dec 6, 2024

View reviewed changes

ulgens force-pushed the pre-commit-setup branch 2 times, most recently from 147388a to 23c9516 Compare December 6, 2024 19:10

ulgens marked this pull request as ready for review December 6, 2024 19:15

ulgens requested a review from bmispelon December 6, 2024 19:15

bmispelon requested changes Dec 6, 2024

View reviewed changes

ulgens mentioned this pull request Dec 9, 2024

Rename postgres database engine to stop using an alias #243

Merged

ulgens force-pushed the pre-commit-setup branch 2 times, most recently from 738aa7c to b7e0746 Compare December 9, 2024 09:51

ulgens marked this pull request as draft December 9, 2024 09:52

ulgens added 4 commits December 9, 2024 16:05

Add pyupgrade to pre-commit config

ca2d089

Apply pyupgrade's "yield => yield from" fix

404eb50

https://github.com/asottile/pyupgrade?tab=readme-ov-file#yield--yield-from

Apply pyupgrade's "super() calls" fix

db7dab1

https://github.com/asottile/pyupgrade?tab=readme-ov-file#super-calls

Add django-upgrade to pre-commit config

7212f43

ulgens force-pushed the pre-commit-setup branch 2 times, most recently from 885d5bf to 7504d6d Compare December 11, 2024 18:41

ulgens added 7 commits December 11, 2024 21:57

Add pre-commit-hooks to pre-commit config

1b98b56

Enable "check-shebang-scripts-are-executable" pre-commit hook and app…

2927f83

…ly fixes

Enable "end-of-file-fixer" pre-commit hook and apply fixes

88229cf

Enable "fix-byte-order-marker" pre-commit hook and apply fixes

a959f71

Enable "trailing-whitespace" pre-commit hook and apply fixes

aa39d56

Add black to pre-commit config and apply fixes

797b362

Don't exclude migrations from black

023aad0

ulgens force-pushed the pre-commit-setup branch 2 times, most recently from ff90427 to af783e9 Compare December 11, 2024 19:09

ulgens requested a review from bmispelon December 11, 2024 19:12

ulgens marked this pull request as ready for review December 11, 2024 19:12

bmispelon reviewed Dec 12, 2024

View reviewed changes

.pre-commit-config.yaml Show resolved Hide resolved

.pre-commit-config.yaml Outdated Show resolved Hide resolved

ulgens added 3 commits December 13, 2024 14:34

Add prettier to pre-commit config, and .editorconfig

4ae78d6

Apply prettier fixes

eaa9cfe

Add pyproject-fmt to pre-commit hooks

ab46da9

ulgens force-pushed the pre-commit-setup branch from af783e9 to ab46da9 Compare December 13, 2024 11:34

bmispelon approved these changes Dec 13, 2024

View reviewed changes

bmispelon merged commit 8c24455 into django:main Dec 13, 2024
5 checks passed

ulgens deleted the pre-commit-setup branch December 13, 2024 13:36

ulgens mentioned this pull request Dec 13, 2024

Apply prettier to css files #247

Closed

ulgens mentioned this pull request Mar 30, 2025

Self nominating to join the Website WG django/dsf-working-groups#35

Merged

Uh oh!

pre-commit setup #238

pre-commit setup #238

Uh oh!

Conversation

ulgens commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Missing

Changed

Uh oh!

ulgens commented Dec 6, 2024

Uh oh!

bmispelon commented Dec 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ulgens commented Dec 6, 2024

Uh oh!

bmispelon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bmispelon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bmispelon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ulgens commented Dec 6, 2024 •

edited

Loading