PackageInfo

tcmts.share.PackageInfo · #nxbx4rik · type

A package a codebase declares, as its manifest's source says it: read, never run (a page runs no code).

export interface PackageInfo {
  name: string;
  description?: string;
  namespace: string;
  manifestPath: string;
  /** its commands */
  bins: string[];
  /** command → the name it runs (names here are whole, not relative to the namespace) */
  bin: Record<string, string>;
  /** subpath (`.`, `./core`) → the names it exports */
  exports: Record<string, string[]>;
  /** app → the name it is */
  apps: Record<string, string>;
  /** command → the end-to-end tests that run it */
  suites: Record<string, string[]>;
  /** files it copies in, as the manifest writes them: paths from the codebase's root, or names in the namespace */
  files: string[];
  /** packages it needs but doesn't import */
  with: string[];
  /** the JSON file its package.json starts from */
  packageJson?: string;
}

used by