forme/codegen

Code Generation CLI For The Forme WordPress Framework

v2.1.3 2024-02-08 15:31 UTC

Requires

• php: ^8.1
• consolidation/comments: ^1.0
• emgag/flysystem-tempdir: ^3.0
• forme/framework: ^3.3
• jawira/case-converter: ^3.4
• jolicode/jolinotif: ^2.4
• league/flysystem: ^3.0
• nette/php-generator: ^4.0
• nette/utils: ^3.2
• nikic/php-parser: ^4.14
• php-di/php-di: ^7.0
• phppkg/cli-markdown: ^2.0.1
• symfony/console: ^6.0
• symfony/process: ^6.0
• symfony/string: ^6.0
• symfony/yaml: ^6.0
• symplify/coding-standard: ^11.0
• symplify/easy-coding-standard: ^11.0

Requires (Dev)

• captainhook/captainhook: ^5.16
• friendsofphp/php-cs-fixer: ^3.16
• mockery/mockery: ^1.4
• nunomaduro/mock-final-classes: dev-master
• pestphp/pest: ^1.21
• pestphp/pest-plugin-mock: ^1.0
• phpstan/phpstan: ^1.7
• psy/psysh: ^0.11.5
• ramsey/conventional-commits: ^1.3
• rector/rector: ^0.15.21
• spatie/pest-plugin-test-time: ^1.1
• symfony/var-dumper: ^6.0

MIT

README

Forme CodeGen

Code Generation CLI For The Forme WordPress Framework.

Install it globally.

composer global require forme/codegen

Click here for Documentation

Development

For development run phive install --force-accept-unsigned followed by composer install.

Tools are in ./tools rather than ./vendor/bin

You also need git cliff for generating changelogs and pcov to generate coverage stats for infection to measure against.

The useful ones are set up as composer scripts.

composer test # run pest
composer stan # run phpstan on src
composer rector:check # rector dry run on src
composer rector:fix # rector on src
composer cs:check # php cs fixer dry run on src
composer cs:fix # php cs fixer on src
composer phar:build # build phar with box (experimental, some features don't work yet)
composer changelog # run git cliff
composer hooks # install git hooks (will run on composer install automatically)
composer bump:version # bump to the next patch version - can also take argument "minor" or "major"
composer infection # run infection on src
composer infection:log # run infection on src and log to infection.html

Output all help as markdown for docs

# requires findutils on OSX - you can drop the "g" xargs prefix on Linux
forme list --raw | cut -d' ' -f1 | gxargs -n1 -d'\n' forme --format=md help | sed $'s/\x1b\\[91m\([A-Za-z\\._-]*\)\x1b\\[0m/`\\1`/g' | sed $'s/    \x1b\\[0\;33m\(.*\)\x1b\\[0m/```bash\\n\\1\\n```/g' | sed $'s,\x1b\\[[0-9;]*[a-zA-Z],,g' > codegen.md

Manual steps:

1. Check the section/command titles as this doesn't seem to output correct line breaks
2. Find and replace home folder
3. Copy into docs