Added type annotation to all methods

[tolik518]

I'm currently working on adding Docblocks with type annotations and throws to all methods to get full type-hinting through the IDE.

[tolik518]

The PR is now ready for review @lyrixx

[lyrixx]

Thanks for the PR. But I think this is not what we should do. See the first comment.

[lyrixx]

I think this is not the way to go. Instead we should add really PHP type.
It's easily doable for argument since PHP allow it in a BC manner.
But the return type will be a huge BC break!

[tolik518]

@lyrixx Could you please elaborate on what you mean by BC?

You mean instead of

     * @param string $command
     * @param array  $args
     * @param array  $options
     *
     * @return Process
     private static function getProcess($command, array $args = [], array $options = [])

one should write

     * @param string $command
     * @param array  $args
     * @param array  $options
     private static function getProcess($command, array $args = [], array $options = []): Process

I'm all for it but I thought this wouldn't work with PHP 5.6. If it does work - it won't work with mixed types at least.

If this is ok, could I go one step further and add PHP typing for all the arguments as well to ditch the DocBlocks entirely?

[lyrixx]

BC mean Backward Compatible. see https://symfony.com/bc ; We should use the same policy.

The patch would be:

    /**
     * This internal method is used to create a process object.
     *
     * @return Process
     */
    private static function getProcess(string $command, array $args = [], array $options = [])

[tolik518]

Oh I see, I misunderstood you completely the first time.
So if I understood you correctly this time then I should add typed arguments instead of DocBlocks, but leave the Return in the DocBlocks?

I haven't worked much where BC was needed, so its better I'll ask you.
Is this case also valid when writing instead of this

    /**
     * @param Commit | string $hash
     *
     * @return Tag[] An array of Tag objects
     */
    public function resolveTags($hash)

this

    /**
     * @return Tag[] An array of Tag objects
     */
    public function resolveTags(Commit | string $hash)

[lyrixx]

Unfortunately, this project is still compatible with PHP 5.6 😨 ! So wee cannot write this code (union). But with PHP 8+, you can 👍🏼

I'll bump this and I'll do a new release (next week I guess)

[tolik518]

Perfect. Should I change everything that's not a union-type to php types instead of DocBlocks though like you required?

[lyrixx]

yes, please :)

[tolik518]

I just figured out that primitive type-hints weren't supported until PHP 7.0.
So all I can do is add native type-hints only for arrays and objects.

[lyrixx]

can you wait a bit? I'll bump some things...

[lyrixx]

see #204 🎉