Poketracker

Run

To execute src/scripts/main.ts:

npm run main

Layout

With the exception of scripts, all files must be one of the following types:

• interface
• implementation
• types
• constants
• utils
• instances

Interface

Interfaces reside in interfaces/ directories, and contain exactly one TS interface named with an I prefix (e.g. IFileReader). The files are named after the interface (e.g. file-reader.ts).

Implmentation

Implementations reside in impl/ directories, and contain exactly one TS class that implements one to many interfaces. These classes have no prefix. The files are named after the class (e.g. file-manager.ts for FileManager).

Types

Types contain any utility types or objects specifically intended to assist with type checking (e.g. Path, Zod constants). The file should be named types.ts. Types can optionally exist within a namespace.

Constants

Constants contain any constant values needed. The files should be named constants.ts. The constants should be namespaced within a Constants suffixed namespace matching the scope (e.g. CoreConstants).

Utils

Utils should contain a namespace with functions. The namespace should be suffixed with Utils and the file should be named utils.ts.

Instances

Contains instances of implementations. Must have namespace suffixed with Instances and be in a file named instances.ts.

Conventions

Function Definition

• No default parameters bro
• enums values are PascalCase