Skip to content

Commit 1c42c80

Browse files
chore: remove sync-metadata script and docs/development.md, update documentation links. (#84)
1 parent 79d8441 commit 1c42c80

5 files changed

Lines changed: 80 additions & 118 deletions

File tree

CHANGELOG.md

Lines changed: 74 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,102 @@
11
# Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
38
## 0.4.1 Under development
49

5-
- Bug #81: Update Rector command in `composer.json` to remove unnecessary 'src' argument (@terabytesoftw)
6-
- Enh: Replace static stub files with dynamic stub generation for `Yii::$app` type inference, adding support for custom application types (@terabytesoftw)
10+
- fix: update Rector command in `composer.json` to remove unnecessary 'src' argument (#81).
11+
- feat: replace static stub files with dynamic stub generation for `Yii::$app` type inference, adding support for custom application types.
12+
- chore: remove `sync-metadata` script and `docs/development.md`, update documentation links.
713

814
## 0.4.0 January 26, 2026
915

10-
- Bug #71: Update `.gitattributes` to exclude additional files from the package (@terabytesoftw)
11-
- Bug #72: Exclude `phpstan-console.neon` from the package in `.gitattributes` (@terabytesoftw)
12-
- Bug #73: Update workflow actions to use `v1` stable version instead of `main`, update `LICENSE.md` (@terabytesoftw)
13-
- Bug #74: Update `README.md` to include `Behavior` integration section and example usage (@terabytesoftw)
14-
- Bug #75: Update `README.md` to enhance badge visibility and improve installation instructions (@terabytesoftw)
15-
- Dep #76: Bump `php-forge/actions` from `1` to `2` (@dependabot)
16-
- Bug #77: Update workflows and documentation for improved CI/CD processes and feature clarity (@terabytesoftw)
17-
- Bug #78: Improve `.gitignore` formatting and add missing entries for better clarity (@terabytesoftw)
18-
- Dep #79: Update `symplify/easy-coding-standard` requirement from `^12.1` to `^13.0` (@dependabot)
19-
- Enh #80: Add `php-forge/coding-standard` to development dependencies for code quality checks and add support `PHP 8.5` (@terabytesoftw)
16+
- chore: update `.gitattributes` to exclude additional files from the package (#71).
17+
- chore: exclude `phpstan-console.neon` from the package in `.gitattributes` (#72).
18+
- ci: update workflow actions to use `v1` stable version instead of `main` (#73).
19+
- docs: update `README.md` to include `Behavior` integration section and example usage (#74).
20+
- docs: update `README.md` to enhance badge visibility and improve installation instructions (#75).
21+
- build: bump `php-forge/actions` from `1` to `2` (#76).
22+
- ci: update workflows and documentation for improved CI/CD processes and feature clarity (#77).
23+
- chore: improve `.gitignore` formatting and add missing entries for better clarity (#78).
24+
- build: update `symplify/easy-coding-standard` requirement from `^12.1` to `^13.0` (#79).
25+
- feat: add `php-forge/coding-standard` to development dependencies for code quality checks and add support `PHP 8.5` (#80).
2026

2127
## 0.3.1 August 16, 2025
2228

23-
- Bug #62: Order class elements in methods and properties (@terabytesoftw)
24-
- Bug #63: Add case to the ordered class elements in `ECS` configuration (@terabytesoftw)
25-
- Bug #64: Correct badge URL formatting in `README.md` (@terabytesoftw)
26-
- Bug #65: Add missing `Composer` requirement in installation guide (@terabytesoftw)
27-
- Bug #66: Update license badge in `README.md` for correct display and add missing header in `LICENSE.md` (@terabytesoftw)
28-
- Bug #67: Correct default stub filename in `StubFilesExtension.php` for accurate PHPStan analysis (@terabytesoftw)
29-
- Bug #68: Refactor dynamic return type inference for `HeaderCollection::get()` method in PHPStan analysis, and add tests suite for type inference (@terabytesoftw)
30-
- Bug #69: Update `CHANGELOG.md` to include recent bugfixes and enhancements for version `0.3.1` (@terabytesoftw)
31-
- Bug #70: Update branch alias version in `composer.json` from `0.3.x-dev` to `0.4.x-dev` (@terabytesoftw)
29+
- refactor: order class elements in methods and properties (#62).
30+
- chore: add case to the ordered class elements in `ECS` configuration (#63).
31+
- docs: correct badge URL formatting in `README.md` (#64).
32+
- docs: add missing `Composer` requirement in installation guide (#65).
33+
- docs: update license badge in `README.md` for correct display and add missing header in `LICENSE.md` (#66).
34+
- fix: correct default stub filename in `StubFilesExtension.php` for accurate PHPStan analysis (#67).
35+
- refactor: refactor dynamic return type inference for `HeaderCollection::get()` method, and add tests for type inference (#68).
36+
- docs: update `CHANGELOG.md` to include recent bugfixes and enhancements for version `0.3.1` (#69).
37+
- chore: update branch alias version in `composer.json` from `0.3.x-dev` to `0.4.x-dev` (#70).
3238

3339
## 0.3.0 June 27, 2025
3440

35-
- Enh #35: Move config fixtures into `config` subdirectory (@terabytesoftw)
36-
- Enh #36: Update `ActiveQuery` and `ActiveRecord` dynamic return type extensions for improved type inference and error handling; remove deprecated `ActiveQueryObjectType` and `ActiveRecordObjectType` classes (@terabytesoftw)
37-
- Enh #37: Enhance `DI` container type inference and testing (@terabytesoftw)
38-
- Bug #38: Correct exception message formatting in `ServiceMapServiceTest` (@terabytesoftw)
39-
- Bug #39: Resolve `Container::get()` type inference for unconfigured classes in config (`ServiceMap`) (@terabytesoftw)
40-
- Enh #40: Enhance `PHPStan` analysis for `Behavior` type inference and testing (@terabytesoftw)
41-
- Enh #41: Refactor `PHPDoc` comments for consistency and clarity (@terabytesoftw)
42-
- Bug #42: Move `ApplicationPropertiesClassReflectionExtension` to `property` directory and add testing (@terabytesoftw)
43-
- Enh #43: Add tests for session property availability in `Console` and `Web` `Applications` (@terabytesoftw)
44-
- Bug #44: Move `UserPropertiesClassReflectionExtension` to `property` directory and add testing (@terabytesoftw)
45-
- Bug #45: Improve `ServiceMap` configuration for application types (`Base`, `Console`, `Web`) (@terabytesoftw)
46-
- Bug #46: Update `README.md` to enhance clarity and structure of `docs/installation.md`, `docs/configuration.md` and `docs/examples.md` (@terabytesoftw)
47-
- Enh #47: Add `ActiveRecordGetAttributeDynamicMethodReturnTypeExtension` to provide precise type inference for `getAttribute()` method calls based on PHPDoc annotations (@terabytesoftw)
48-
- Bug #48: Update `PHPStan` configuration paths and create new config files for improved structure and clarity (@terabytesoftw)
49-
- Bug #49: Update documentation for `ServiceMap` and related classes to enhance clarity for Yii Application static analysis (@terabytesoftw)
50-
- Bug #50: Add Testing Guide link to `installation` and `examples` documentation (@terabytesoftw)
51-
- Bug #51: Reorder Installation section in `README.md` for improved clarity (@terabytesoftw)
52-
- Bug #52: Standardize headings and improve clarity in documentation files (@terabytesoftw)
53-
- Bug #53: Update documentation for consistency and clarity; change section titles and add strict types declaration (@terabytesoftw)
54-
- Bug #54: Update `PHPStan` `tmpDir` config; move `runtime` directory to `root`; update docs (@terabytesoftw)
55-
- Bug #55: Remove `OS` and `PHP` version specifications from workflow files for simplification (@terabytesoftw)
56-
- Enh #56: Add `ServiceLocatorDynamicMethodReturnTypeExtension` to provide precise type inference for `get()` method (@terabytesoftw)
57-
- Bug #57: Clarify exception documentation and improve type inference descriptions in test cases (@terabytesoftw)
58-
- Bug #58: Handle generic type components in `ApplicationPropertiesClassReflectionExtension` (@terabytesoftw)
59-
- Bug #59: Handle generic type components in `ApplicationPropertiesClassReflectionExtension` (@terabytesoftw)
60-
- Bug #60: Update `CHANGELOG.md` for version `0.3.0` release date and adjust `composer.json` for stability settings (@terabytesoftw)
61-
- Bug #61: Update `README.md` with new `GitHub` release badge and correct `Yii2` version badge (@terabytesoftw)
41+
- refactor: move config fixtures into `config` subdirectory (#35).
42+
- refactor: update `ActiveQuery` and `ActiveRecord` dynamic return type extensions for improved type inference and error handling; remove deprecated `ActiveQueryObjectType` and `ActiveRecordObjectType` classes (#36).
43+
- feat: enhance `DI` container type inference and testing (#37).
44+
- fix: correct exception message formatting in `ServiceMapServiceTest` (#38).
45+
- fix: resolve `Container::get()` type inference for unconfigured classes in config (`ServiceMap`) (#39).
46+
- feat: enhance `PHPStan` analysis for `Behavior` type inference and testing (#40).
47+
- docs: refactor `PHPDoc` comments for consistency and clarity (#41).
48+
- refactor: move `ApplicationPropertiesClassReflectionExtension` to `property` directory and add testing (#42).
49+
- test: add tests for session property availability in `Console` and `Web` `Applications` (#43).
50+
- refactor: move `UserPropertiesClassReflectionExtension` to `property` directory and add testing (#44).
51+
- fix: improve `ServiceMap` configuration for application types (`Base`, `Console`, `Web`) (#45).
52+
- docs: update `README.md` to enhance clarity and structure of `docs/installation.md`, `docs/configuration.md` and `docs/examples.md` (#46).
53+
- feat: add `ActiveRecordGetAttributeDynamicMethodReturnTypeExtension` to provide precise type inference for `getAttribute()` method calls based on PHPDoc annotations (#47).
54+
- refactor: update `PHPStan` configuration paths and create new config files for improved structure and clarity (#48).
55+
- docs: update documentation for `ServiceMap` and related classes to enhance clarity for Yii Application static analysis (#49).
56+
- docs: add Testing Guide link to `installation` and `examples` documentation (#50).
57+
- docs: reorder Installation section in `README.md` for improved clarity (#51).
58+
- docs: standardize headings and improve clarity in documentation files (#52).
59+
- docs: update documentation for consistency and clarity; change section titles and add strict types declaration (#53).
60+
- chore: update `PHPStan` `tmpDir` config; move `runtime` directory to `root`; update docs (#54).
61+
- ci: remove `OS` and `PHP` version specifications from workflow files for simplification (#55).
62+
- feat: add `ServiceLocatorDynamicMethodReturnTypeExtension` to provide precise type inference for `get()` method (#56).
63+
- docs: clarify exception documentation and improve type inference descriptions in test cases (#57).
64+
- fix: handle generic type components in `ApplicationPropertiesClassReflectionExtension` (#58).
65+
- fix: handle generic type components in `ApplicationPropertiesClassReflectionExtension` (#59).
66+
- chore: update `CHANGELOG.md` for version `0.3.0` release date and adjust `composer.json` for stability settings (#60).
67+
- docs: update `README.md` with new `GitHub` release badge and correct `Yii2` version badge (#61).
6268

6369
## 0.2.3 June 09, 2025
6470

65-
- Enh #25: Add support for `PHPStan` Extension Installer (@samuelrajan747)
66-
- Enh #26: Add `PHPStan` extension installer instructions and improve `ServiceMap` configuration handling (@terabytesoftw)
67-
- Bug #27: Fix error handling in `ServiceMap` for invalid configuration structures and add corresponding test cases (@terabytesoftw)
68-
- Bug #28: Refactor component handling in `ServiceMap` to improve variable naming and streamline logic (@terabytesoftw)
69-
- Enh #29: Enable strict rules and bleeding edge analysis, and update `README.md` with strict configuration examples (@terabytesoftw)
70-
- Bug #33: Fix `ActiveRecordDynamicStaticMethodReturnTypeExtension` type inference for `ActiveQuery` support, and fix phpstan errors max lvl in tests (@terabytesoftw)
71-
- Bug #34: Fix property reflection in `UserPropertiesClassReflectionExtension` to support `identityClass` resolution and improve type inference for `user` component properties (@terabytesoftw)
71+
- feat: add support for `PHPStan` Extension Installer (#25).
72+
- feat: add `PHPStan` extension installer instructions and improve `ServiceMap` configuration handling (#26).
73+
- fix: fix error handling in `ServiceMap` for invalid configuration structures and add corresponding test cases (#27).
74+
- refactor: refactor component handling in `ServiceMap` to improve variable naming and streamline logic (#28).
75+
- feat: enable strict rules and bleeding edge analysis, and update `README.md` with strict configuration examples (#29).
76+
- fix: fix `ActiveRecordDynamicStaticMethodReturnTypeExtension` type inference for `ActiveQuery` support, and fix phpstan errors max lvl in tests (#33).
77+
- fix: fix property reflection in `UserPropertiesClassReflectionExtension` to support `identityClass` resolution and improve type inference for `user` component properties (#34).
7278

7379
## 0.2.2 June 04, 2025
7480

75-
- Bug #22: Make `$configPath` optional in constructor `ServiceMap` class and update docs `README.md` (@terabytesoftw)
76-
- Bug #23: Update the path to `Yii.php` in the `stubFiles` configuration for correct referencing (@terabytesoftw)
77-
- Bug #24: Improve `Yii2` integration component property handling.
81+
- fix: make `$configPath` optional in constructor `ServiceMap` class and update docs `README.md` (#22).
82+
- fix: update the path to `Yii.php` in the `stubFiles` configuration for correct referencing (#23).
83+
- fix: improve `Yii2` integration component property handling (#24).
7884

7985
## 0.2.1 June 03, 2025
8086

81-
- Bug #20: Update licenses, docs, configuration, and reflection/type logic (@terabytesoftw)
82-
- Bug #21: Update `CHANGELOG.md` date for version `0.2.1` and format `phpunit.xml.dist` (@terabytesoftw)
87+
- fix: update licenses, docs, configuration, and reflection/type logic (#20).
88+
- docs: update `CHANGELOG.md` date for version `0.2.1` and format `phpunit.xml.dist` (#21).
8389

8490
## 0.2.0 June 02, 2025
8591

86-
- Enh #12: Upgrade to `PHPStan` `2.1` (@glpzzz)
87-
- Enh #13: Enhance `PHPStan` integration with yii2 extensions (@terabytesoftw)
88-
- Enh #14: Consolidate `PHPUnit` workflows and update `README.md` with `Yii2` version badges (@terabytesoftw)
89-
- Bug #15: Correct badge label formatting for `Yii2` version in `README.md` (@terabytesoftw)
90-
- Bug #16: Remove duplicate concurrency settings from phpunit-compatibility job in `build.yml` (@terabytesoftw)
91-
- Bug #17: Update changelog for version `0.2.0` with recent enhancements and bugfixes (@terabytesoftw)
92-
- Bug #18: Add usage instructions and configuration details for `phpstan.neon` in `README.md` (@terabytesoftw)
92+
- feat: upgrade to `PHPStan` `2.1` (#12).
93+
- feat: enhance `PHPStan` integration with yii2 extensions (#13).
94+
- ci: consolidate `PHPUnit` workflows and update `README.md` with `Yii2` version badges (#14).
95+
- docs: correct badge label formatting for `Yii2` version in `README.md` (#15).
96+
- ci: remove duplicate concurrency settings from phpunit-compatibility job in `build.yml` (#16).
97+
- docs: update changelog for version `0.2.0` with recent enhancements and bugfixes (#17).
98+
- docs: add usage instructions and configuration details for `phpstan.neon` in `README.md` (#18).
9399

94100
## 0.1.0 February 27, 2024
95101

96-
- Initial release
102+
- feat: initial release.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,6 @@ For detailed configuration options and advanced usage.
218218
- ⚙️ [Configuration Reference](docs/configuration.md)
219219
- 💡 [Usage Examples](docs/examples.md)
220220
- 🧪 [Testing Guide](docs/testing.md)
221-
- 🛠️ [Development Guide](docs/development.md)
222221

223222
## Package information
224223

composer.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,6 @@
5252
"ecs": "./vendor/bin/ecs --fix",
5353
"rector": "./vendor/bin/rector process",
5454
"static": "./vendor/bin/phpstan --memory-limit=-1",
55-
"sync-metadata": [
56-
"curl -fsSL -o .editorconfig https://raw.githubusercontent.com/yii2-extensions/template/main/.editorconfig",
57-
"curl -fsSL -o .gitattributes https://raw.githubusercontent.com/yii2-extensions/template/main/.gitattributes",
58-
"curl -fsSL -o .gitignore https://raw.githubusercontent.com/yii2-extensions/template/main/.gitignore",
59-
"curl -fsSL -o .styleci.yml https://raw.githubusercontent.com/yii2-extensions/template/main/.styleci.yml",
60-
"curl -fsSL -o phpstan.neon https://raw.githubusercontent.com/yii2-extensions/template/main/phpstan.neon",
61-
"curl -fsSL -o phpunit.xml.dist https://raw.githubusercontent.com/yii2-extensions/template/main/phpunit.xml.dist"
62-
],
6355
"tests": "./vendor/bin/phpunit"
6456
},
6557
"repositories": [

docs/development.md

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

docs/testing.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,9 @@ Run PHPStan with a different memory limit.
5959
```bash
6060
composer static -- --memory-limit=512M
6161
```
62+
63+
## Next steps
64+
65+
- 📚 [Installation Guide](installation.md)
66+
- ⚙️ [Configuration Reference](configuration.md)
67+
- 💡 [Usage Examples](examples.md)

0 commit comments

Comments
 (0)