Zod plugin

[Rei-x]

eslint-plugin-zod

[ssynowiec]

Coś konkretnego tam ma być skonfigurowane?

[kguzek]

Coś konkretnego tam ma być skonfigurowane?

https://github.com/marcalexiei/eslint-zod/tree/main/plugins/eslint-plugin-zod

trzebaby potestować domyślne opcje jakie są, czy dużo wywalałyby w obecnych projektach i poczytać jakie są best practices w Zodzie. Sugeruję testowanie z https://github.com/Solvro/web-topwr bo tam jest dość zaawansowany usage Zoda z TS

[ssynowiec]

W takim razie moja propozycja:

consistent-import (spójne importy zod'a) zaproponowane przez @Antoni-Czaplicki w #823

[na podstawie używania zoda w projekcie ToPWR]
Style & consistency
consistent-schema-var-name warn (spójne nazewnictwo zmiennych zod np.: UserSchema wszystkie muszą się kończyć 'Shchema')
consistent-schema-output-type-style (spójny styl typów wyjściowych — wymagane
użycie z.infer<>)
array-style (spójny styl tablic — wymagane użycie formy funkcji z.array() zamiast
.array()) [tutaj bym może ponegocjował bo moim zdaniem .array() lepsze]

Disallow unsafe patterns
no-any-schema (zakaz używania z.any())
no-empty-custom-schema (zakaz pustych schematów niestandardowych)
no-optional-and-default-together (zakaz łączenia .optional() z .default()) [wykluczają się]
no-throw-in-refine (zakaz rzucania wyjątków wewnątrz .refine())
no-transform-in-record-key (zakaz transformacji w kluczach z.record())

Preferred patterns
prefer-enum-over-literal-union warn (preferowanie z.enum() zamiast unii literałów)
prefer-strict-object? (preferowanie z.strictObject() zamiast z.object())
prefer-string-schema-with-trim (preferowanie .trim() przy schematach stringowych)
prefer-trim-before-string-length-checks (.trim() musi poprzedzać sprawdzanie
długości stringa)
require-error-message (wymaganie wiadomości błędu w walidacjach)

Wyłączone reguły (specyficzne dla Zod v4)
Reguły takie jak no-native-enum, no-promise-schema, prefer-loose-object, prefer-meta i inne v4-specificzne są wyłączone (off) — włączone dopiero w konfiguracji zod-v4. (ToPWR używa obecnie v3)

[kguzek]

prefer-strict-object? (preferowanie z.strictObject() zamiast z.object())

Co do tego nie jestem pewien - nonstrictowe obiekty mają swoje zastosowanie. Oprócz tego wszystkie rulesy wydają się spoko

Ja bym do wszystkich dał error. warningi trochę nie mają sensu jeśli celem projektu jest jednolita konfiguracja

zobacz #531

[ssynowiec]

Co do tego nie jestem pewien - nonstrictowe obiekty mają swoje zastosowanie. Oprócz tego wszystkie rulesy wydają się spoko

właśnie ja też, stąd ? tam.

A te warny to wpisałem bo są takie niby dobre, ale np const positiveNumber = z.number().positive() takie coś np nie potrzebuje się nazywać positiveNumberSchema

2 warn enum a literal to jednak troszeczkę coś innego, z jednej strony można by spokojnie zamienić na enumy, ale

PS: czytałem tego issue i całkowicie się zgadzam

[kguzek]

np const positiveNumber = z.number().positive() takie coś np nie potrzebuje się nazywać positiveNumberSchema

Uważam że dużo większym plusem byłoby ujednolicenie nazewnictwa schematów niż minusem byłyby momentami długawe nazwy schematów pomocniczych, i powinniśmy to dodać mimo to

2 warn enum a literal to jednak troszeczkę coś innego, z jednej strony można by spokojnie zamienić na enumy, ale

Masz jakieś konkretne przykłady na myśli? jak czytam sobie dokumentację tej zasady to nie potrafię wymyślić scenariusza, w którym nie powinno to być surowo pilnowane

[ssynowiec]

Nie mam konkretnego przykładu i w sumie jak się wczytuję w te docsy to tam nawet jest sekcja When Not To Use It i nic z tego nas nie dotyczy

wrzucony config z errorami: 703cc7d

[Antoni-Czaplicki]

Ja bym do wszystkich dał error. warningi trochę nie mają sensu jeśli celem projektu jest jednolita konfiguracja

dla np. zod/prefer-string-schema-with-trim i zod/prefer-trim-before-string-length-checks dawanie errorów wytaje się kontrproduktywne - na spokojnie mogę sobie wyobrazić sytuację w której nie chcemy sprawdzać długości lub też ucinać białych znaków

[kguzek]

mogę sobie wyobrazić sytuację w której nie chcemy sprawdzać długości lub też ucinać białych znaków

podasz jakieś przykłady?

[Antoni-Czaplicki]

pole json w testowniku do edycji quizu albo jakiś edytor wyswig (długość), jakieś pola do notatek (whitespace)