typescript types

Engineering Community

Skill notes

Goal

Generate complete TypeScript type code and file updates, not concept-only guidance.

Required Folder Convention

Always follow this structure: Rules: One feature per folder under src/types/<feature>. One types.ts file per feature folder. Do not mix multiple features in one types file.

Generation Workflow

When asked to add or create types for a feature: Create or update src/types/<feature>/types.ts. Organize definitions in section order: Enums Core interfaces

Interface vs Type Rules

Use interface for object shapes by default: Entities DTO objects API response object shapes Class contracts

Enum Rules

Use string enum or const enum only: Feature-specific enums in feature types.ts. Shared enums in src/types/common/types.ts. Prefer union type over enum only for tiny, local-only literal sets. Never generate numeric enums.

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Engineering
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@tomevault-io · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Output preview typescript-types.preview
# Required Outputs Per Task

- `src/types/<feature>/types.ts` with complete definitions.
- `src/types/index.ts` export update.
- `src/types/common/types.ts` updates.
- `src/types/index.ts` export update.
- Provide decision with examples.
- If project files are present, also generate concrete type code in correct files.

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.