Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump phpdocumentor/reflection-docblock from 2.0.5 to 5.4.0 #895

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 15, 2024

Bumps phpdocumentor/reflection-docblock from 2.0.5 to 5.4.0.

Release notes

Sourced from phpdocumentor/reflection-docblock's releases.

5.4.0

More type support

Since the beginning of this package we have been working on our own parser. Mostly regular expressions spitting each part of a docblock and processing them separately in each tag. But since static analyzers became more popular it became a lot harder to cover all the new formats of types. In type-resolver 1.7 we already started using phpstan's parser to process types. And now in this release we also cover parts of the docblock parsing process with their parser. This will make it easier to keep up with all the new changes and allows us to support more complex type formats.

We do not support all types covered by phpstan. Generics are not fully supported on all notations, we will return an InvalidTag in those cases.

Deprecations

Param tag

We spend a lot of time to cover all the edge cases that we supported in docblocks for many years. However we also noticed that some notations do not really make sense. First notation added to the list is a @param tag without a variable.

@param MyType Here starts the description but $var is ommited

This notation is now deprecated, and support will be removed in the first release of v6.

Static factory interface

We introduced a new factory strategy to make it possible to have more complex factories for tags and keep the implementation simple. Due to this new system of creating tags we can now support external parser to cover the body of a tag to be handled. With this new system the older system of StaticFactories has become deprecated. And will be removed in v6.

Backward compatibility

We introduced all new functionality with backward compatibility in mind. There are no interface changes being made so consumers of the library will not notice anything from the internal changes. However since we introduced a large amount of new types you might notice issues depending on your implementation. Especially when your project reads the types provided by this library.

Other notable changes

New Contributors

... (truncated)

Commits
  • 298d2fe Merge pull request #364 from phpDocumentor/fix/catch-invalid-type-creation
  • 64e172d Added test for regression on invalid types
  • 08acd34 Add test for constant references.
  • 67a55cc Merge pull request #363 from phpDocumentor/fix/malformed-type-definitions
  • edd5f67 Be more strict about type definitions on param
  • f359e4f Fix code style
  • 7b2f618 Add test for string value params
  • c9b9e93 Merge pull request #360 from phpDocumentor/fix/typeless_param
  • d3cbc39 Add extra deprecation
  • fc9a233 Implement fallback option for params without variable
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file php Pull requests that update Php code labels Apr 15, 2024
Copy link

codecov bot commented Apr 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.20%. Comparing base (70bf51f) to head (d2d4c76).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #895   +/-   ##
=======================================
  Coverage   55.20%   55.20%           
=======================================
  Files          75       75           
  Lines        8900     8900           
=======================================
  Hits         4913     4913           
  Misses       3987     3987           
Flag Coverage Δ
tests 55.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Bumps [phpdocumentor/reflection-docblock](https://github.com/phpDocumentor/ReflectionDocBlock) from 2.0.5 to 5.4.0.
- [Release notes](https://github.com/phpDocumentor/ReflectionDocBlock/releases)
- [Commits](phpDocumentor/ReflectionDocBlock@2.0.5...5.4.0)

---
updated-dependencies:
- dependency-name: phpdocumentor/reflection-docblock
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/composer/phpdocumentor/reflection-docblock-5.4.0 branch from bd5e23a to d2d4c76 Compare April 16, 2024 00:17
nanasess
nanasess previously approved these changes Apr 16, 2024
@nanasess nanasess dismissed their stale review April 16, 2024 01:47

cancel

@nanasess nanasess enabled auto-merge April 16, 2024 01:47
@nanasess nanasess merged commit d605307 into master Apr 16, 2024
90 checks passed
@dependabot dependabot bot deleted the dependabot/composer/phpdocumentor/reflection-docblock-5.4.0 branch April 16, 2024 01:47
@nanasess nanasess added this to the 2.18(仮) milestone Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file php Pull requests that update Php code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant