jordimorillo/tdg-php

A Test Driven Generative Development tool to make the code parting from tests

Maintainers

Details

github.com/jordimorillo/tdg-php

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:project

v1.0.0-beta.1 2024-07-07 20:17 UTC

Requires

Requires (Dev)

MIT 5ceac4c55969b6aa78952ef4cc7af5276d3d214f

This package is auto-updated.

Last update: 2025-03-09 00:36:57 UTC

README

TDG-PHP is a tool for generating and testing PHP code based on provided tests. It utilizes a code generation service and runs tests to ensure the generated code meets the requirements specified in the tests.

Installation

To install TDG-PHP in your project, run the following command:

composer require jordimorillo/tdg-php

Usage

Once installed, you can use the tdg-php command to generate and test code based on a PHP test file. The command is executed as follows:

./vendor/bin/tdg-php path/to/test/file.php

Parameters

  • path/to/test/file.php: The path to the PHP test file that will be used to generate the code.

Example Usage

./vendor/bin/tdg-php tests/ExampleTest.php

Configuration

To ensure the tool works correctly, certain environment variables need to be configured. Below are the necessary variables and their purposes:

  • PROJECT_ROOT: The root path of the project.
  • PHPUNIT_XML_PATH: The path to the PHPUnit configuration file.
  • BASE_NAMESPACE: The base namespace of the project.
  • TESTS_BASE_NAMESPACE: The base namespace for the tests.
  • API_KEY: The API key for the code generation service.
  • MAX_ATTEMPTS: The maximum number of attempts to generate valid code.
  • PERMANENT_ATTACHMENTS: Additional files that will always be attached in the code generation process.

Example .env File

PROJECT_ROOT=/path/to/project
PHPUNIT_XML_PATH=/path/to/phpunit.xml
BASE_NAMESPACE=App
TESTS_BASE_NAMESPACE=Tests
API_KEY=your_api_key
MAX_ATTEMPTS=5
PERMANENT_ATTACHMENTS=src/Helper.php,src/Utils.php

Development

Requirements

  • PHP 8.0 or higher
  • Composer
  • PHP cURL extension

Running Tests

To run the tests, use the following command:

composer test

Contributing

Contributions are welcome. Please open an issue or submit a pull request to contribute to the project.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Additional Requirements

For the tool to work, it is necessary to install Llama3 locally.