korbeil / jane-v8
All Jane components into one repository
Requires
- php: ^8.2
- doctrine/inflector: ^2.0
- jolicode/automapper: dev-main
- league/uri: ^6.8
- nikic/php-parser: ^4.15.5
- php-jsonpointer/php-jsonpointer: ^4.0
- phpstan/phpdoc-parser: ^1.29
- symfony/filesystem: ^7.0
- symfony/serializer: ^7.0
- symfony/yaml: ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.14
- phpdocumentor/reflection-docblock: ^5.3
- phpunit/phpunit: ^10.0
- symfony/var-dumper: ^7.1
Replaces
- jane-php/json-schema-compiler: dev-main
- jane-php/json-schema-generator: dev-main
- jane-php/json-schema-metadata: dev-main
- jane-php/json-schema-parser: dev-main
- jane-php/open-api-parser: dev-main
This package is auto-updated.
Last update: 2024-11-23 17:53:39 UTC
README
Steps:
- Parser (Fichier/JSON > Array)
- Metadata (Json > Metadata)
- Compiler (Metadata > Représentation PHP)
- Generator (Représentation PHP > Code généré)
Todo
Before JSON Schema ALPHA-1
- Fix OneOf fixture
- More runtime tests in JSON Schema generator
- Documentation from scratch (MkDocs)
Documentation
Jane uses Docsify to generate the documentation. While contributing to the Jane codebase, it is primordial to keep the documentation up-to-date.
First you will need to install Docsify
yarn global add docsify-cli
Then watch the documentatation folder
docsify watch /docs
Contributing
You can contribute this repository. To have an updated version of the code please checkout this repository, then:
composer update
Do your changes, before commit/creating a pull request, you should run:
composer cs-fix # will fix any coding style issue composer cs-check # will check if you have any issue in your code thanks to PHPStan composer tests # will run Jane's test suite
Once that is done, you can create your pull request. Please always think about updating the CHANGELOG file and add a test that is linked to the added feature or a non-regression test if you're fixing a bug.