Jak wymusić formatowanie kodu w projekcie?

Jak wymusić formatowanie kodu w projekcie?
Bartosz36
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 3 lata
  • Postów:348
0

Witam!

Poszukuję narzędzia, które umożliwi mi formatowanie i sprawdzanie formatowania kodu C++ w projekcie.
Projekt oparty głównie o Visual Studio, obejmuje też środowisko Node.js, development z użyciem Windows OS.

Sporo się naszukałem i znalazłem jedynie:

  • clang-format - Całkiem niezły, ale baardzo ciężko mi odpalić go dla konkretnych typów plików (.cpp, .hpp, .h), zazwyczaj dostaję na twarz błąd mówiący, że coś jest folderem, albo rzuca błędami z plików w zupełnie innych formatach. Dodatkowo dokumentacja (moim zdaniem) nie jest zbyt pomocna...
  • .editorconfig - niby w porządku, ale nie sprawdza wszystkiego, w większości pozwala łatwo go obejść i przede wszystkim: nie widzę możliwości odpalenia jakiegokolwiek sprawdzenia z poziomu linii poleceń.

To, czego szukam powinno zapewniać:

  • możliwość sprawdzenia z poziomu linii poleceń - musi rzucić błędem, gdy kod nie będzie się pokrywał z ustawieniami
  • musi być łatwo konfigurowalny w CI - w zasadzie pokrywa się z poprzednim punktem, ale chodzi też o to, że nie chcę robić zbyt wielu udziwnień w konfiguracji runnera CI by odpalić sprawdzenie formatowania kodu...
  • musi być jak najbardziej samodzielny - zależy mi na tym, by nie instalować nie wiadomo ile narzędzi, plików i innych tego typu, by móc sprawdzić format
  • opcjonalnie: powinien umożliwiać sformatowanie i zedytowanie plików lokalnie, zanim zrobi się commita.

Póki co mam wrażenie, że w innych językach jest to dużo prostsze, a przede wszystkim w ogóle łatwo dostępne. Więc wątpię by w języku takim jak C++ nie było odpowiednich narzędzi.

Mam nadzieję, że będziecie mi w stanie polecić coś, co będę mógł wykorzystać, biorąc pod uwagę używane narzędzie i środowisko.

Dziękuję!


ExtendedVector czyli std::vector<T> z wygodą List<T> z .NET (ForEach, FindAll, itd...)
CE
  • Rejestracja:około 4 lata
  • Ostatnio:około 3 lata
  • Postów:48
2

@Bartosz36: Mam wrażenie, że clang-format odpowiada na twoje zapotrzebowania, powinienneś się z nim pogodzić. Po prostu napisz skrypt, który odpali odpowienią komendę dla plików z odpowiednim rozszerzeniem.

edytowany 2x, ostatnio: Cepo
Bartosz36
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 3 lata
  • Postów:348
0

@Cepo: Trochę też skłaniam się ku clang-format, jednak odpycha mnie od niego fakt, że ciężko mi opracować prawidłową komendę.
Na przykład na SO znalazłem wątek, w którym zaakceptowana odpowiedź:

Kopiuj
clang-format -i -style=WebKit *.cpp *.h

zwracało mi:

Kopiuj
Formatting *.cpp
invalid argument
Formatting *.h
invalid argument
Error: clang-format exited with exit code 1.

Dla innych poleceń ( */**, **/** i inne dziwne wymysły) otrzymywałem taki sam błąd lub is a directory.


ExtendedVector czyli std::vector<T> z wygodą List<T> z .NET (ForEach, FindAll, itd...)
CE
Nie możesz napisać skryptu w pythonie, który sprawdzi czy plik nie jest folderem i jakie ma rozszerzenie? Nie jestem devopsem, ale na linuxie byłaby to jedna linia w bashu, żeby zautomatyzować clang-format.
Althorion
Moderator C/C++
  • Rejestracja:prawie 10 lat
  • Ostatnio:około 13 godzin
  • Postów:1603
4

To wygląda, po prostu, na niedorobioną powłokę, która nie obsługuje globbingu. Windowsowy cmd? Jak tak, no to cóż — musisz napisać tam napisać pętlę po plikach… ale wygodniej Ci będzie przesiąść na coś lepszego. Chociażby na PowerShella.

edytowany 1x, ostatnio: Althorion
_13th_Dragon
Miałeś na myśli: ... musisz napisać tam napisać pętlę tam pętlę po plikach tam plikach ... ? :p
Althorion
Prawie, jeszcze jedno „musisz” miało być na końcu. :P
_13th_Dragon
  • Rejestracja:ponad 19 lat
  • Ostatnio:2 miesiące
