Skip to content
This repository was archived by the owner on May 8, 2026. It is now read-only.

Commit 7729a9a

Browse files
committed
chore: run configure script
1 parent 4b1eec1 commit 7729a9a

8 files changed

Lines changed: 85 additions & 225 deletions

File tree

README.md

Lines changed: 68 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,75 @@
1-
# 🏂 Laravel Package Template
1+
# LiveIntent code style rules for php-cs-fixer
22

3-
> Use this template to quickly scafflod a new Laravel package
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/liveintent/php-cs-fixer.svg?style=flat-square)](https://packagist.org/packages/liveintent/php-cs-fixer)
4+
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/liveintent/php-cs-fixer/run-tests?label=tests)](https://github.com/liveintent/php-cs-fixer/actions?query=workflow%3Arun-tests+branch%3Amain)
5+
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/liveintent/php-cs-fixer/run-lint?label=code%20style)](https://github.com/liveintent/php-cs-fixer/actions?query=workflow%3Arun-lint+branch%3Amain)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/liveintent/php-cs-fixer.svg?style=flat-square)](https://packagist.org/packages/liveintent/php-cs-fixer)
47

5-
## Getting Started
8+
This is where your description should go.
69

7-
Click the `Use this template` button at the top right of this page to create your new package. Once you've filled out the information and cloned your new project locally, run:
10+
## Installation
811

12+
You can install the package via composer:
13+
14+
```bash
15+
composer require liveintent/php-cs-fixer
16+
```
17+
18+
## Usage
19+
20+
```php
21+
$package = new LiveIntent\PhpCsFixer();
22+
echo $package->echoPhrase('Hello, LiveIntent!');
23+
```
24+
25+
## Development
26+
27+
Clone this repository and install dependencies via:
28+
```sh
29+
composer install
30+
```
31+
32+
When developing a laravel package, it's often useful to be able to develop your package alongside a laravel app without.
33+
34+
With composer you can symlink the package you are developing into the dependencies of your laravel package by updating your app's `composer.json` file.
35+
36+
```json
37+
{
38+
"repositories": [
39+
{
40+
"type": "path",
41+
"url": "../../packages/my-package"
42+
}
43+
],
44+
"require": {
45+
"my/package": "*"
46+
}
47+
}
948
```
10-
php configure.php
49+
50+
## Testing
51+
52+
You can run the tests via:
53+
54+
```sh
55+
composer test
56+
57+
# or directly via
58+
vendor/bin/phpunit
1159
```
1260

13-
from within your project and answer the questions at the prompts to finalize your project setup.
61+
Additionally, you may run the tests in 'watch' mode via:
62+
63+
```sh
64+
composer test-watch
65+
```
66+
67+
## Linting
68+
69+
The installed linter will auto-format your code to comply with our agreed [php coding standard](https://github.com/LiveIntent/php-cs-rules/blob/master/rules.php).
70+
71+
You can run it via:
72+
73+
```sh
74+
composer lint
75+
```

composer.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "vendor_slug/package_slug",
3-
"description": ":package_description",
2+
"name": "liveintent/php-cs-fixer",
3+
"description": "LiveIntent code style rules for php-cs-fixer",
44
"keywords": [
5-
":vendor_name",
6-
":package_slug"
5+
":LiveIntent",
6+
"php-cs-fixer"
77
],
8-
"homepage": "https://github.com/:vendor_slug/:package_slug",
8+
"homepage": "https://github.com/liveintent/php-cs-fixer",
99
"require": {
1010
"php": "^8.0",
1111
"spatie/laravel-package-tools": "^1.4.3"
@@ -20,12 +20,12 @@
2020
},
2121
"autoload": {
2222
"psr-4": {
23-
"VendorName\\Skeleton\\": "src/"
23+
"LiveIntent\\PhpCsFixer\\": "src/"
2424
}
2525
},
2626
"autoload-dev": {
2727
"psr-4": {
28-
"VendorName\\Skeleton\\Tests\\": "tests/"
28+
"LiveIntent\\PhpCsFixer\\Tests\\": "tests/"
2929
}
3030
},
3131
"scripts": {

configure.php

Lines changed: 0 additions & 127 deletions
This file was deleted.

phpunit.xml.dist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
verbose="true"
2020
>
2121
<testsuites>
22-
<testsuite name="VendorName Test Suite">
22+
<testsuite name="LiveIntent Test Suite">
2323
<directory>tests</directory>
2424
</testsuite>
2525
</testsuites>

project.README.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

src/PhpCsFixer.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
namespace LiveIntent\PhpCsFixer;
4+
5+
class PhpCsFixer
6+
{
7+
//
8+
}

src/Skeleton.php

Lines changed: 0 additions & 8 deletions
This file was deleted.

tests/ExampleTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace VendorName\Skeleton\Tests;
3+
namespace LiveIntent\PhpCsFixer\Tests;
44

55
use PHPUnit\Framework\TestCase;
66

0 commit comments

Comments
 (0)