Skip to content

Schematics generate EDITOR_*_MANIFEST, which the editor no longer reads #298

Open

Description

@Exeloo

Which package is this feature request for?

@nanoforge-dev/schematics

Which command is this feature request for?

create

Feature

The schematics still describe components and systems to the editor with an exported manifest object:

The editor no longer reads these manifests (editor ADR 0003). It finds a component or system from its TSDoc tags (@component / @system, @side client|server|shared, optional @group) and its name = "X" field, and reads the fields' and parameters' docs from TSDoc. So every generated project carries manifest code that does nothing, and the docs pages describe the old format:

Ideal solution or implementation

Generate the editor's format instead, as the example games of NanoForge-dev/examples#18 do:

/**
 * What the component holds.
 *
 * @component
 * @side client
 */
export class Health {
  name = "Health";

  constructor(
    /** Hit points left. */
    public value = 100,
  ) {}
}

and for a system /** … @system @side client */ export const regen = (registry: Registry, ctx: Context) => { … }. Drop EDITOR_*_MANIFEST and their types from the templates, and update the three docs pages.

Alternative solutions or implementations

No response

Other context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    command:createRelated to create commandenhancementNew feature or requestlib:schematicsRelated to the @nanoforge-dev/schematics library

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions