https://github.com/endroid/teleporter
Copies files from one location to another while filtering the file contents based on specified modules
https://github.com/endroid/teleporter
Last synced: about 1 year ago
JSON representation
Copies files from one location to another while filtering the file contents based on specified modules
- Host: GitHub
- URL: https://github.com/endroid/teleporter
- Owner: endroid
- License: mit
- Created: 2018-10-01T20:36:55.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-11-07T13:10:06.000Z (over 2 years ago)
- Last Synced: 2024-10-14T17:39:32.915Z (over 1 year ago)
- Language: PHP
- Homepage: https://endroid.nl/
- Size: 43 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Teleporter
*By [endroid](https://endroid.nl/)*
[](https://packagist.org/packages/endroid/teleporter)
[](https://github.com/endroid/teleporter/actions)
[](https://packagist.org/packages/endroid/teleporter)
[](https://packagist.org/packages/endroid/teleporter)
Copies files from one location to another while filtering the file contents
and directories based on a list of component names to include. This allows you
to have one single generic source for building many project variants with any
combination of components.
## Installation
Use [Composer](https://getcomposer.org/) to install the library.
``` bash
composer require endroid/teleporter
```
When you use Symfony, the [installer](https://github.com/endroid/installer)
makes sure that services are automatically wired. If this is not the case you
can find the configuration files in the `.install/symfony` folder.
## Usage
You can specify sections to include or exclude using ### condition ### tags. For
instance when we desire JWT we need to retrieve a token before performing an API call.
``` php
Feature: API Access
In order to access protected resource
As an API client
I need to be able to connect
Scenario: Perform API call
{## if jwt ##}
Given I retrieve a JWT token for user "admin"
{## endif ##}
And I send a GET request to "api/examples"
Then the response should be in JSON
```
For the example given above we would perform the following call to copy the
project files including all JWT related code. If we omit the jwt parameter, the
files are copied without the sections marked for JWT.
``` bash
vendor/bin/teleport development project jwt
```
In general the teleport command requires the following parameters.
``` bash
vendor/bin/teleport
```
## Versioning
Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatible
changes will be kept to a minimum but be aware that these can occur. Lock
your dependencies for production and test your code when upgrading.
## License
This bundle is under the MIT license. For the full copyright and license
information please view the LICENSE file that was distributed with this source code.