Download the PHP package voral/vinc-file-version-regexp without Composer
On this page you can find all versions of the php package voral/vinc-file-version-regexp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download voral/vinc-file-version-regexp
More information about voral/vinc-file-version-regexp
Files in voral/vinc-file-version-regexp
Package vinc-file-version-regexp
Short Description An extension for voral/version-increment to update version strings in custom files using regular expressions.
License MIT
Homepage https://github.com/Voral/vinc-file-version-regexp
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package vinc-file-version-regexp
vinc-file-version-regexp
RU
An extension for voral/version-increment to update version strings in custom files using regular expressions.
This tool allows you to automatically update version numbers in arbitrary files (e.g., PHP, JSON, XML) during the
versioning process. It integrates seamlessly with the voral/version-increment package and listens to
the BEFORE_VERSION_SET event to perform replacements based on a provided regular expression.
Key Features
- Custom File Support: Update version strings in any file format using flexible regular expressions.
- Event-Based Integration: Listens to the
BEFORE_VERSION_SETevent fromvoral/version-increment. - Error Handling with Unique Codes: Prevents conflicts between multiple extensions by supporting error code deltas.
- Flexible Configuration: Define custom regular expressions to match version strings in various formats.
- Extensibility: Easily integrate into existing workflows with minimal configuration.
Installation
Install the package via Composer:
Usage
To use this extension, configure it in your .vs-version-increment.php file by adding a listener for
the BEFORE_VERSION_SET event. Here's an example:
Explanation:
- File Path: Specify the path to the file where the version string should be updated (e.g.,
./src/version.php). - Regular Expression: Provide a regex pattern to locate the version string. The pattern must include:
- Group 1: The part of the string before the version.
- Group 2: The part of the string after the version.
- Error Code Delta: Optionally, specify a delta value to ensure unique error codes when using multiple extensions.
Example Use Cases
1. Updating a PHP File
If your project contains a version.php file like this:
The extension will update it to:
2. Updating a JSON File
For a config.json file:
The extension can update it to:
Error Handling
The extension provides detailed error messages and unique error codes to help diagnose issues:
- FileNotFoundException: Thrown if the specified file does not exist.
- FileNotWritableException: Thrown if the file is not writable.
- PatternNotFoundException: Thrown if the regular expression does not match any part of the file content.
Error codes are offset by a configurable errorCodeDelta to avoid conflicts with other extensions.
Configuration Options
You can customize the behavior of the extension by adjusting its parameters:
| Parameter | Description |
|---|---|
filePath |
The path to the file where the version will be updated. |
regexp |
The regular expression used to locate the version string. |
errorCodeDelta |
Optional delta value to ensure unique error codes across multiple modules. |
Contributing
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Submit a pull request with a clear description of your changes.
Ensure that your code adheres to the project's coding standards and includes appropriate tests.
Testing
Run the following commands to test the package:
Generate a code coverage report:
Perform static analysis:
Check coding standards:
Run all checks at once:
License
This package is licensed under the MIT License. See the LICENSE file for details.
Useful Links
- voral/version-increment: The main package this extension integrates with.
