Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Fast Forward Development Tools for PHP projects.
7 *
8 * This file is part of fast-forward/dev-tools project.
9 *
10 * @author   Felipe SayĆ£o Lobato Abreu <github@mentordosnerds.com>
11 * @license  https://opensource.org/licenses/MIT MIT License
12 *
13 * @see      https://github.com/php-fast-forward/
14 * @see      https://github.com/php-fast-forward/dev-tools
15 * @see      https://github.com/php-fast-forward/dev-tools/issues
16 * @see      https://php-fast-forward.github.io/dev-tools/
17 * @see      https://datatracker.ietf.org/doc/html/rfc2119
18 */
19
20namespace FastForward\DevTools\Git;
21
22/**
23 * Provides semantic Git operations for repository-aware services.
24 */
25interface GitClientInterface
26{
27    /**
28     * Returns a Git config value for the selected repository.
29     *
30     * @param string $key
31     * @param ?string $workingDirectory
32     */
33    public function getConfig(string $key, ?string $workingDirectory = null): string;
34
35    /**
36     * Returns the file contents shown from a specific Git reference.
37     *
38     * @param string $reference
39     * @param string $path
40     * @param ?string $workingDirectory
41     */
42    public function show(string $reference, string $path, ?string $workingDirectory = null): string;
43}