Skip to content

Commit

Permalink
Update 0001-define-code-style.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierteres authored Feb 1, 2024
1 parent e046b49 commit e665caa
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/adr/0001-define-code-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,20 +70,23 @@ Pel que fa a formatar el codi al desenvolupar és una decisió pròpia de cada p

Al programar veurem els errors que ens marca `flake8` i al guardar se'ns formata automàticament el codi amb `autopep8`. Aquestes dues eines tindran en compte la configuració dels fitxers `.flake8` i `.pycodestyle` del repositori.

#### Amb l'eina `pre-commit
#### Amb l'eina `pre-commit` automàticament al fer un _commit_

1. Instal·lem `pre-commit` al `venv` de `erp`: `pip install pre-commit`
2. Activem el `pre-commit` dins el repositori: `pre-commit install`

Al fer un _commit_ ens formatarà el codi automàticament amb `autoflake` i `autopep8`. També farà les comprovacions amb `flake8` i algunes altres pels XML i fitxer YAML.
*Podem desactivar-lo sempre que vulguem: `pre-commit uninstall`*

Al fer un _commit_ ens formatarà automàticament el codi dels fitxers modificats amb `autoflake` i `autopep8`. També farà les comprovacions amb `flake8` i algunes altres pels XML i fitxer YAML.

- Si algun formatador fa algun canvi o no passen totes les comprovacions el _commit_ no es farà.
- Els fitxers modificats pel `pre-commit` queden _unstaged_.
- Fa el mateix que farà el GitHub Actions (definit al fitxer `.pre-commit-config.yaml`).

#### Amb l'eina `pre-commit manualment, sense força que es passi al fer cada commit
1.- Anem a la carpeta del repositori
2.- Executem `pre-commit run -a`
#### Amb l'eina `pre-commit` manualment, sense força que es passi al fer cada _commit_

1. Anem a la carpeta del repositori
2. Executem `pre-commit run -a` (tots els fitxers del repositori) o `pre-commit run --files` (fitxers especificats)

## Conseqüències

Expand Down

0 comments on commit e665caa

Please sign in to comment.