3
Bartosz36 napisał(a):
Kopiuj
Formatting *.cpp
invalid argument

Czyli pod windowsami ...

Kopiuj
for %i in (*.cpp,*.h) do clang-format -i -style=WebKit %i

Uwaga! w pliku .bat podwoić znaki %


Wykonuję programy na zamówienie, pisać na Priv.
Asm/C/C++/Pascal/Delphi/Java/C#/PHP/JS oraz inne języki.
edytowany 1x, ostatnio: _13th_Dragon
Bartosz36
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 3 lata
  • Postów:348
0

@Cepo:

Nie możesz napisać skryptu w pythonie, który sprawdzi czy plik nie jest folderem i jakie ma rozszerzenie?

W tym rzecz, widzisz, już zaczyna się instalowanie Pythona, a to pisanie "prostych skryptów", a ja chciałbym zawołać to jedną linijką, na przykład dla ESLint całość wygląda tak:

Kopiuj
npx eslint ./src --fix

I mam całe źródła naprawione albo przynajmniej sprawdzone.

@Althorion: Rzecz w tym, że już korzystam właśnie z PS (ale mój błąd, widzę, że zapomniałem o tym wspomnieć).


ExtendedVector czyli std::vector<T> z wygodą List<T> z .NET (ForEach, FindAll, itd...)
_13th_Dragon
Normalnym batch'em to zrób
_13th_Dragon
  • Rejestracja:ponad 19 lat
  • Ostatnio:2 miesiące
1
Bartosz36 napisał(a):

... a ja chciałbym zawołać to jedną linijką ...

Podąłem ci tą jedną linijkę, w czym problem?
Możesz ją zrobić jako skrót lub zapisać do pliku .bat


Wykonuję programy na zamówienie, pisać na Priv.
Asm/C/C++/Pascal/Delphi/Java/C#/PHP/JS oraz inne języki.
Bartosz36
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 3 lata
  • Postów:348
0

@_13th_Dragon: Gdyby było mi to pomocne, to bym oznaczył odpowiedź, ale dostawałem:

Kopiuj
PS C:\Dev\Projects\myProj> for %i in (*.cpp,*.hpp) do npx clang-format -i %i
+ for %i in (*.cpp,*.hpp) do npx clang-format -i %i
+    ~
Missing opening '(' after keyword 'for'.
At line:1 char:17
+ for %i in (*.cpp,*.hpp) do npx clang-format -i %i
+                 ~
Missing argument in parameter list.
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : MissingOpenParenthesisAfterKeyword

PS C:\Dev\Projects\MyProj> for(%i in (*.cpp,*.hpp)) do npx clang-format -i %i
+ for(%i in (*.cpp,*.hpp)) do npx clang-format -i %i
+                 ~
Missing argument in parameter list.
At line:1 char:25
+ for(%i in (*.cpp,*.hpp)) do npx clang-format -i %i
+                         ~
Missing statement body in for loop.
At line:1 char:28
+ for(%i in (*.cpp,*.hpp)) do npx clang-format -i %i
+                            ~
Missing statement body in do loop.
    + FullyQualifiedErrorId : MissingArgument

i szczerze mówiąc nie chce mi się w to bawić, gdyż tak jak zaznaczałem wcześniej: zależy mi na możliwie jak najprostszym rozwiązaniu, tymczasem idzie to w stronę kolejnych skryptów i udziwnień.

Więc odpowiadając na Twoje pytanie: W tym problem.


ExtendedVector czyli std::vector<T> z wygodą List<T> z .NET (ForEach, FindAll, itd...)
_13th_Dragon
Jak okulary wsadzisz sobie w ... tam gdzie słońce nie dochodzi ... to też nie będą działać. Dziwnie, nieprawdaż?
Althorion
Moderator C/C++
  • Rejestracja:prawie 10 lat
  • Ostatnio:około 13 godzin
  • Postów:1603
2

Biorąc pod uwagę, że Ty nie masz problemów z używanym narzędziem formatującym, tylko z powłoką, to raczej wszystko jedno, co wybierzesz, te problemy nie znikną…

_13th_Dragon
  • Rejestracja:ponad 19 lat
  • Ostatnio:2 miesiące
0

@Bartosz36: to nie PS to zwykły batch.
Dla PS:

Kopiuj
foreach($file in Get-ChildItem -Path c:\temp\* -Include *.cpp,*.hpp) { npx clang-format -i $file.Name }

Wykonuję programy na zamówienie, pisać na Priv.
Asm/C/C++/Pascal/Delphi/Java/C#/PHP/JS oraz inne języki.
edytowany 2x, ostatnio: _13th_Dragon
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)