Substrate

Appearance

@studnicky/all-types-are-entities ​

Requires declarations classified through TypeScript type services as canonical pure data to use an exported Type member in an exported namespace whose name ends in Entity. The namespace must export its own Schema, and the declaration must derive directly from typeof Schema.

The rule accepts both canonical spellings:

  • export type Type = F<typeof Schema>
  • export interface Type extends F<typeof Schema> {}

F must have verified schema-derived provenance. A pure-data declaration that does not meet the exact entity ownership and derivation shape is reported. The rule does nothing when TypeScript parser services are unavailable.

Fixable: No · Options: No · Suggested severity: error

✗ Incorrect ​

ts
export type User = {
  readonly id: string;
};
ts
import type { FromSchema } from 'json-schema-to-ts';

export namespace UserEntity {
  export const Schema = { type: 'object' } as const;
  export type User = FromSchema<typeof Schema>;
}

✓ Correct ​

ts
import type { FromSchema } from 'json-schema-to-ts';

export namespace UserEntity {
  export const Schema = { type: 'object' } as const;
  export type Type = FromSchema<typeof Schema>;
}
ts
import type { FromSchema } from 'json-schema-to-ts';

export namespace UserEntity {
  export const Schema = { type: 'object' } as const;
  export interface Type extends FromSchema<typeof Schema> {}
}

Diagnostic ownership ​

type-alias-invariants owns aliases that fail its own identity, declaration-shape, naming, provenance, or readonly checks. This rule reports only declarations the shared classifier identifies as canonical pure data but that are not in the canonical entity form.