Normes du registre de types

VérifiéSûr

Guide de référence unique pour les définitions de types, conventions de nommage et organisation des fichiers dans le registre de types Eyas.

Spar Skills Guide Bot
DeveloppementIntermédiaire
24/07/2026
Claude CodeCursor
#typescript#type-registry#naming-conventions#architecture#code-organization

Recommandé pour

Synthèse automatique

Cette skill fixe les règles de nommage, de classement et d'import des définitions de types dans le registre de types Eyas, afin qu'il reste la source unique de vérité partagée entre le processus core et l'interface.

Points forts

  • Impose des alias sémantiques (Timestamp au lieu de number) au lieu des primitives brutes dans la logique métier
  • Définit une organisation par domaine avec des fichiers dédiés (primitives.ts, components.ts, tests/types/)
  • Interdit les imports circulaires en limitant les types à d'autres fichiers de types
  • Préconise le tri alphabétique des propriétés et des exports pour faciliter la lecture

Limites

  • Les conventions sont spécifiques à Eyas et à sa stack Vue/Electron, peu transposables telles quelles ailleurs
  • Ne fournit aucun outil de vérification automatique : le respect des règles reste manuel ou dépend d'un linter non décrit
  • Le caractère obligatoire du tri alphabétique peut être coûteux à appliquer sur des interfaces existantes volumineuses
Quand l'utiliser

À utiliser dès qu'on crée ou refactorise un modèle de données, une charge utile IPC ou un état de composant Vue dans le projet Eyas.

Quand l'éviter

À éviter sur un projet sans registre de types centralisé ni convention d'alias sémantiques, où ces règles n'ont pas de point d'ancrage.

Analyse de sécurité

Sûr
Score qualité88/100

The skill is a purely documentation-based set of coding standards for type definitions and file organization. It declares no tools and contains no commands, scripts, network access, secret handling, or destructive instructions.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

New data model
I need to add a new data model for test-server configuration in Eyas. Create it following the type registry standards: pick the right domain file, use semantic aliases from primitives.ts, and sort the properties alphabetically.
Refactor inline type
This Vue component defines an inline object type for its local state. Check whether a matching type already exists in src/types/, and if not, create it there per the registry standards and reference it from the component.
Naming audit
Review src/types/menu.ts and tell me which type names, property types, and ordering violate the type registry standards, then apply the fixes.

name: type-registry-standards description: Single source of truth guidelines for type definitions, naming conventions, and file organization within the Eyas type registry. tags:

  • types
  • registry
  • architecture

Reusable Skill: Type Registry Standards

Overview

The type registry is the single source of truth for all data structures in Eyas. It ensures consistency across the core process and the interface.

When to Use

  • Trigger when creating new data models, IPC payloads, or Vue component state definitions.
  • Trigger when refactoring existing interfaces in src/types/.

Instructions

1. Naming Conventions

  • PascalCase: All types and interfaces must use PascalCase.
  • Semantic Aliases: Avoid using raw primitives (string, number, boolean) in business logic. Use semantic aliases from primitives.ts.
    • Correct: startTime: Timestamp
    • Incorrect: startTime: number
  • VM Suffix: ViewModels or state objects used by Vue components should be suffixed with VM.

2. File Organization

  • Domain-Based: Group types by domain (e.g., menu.ts, test-server.ts).
  • Primitives: Base semantic aliases reside in primitives.ts.
  • Component Registry: Interface-specific structures reside in components.ts.
  • Test-Specific Types: Types used exclusively for testing (e.g., mocks, stubs) must reside in the tests/types/ directory to ensure complete physical isolation from production definitions.

3. Rules & Constraints

  • Registry-First: Before defining an inline object in a component or function, check if a type already exists in src/types/. If not, create it.
  • No Circular Imports: Types should not import from code files (.ts or .vue). They should only import from other type files.
  • Alphabetical Sorting: Properties within interfaces and exports within files should be sorted alphabetically to maintain scannability.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/type-registry-standards-mryiqi33/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/type-registry-standards-mryiqi33' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/type-registry-standards-mryiqi33/download' --output '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md.part' && mv '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md.part' '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md' && test -s '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/type-registry-standards' && cp -R '.skill-downloads/type-registry-standards-mryiqi33' '.claude/skills/type-registry-standards'

Cursor
test -f '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md' && test -s '.skill-downloads/type-registry-standards-mryiqi33/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/type-registry-standards' && cp -R '.skill-downloads/type-registry-standards-mryiqi33' '.cursor/skills/type-registry-standards'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/type-registry-standards-mryiqi33'

openskills read 'type-registry-standards-mryiqi33'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/type-registry-standards-mryiqi33/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires