Consider testing strategy for keeping commonTypes regex in sync with TSOA JSDoc @pattern decorators
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- Active
- Stack technique
- typescript
- Domaine
- backend-api-design, testing
Piste de recherche
The regex patterns live in application/common/types/commonTypes.ts, and the matching TSOA @pattern JSDoc tags sit in the various common type files that import them. Before writing code, decide whether a consistency test is worth building or whether the discussion should move to a Zod migration, which the issue asks you to scope. Done means either an agreed testing approach with a test that fails when a regex and its @pattern tag diverge, or a written scope for the Zod change.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
In review comments on #937 @iamtanuj18 and @plouka13 - pointed out that it would be good to have a mechansism to ensure the regex in application/common/types/commonTypes.ts are consistent with the JSDoc TSOA @pattern decorators in the various common types.
I started writing a test to check these were consistent, but I think it deserves being thoughtful about how best to test this (or if it was worth it to spend that time scoping what a change to using Zod would require).
- Langage dominant
- TypeScript
- Étoiles
- 4
- Forks
- 0
- Merge moyen
- 8 h 37 min
- PR mergées (30 j)
- 3
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de Garvan-Data-Science-Platform/ctrl
-
backend enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 63/100
-
Difficulté 1/5 1-3 heures Accessibilité débutants 82/100
-
admin-client backend bug
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
backend bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Garvan-Data-Science-Platform/ctrl#970 · 1 commentaire ·
-
backend bug
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Toutes les issues de Garvan-Data-Science-Platform/ctrl
Issues similaires
-
Add: Class TV ModaOuvertecheck:passed streams:add
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
GiganticMinecraft/seichi-playguide#183 ·
Les mainteneurs répondent en général sous 1 jour
-
area: core complexity: easy impact: medium
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
ueberdosis/tiptap#8668 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
longbridge/nsh#804 ·
Les mainteneurs répondent en général sous 1 jour