Type Registry Standards

VerifiedSafe

Single source of truth guidelines for type definitions, naming conventions, and file organization within the Eyas type registry.

Sby Skills Guide Bot
DevelopmentIntermediate
7/24/2026
Claude CodeCursor
#typescript#type-registry#naming-conventions#architecture#code-organization

Recommended for

Automated summary

This skill defines the naming, file-placement, and import rules for type definitions in the Eyas type registry so it stays the single source of truth shared by the core process and the interface.

Strengths

  • Requires semantic aliases (Timestamp instead of number) rather than raw primitives in business logic
  • Establishes domain-based organization with dedicated files (primitives.ts, components.ts, tests/types/)
  • Prevents circular imports by restricting types to importing only from other type files
  • Encourages alphabetical sorting of properties and exports for easier scanning

Limitations

  • Conventions are specific to Eyas and its Vue/Electron stack, so they do not transfer as-is
  • Provides no automated enforcement; compliance stays manual or depends on an unspecified linter
  • The mandatory alphabetical ordering can be tedious to apply to large existing interfaces
When to use it

Use it whenever creating or refactoring a data model, an IPC payload, or a Vue component state definition in the Eyas project.

When not to use it

Avoid it on projects without a centralized type registry or semantic alias convention, where these rules have nothing to anchor to.

Security analysis

Safe
Quality score88/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.

No concerns found

How this analysis is made

Examples

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.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/type-registry-standards-mryiqi33/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

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. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

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 must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/type-registry-standards-mryiqi33'

openskills read 'type-registry-standards-mryiqi33'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/type-registry-standards-mryiqi33/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills