pre-commit met Black, in combinatie met local repo

[UPPERKEES]

Ik gebruik een pre-commit hook voor Python code, daar gebruik ik Black voor. Maar de onderstaande config pakt niet de .py en .py.j2 files. De j2 zijn Jinja2 files die ik soms in Ansible gebruik.

Gebruik je ook pre-commit? Als local repo, dus niet via een GitHub URL. If so, kan je dan je config delen? Dan zie ik wel wat ik fout doe

code:

repos:
- repo: local
  hooks:
  - id: black
    name: Black
    entry: black --diff
    language: system
    types: [file, python]
    files: \.(py.j2|py)$

[RobIII]

Die vragen die er staan wanneer je hier een nieuw topic opent staan er niet voor niets.

Mijn vraag
...

Relevante software en hardware die ik gebruik
...

Wat ik al gevonden of geprobeerd heb
...

Dus het vriendelijke verzoek je topicstart even aan te vullen

[UPPERKEES]

Ik heb heel veel combinatie gebruikt die allemaal niet werken. Dus daarom dacht ik, ik bespaar een verslag van wat niet werkt en vraag of iemand een werkende config heeft.

Dit is bijvoorbeeld eentje:

code:

-   repo: local
    hooks:
    -   id: black
        name: black
        entry: black --check
        language: system
        types: [python]

Maar zo zijn er nog ontzettend veel combinatie mogelijk, wat wel makkelijk werkt voor YAML, werkt niet voor Python. Of voor Ansible.

code:

- id: ansible-lint
    name: ansible-lint
    entry: ansible-lint --exclude=.pre-commit-config.yaml --exclude=molecule/default/molecule.yml --exclude=.yamllint.yml
    language: system
    types: [file, yaml]
  - id: yamllint
    name: yamllint
    entry: yamllint
    language: system
    types: [file, yaml]

[Renzmeister]

Ik weet niet zeker of ik je hier mee verder help, maar als ik in de repo van mijn werk kijk, zie ik dat de regex van files: steeds begint met een ^ en eindigt met $. Dus waarschijnlijk is het iets van:

code:

files: ^(.*\.py\.j2|.*\.py)$

Maar dit schud ik nu even uit de losse pols.

[UPPERKEES]

Probleem gevonden, ik moet niet `--diff` gebruiken, maar `--check` als switch voor Black.

[Vihaio]

Renzmeister schreef op vrijdag 19 augustus 2022 @ 17:44:
Ik weet niet zeker of ik je hier mee verder help, maar als ik in de repo van mijn werk kijk, zie ik dat de regex van files: steeds begint met een ^ en eindigt met $. Dus waarschijnlijk is het iets van:

code:

files: ^(.*\.py\.j2|.*\.py)$

Maar dit schud ik nu even uit de losse pols.

Dat doet hetzelfde als de regex uit de startpost.

code:

\.py$

Pakt alle files die eindigen met .py

code:

^.*\.py$

Pakt alle files die beginnen met 0 tot n willekeurige karakters en eindigen met .py

[Morrar]

UPPERKEES schreef op zaterdag 20 augustus 2022 @ 07:41:
Probleem gevonden, ik moet niet `--diff` gebruiken, maar `--check` als switch voor Black.

Je zou die check er ook af kunnen halen; dan formatteert black de lokale bestanden meteen. Als er iets veranderd wordt door black, kun je meteen stagen en weer comitten.

Verder hebben wij hier wel discussies gehad over black uit lokaal repo vs de standaard hook die black beschikbaar stelt. Voordeel van lokaal is dat je dezelfde versie gebruikt als dat je black handmatig aftrapt. Nadeel is dat je wel afhankelijk bent van of black wel geïnstalleerd staat in de omgeving.

[ Voor 28% gewijzigd door Morrar op 23-08-2022 17:31 ]

[UPPERKEES]

Morrar schreef op dinsdag 23 augustus 2022 @ 17:29:
[...]


Je zou die check er ook af kunnen halen; dan formatteert black de lokale bestanden meteen. Als er iets veranderd wordt door black, kun je meteen stagen en weer comitten.

Verder hebben wij hier wel discussies gehad over black uit lokaal repo vs de standaard hook die black beschikbaar stelt. Voordeel van lokaal is dat je dezelfde versie gebruikt als dat je black handmatig aftrapt. Nadeel is dat je wel afhankelijk bent van of black wel geïnstalleerd staat in de omgeving.

Lijkt me niet echt handig om code net voordat je commit automatisch aan te passen. Black gaat vaak goed, maar ik laat de boel liever falen en dat de dev zelf even gaat kijken wat reformatted moet worden of niet.

Config management zorgt dat Black installed is, net zoals de wrappers voor het clone van repo's waarbij pre-commit gelijk ook installed is als hook. Ik prefereer local packages, dan weet je zeker dat alles compatibel is en getest. Dat is het mooie van Linux distros, het neemt veel QA werk uit handen

[Morrar]

Tja, wij volgen black eigenlijk blindeling omdat iedereen dan op hetzelfde uitkomt; anders krijg he weer discussies over stijl die meestal hetzelfde verlopen als discussies over smaak... Iets met daar valt niet over te twisten Als je echt ontevreden bent kun je altijd nog commentaren gebruiken voor bepaalde secties / regels:

Python:

#fmt: on
...
#fmt: off

#fmt: skip
...

Wij gebruiken inderdaad ook lokale versies van de packages, die we installeren via cookiecutter templates. Deze templates zetten ook meteen de package structuur, python omgeving, git en pre-commit klaar. Voorbeeldje: https://github.com/LFKoning/cookiecutter_package