README

Introduction

Lightweight Symfony Demo Application for the Spreadsheet Translator functionallity. The demo brings a command that takes a local spreadhseet file and creates a translation file per locale in Php format.

Installation

composer create-project samuelvi/translator-symfony-demo-local-file-to-php

This will install the demo application into your computer

The source demo spreadsheet file is located at app/Resources/doc/homepage.xlsx

Running the demo

Using Make commands (recommended):

make demo  # Runs the translator with default options

Using console directly:

bin/console atico:demo:translator --sheet-name=common --book-name=frontend

This command will generate the translation files that will be stored into translations folder.

The generated files will be:

translations/
├── demo_common.en_GB.php
├── demo_common.es_ES.php
└── demo_common.fr_FR.php

demo_common.en_GB.php will contain:

  <?php
  return array (
    'homepage_title' => 'Spreadsheet translator',
    'homepage_subtitle' => 'Translator of web pages from spreadsheets',
  );

Notes

composer.json will include the following Spreadsheet Translator dependencies:

  "samuelvi/spreadsheet-translator-core": "^8.0",
  "samuelvi/spreadsheet-translator-symfony-bundle": "8.4.1",
  "samuelvi/spreadsheet-translator-provider-localfile": "^8.1",
  "samuelvi/spreadsheet-translator-reader-xlsx": "^8.1",
  "samuelvi/spreadsheet-translator-exporter-php": "^8.1",

Symfony Bundle:

Symfony Bundle

Symfony Demos:

Requirements

PHP >=8.4
Symfony >=7.3

Development Commands

The project includes a comprehensive Makefile for common development tasks.

Docker Management

make up              # Start development environment
make down            # Stop environment
make build           # Rebuild Docker images
make shell           # Access PHP container shell

Dependencies

make composer-install  # Install dependencies
make composer-update   # Update dependencies

Code Quality

make rector-dry-run  # Check Rector changes without applying
make rector          # Apply Rector code changes

Rector is configured with modern syntax to upgrade code to PHP 8.4 and Symfony 7.3+ standards:

PHP 8.4 features (property hooks, asymmetric visibility, etc.)
Symfony 7.1+ best practices
Code quality improvements (dead code removal, type declarations, etc.)
Doctrine annotations to attributes conversion

Testing

make test              # Run PHPUnit tests
make test-coverage     # Run tests with HTML coverage report
make qa                # Run all quality checks (Rector + tests)

The project includes comprehensive unit tests with:

PHPUnit 11.5+
Symfony PHPUnit Bridge
Tests for TranslatorCommand and Kernel
Modern PHP 8.4 attributes (#[Test], #[CoversClass])

Continuous Integration

GitHub Actions workflow is configured to run on every push and pull request:

Code quality checks with Rector
PHPUnit tests with coverage
Runs on PHP 8.4

Contributing

We welcome contributions to this project, including pull requests and issues (and discussions on existing issues).

Before submitting a PR, please ensure:

Run make qa to verify code quality and tests pass
Add tests for new features
Update documentation as needed

If you'd like to contribute code but aren't sure what, the issues list is a good place to start. If you're a first-time code contributor, you may find Github's guide to forking projects helpful.

All contributors (whether contributing code, involved in issue discussions, or involved in any other way) must abide by our code of conduct.

License

Spreadsheet Translator Symfony Bundle is licensed under the MIT License. See the LICENSE file for full details.

atico / translator-symfony-demo-local-file-to-php

Maintainers

Details