Skip to content

Commit c6a145b

Browse files
Initital commit. (#1)
1 parent 01d4eff commit c6a145b

23 files changed

+360
-221
lines changed

.github/workflows/build.yml

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

.github/workflows/mutation.yml

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

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ phpunit.xlm
2222

2323
# windows thumbnail cache
2424
Thumbs.db
25+
26+
# vscode
27+
.vscode

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Change Log
2+
3+
## 0.1.0 February 27, 2024
4+
5+
- Initial release

README.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,6 @@
77
</p>
88

99
<p align="center">
10-
<a href="https://github.com/yii-tools/template/actions/workflows/build.yml" target="_blank">
11-
<img src="https://github.com/yii-tools/template/actions/workflows/build.yml/badge.svg" alt="PHPUnit">
12-
</a>
13-
<a href="https://codecov.io/gh/yii-tools/template" target="_blank">
14-
<img src="https://codecov.io/gh/yii-tools/template/branch/main/graph/badge.svg?token=MF0XUGVLYC" alt="Codecov">
15-
</a>
16-
<a href="https://dashboard.stryker-mutator.io/reports/github.com/yii-tools/template/main" target="_blank">
17-
<img src="https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyii2-extensions%2Fasset-bootstrap5%2Fmain" alt="Infection">
1810
</a>
1911
<a href="https://github.com/yii-tools/template/actions/workflows/static.yml" target="_blank">
2012
<img src="https://github.com/yii-tools/template/actions/workflows/static.yml/badge.svg" alt="Psalm">
@@ -34,24 +26,46 @@ The preferred way to install this extension is through [composer](https://getcom
3426
Either run
3527

3628
```shell
37-
composer require --prefer-dist package
29+
composer require --prefer-dist php-forge/html-interop:"^0.1"
3830
```
3931

4032
or add
4133

4234
```json
43-
"package": "version"
35+
"php-forge/html-interop": "^0.1"
4436
```
4537

46-
to the require-dev section of your `composer.json` file.
38+
to the require section of your `composer.json` file.
4739

48-
## Usage
40+
## Testing
4941

50-
[Check the documentation docs](docs/README.md) to learn about usage.
42+
### Checking dependencies
5143

52-
## Testing
44+
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all
45+
dependencies are correctly defined in `composer.json`.
46+
47+
To run the checker, execute the following command:
48+
49+
```shell
50+
composer run check-dependencies
51+
```
52+
53+
### Easy coding standard
5354

54-
[Check the documentation testing](docs/testing.md) to learn about testing.
55+
The code is checked with [Easy Coding Standard](https://github.com/easy-coding-standard/easy-coding-standard) and
56+
[PHP CS Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer). To run it:
57+
58+
```shell
59+
composer run ecs
60+
```
61+
62+
### Static analysis
63+
64+
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
65+
66+
```shell
67+
composer run psalm
68+
```
5569

5670
## Support versions
5771

changelog.md

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

composer.json

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,38 @@
11
{
2-
"name": "yii-tools/template",
2+
"name": "php-forge/html-interop",
33
"type": "library",
4-
"description": "template",
4+
"description": "Interfaces for UI HTML Awesome.",
55
"keywords": [
6-
"template"
6+
"php-forge",
7+
"html-interop",
8+
"html",
9+
"ui"
710
],
811
"license": "mit",
9-
"minimum-stability": "dev",
10-
"prefer-stable": true,
1112
"require": {
1213
"php": "^8.1"
1314
},
1415
"require-dev": {
1516
"maglnet/composer-require-checker": "^4.7",
16-
"phpunit/phpunit": "^10.5",
17-
"roave/infection-static-analysis-plugin": "^1.34",
1817
"symplify/easy-coding-standard": "^12.1",
1918
"vimeo/psalm": "^5.19"
2019
},
2120
"autoload": {
2221
"psr-4": {
23-
"Template\\": "src"
24-
}
25-
},
26-
"autoload-dev": {
27-
"psr-4": {
28-
"Template\\Tests\\": "tests"
22+
"PHPForge\\Html\\Interop\\": "src"
2923
}
3024
},
3125
"extra": {
3226
"branch-alias": {
33-
"dev-main": "1.0.x-dev"
27+
"dev-main": "0.1-dev"
3428
}
3529
},
3630
"config": {
37-
"sort-packages": true,
38-
"allow-plugins": {
39-
"infection/extension-installer": true
40-
}
31+
"sort-packages": true
4132
},
4233
"scripts": {
4334
"check-dependencies": "composer-require-checker",
4435
"easy-coding-standard": "ecs check",
45-
"mutation": [
46-
"Composer\\Config::disableProcessTimeout",
47-
"roave-infection-static-analysis-plugin"
48-
],
49-
"psalm": "psalm",
50-
"test": "phpunit"
36+
"psalm": "psalm"
5137
}
5238
}

docs/testing.md

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

ecs.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
->withPaths(
2020
[
2121
__DIR__ . '/src',
22-
__DIR__ . '/tests',
2322
],
2423
)
2524
->withPhpCsFixerSets(perCS20: true)

infection.json.dist

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

0 commit comments

Comments
 (0)