Download the PHP package upassist/prototypegenerator without Composer
On this page you can find all versions of the php package upassist/prototypegenerator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download upassist/prototypegenerator
More information about upassist/prototypegenerator
Files in upassist/prototypegenerator
Package prototypegenerator
Short Description A prototype generator to quickly generate prototypes based on nodetype definitions.
License MIT
Informations about the package prototypegenerator
UpAssist.PrototypeGenerator
What does this package do?
This package lets you create scaffolding for prototypes for Neos using the commandline.
Why did you make this?
Working with an Atomic setup in Neos often requires creating quite some files for a single NodeType.
Fusion files, CSS files and sometimes specific JS files as well.
While working with templates like textExpander or livetemplates in PhpStorm, still creating the files takes up some time.
Not anymore! 😃
⚙️ How to install
Simply run the composer command to install the package.
How to setup
🚀 Quick Setup
Copy the following Settings and set your defaults:
👉🏻 Advanced Setup
Take a look at all the Settings where you can set defaults for how you would like to render your prototypes, change the inheritance and more.
📘 How to use
There are a couple of commands at your disposal:
Command | Params | Example |
---|---|---|
generator:prototype |
--nodeType | ./flow generator:prototype Content.TextWithImage |
generator:atom |
--prototypeName | ./flow generator:atom Text |
generator:molecule |
--prototypeName | ./flow generator:molecule TextWithImage |
generator:organism |
--prototypeName | ./flow generator:organism TextWithImage |
generator:template |
--prototypeName | ./flow generator:template Article |
generator:extendedrenderer |
--prototypeName | ./flow generator:extendedrenderer Vendor.Package:ExtendedRenderer |
generator:xlf |
--nodeType | ./flow generator:xlf Content.Text |
💡 All commands support the --force
parameter to overwrite files that are already created.
💡 You can use the full name of your prototype, and if you set a packageKey in the settings, you can omit it here. (I.e. Neos.NodeTypes:Content.Text becomes Content.Text)
💡 Nice to know
- The default templates add a
@Todo
in the generated files (you can modify this in the Settings) allowing you to use your IDE to see what you still must implement, probably best to remove it after you are done. - You can modify the default templates to your liking using sprintf syntax to substitute strings; the settings show you what you can use.
- You can modify one or multiple templates. Or none if you like the defaults.
- This is build with atomic fusion use in mind, but should be possible to be used without that.
- Did I mention the generator created the content prototype and all atomic parts as well if you want it to? 😎
⚠️ Warning #1
At this point determination of either Document, ContentCollection or Content types is done by the nodename, which will be changed in an upcoming version to look at the superType instead. Using this package now means you have to name your nodeType like this:
Vendor.Package:Document.Page
Vendor.Package:Content.Text
Vendor.Package:Collection.Section
|Vendor.Package:ContentCollection.Section
🧠 Thought about but not yet implemented...
Generate XLIFF files for all nodeTypes and defined language dimensions #3- Implement more defaults for properties #2
- ...
🤔 Afterthought...
This really was not meant to be ready and could probably be better thought through. However, it works pretty decent for the setup I work with and am very happy with the amount of time saved using this tool. I really hope it makes your Neos development life easier and welcome pull requests of course 😊
Thanks for reading this far and if you like it, let me know 🙂.
— Henjo