visol/neos-zebra-schema-generator

Generate TypeScript interfaces and Zebra server components from Neos node type definitions

dev-main 2026-05-30 20:12 UTC

Requires

• neos/content-repository: *
• neos/flow: *

MIT

README

Generate TypeScript interfaces and Zebra server components from Neos CMS node type definitions.

This is an experimental, configurable extraction of a generator originally built for a specific project. Everything project-specific (taxonomy mapping, preset→type mappings, base _types, excluded node types, category markers, target paths, …) is driven by YAML config, so the package ships generic defaults and the consuming site package overrides only its specifics.

Installation

composer require visol/neos-zebra-schema-generator

Usage

# Generate TypeScript interfaces from node type definitions
./flow visol.neos.zebraschemagenerator:schema:generateinterfaces [--package=Your.Site]

# Generate Zebra server components (+ node type config)
./flow visol.neos.zebraschemagenerator:schema:generatezebracomponentswithconfig [--package=Your.Site]

--package filters generation to a single package; omit it to process all distribution packages.

Configuration

All behaviour is configured under the Visol.Neos.ZebraSchemaGenerator settings namespace. The package's own Configuration/Settings.yaml documents the generic defaults; override the project-specific keys (interfacesTargetPath, componentTargetPath, excludedNodeTypes, referenceTypesAsString, customPropertyTypes, extraProperties, …) in your site package.

License

MIT