Skip to content

Commit 2dbb1e8

Browse files
token-cjgtoken-cjg
authored
Add lint commands + fix lint errors (#554)
- Add build + clean commands to makefile - Refine ci gha check - Bump squizlabs/php_codesniffer to 3.11.2
1 parent b76cbbb commit 2dbb1e8

File tree

86 files changed

+237
-222
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+237
-222
lines changed

‎.github/workflows/ci.yaml

+5-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ jobs:
1818
run: docker build . --file Dockerfile --tag zendesk_api_client_php-app
1919

2020
- name: Run Composer install
21-
run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app composer install
21+
run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make build
22+
23+
- name: Run lint
24+
run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make lint
2225

2326
- name: Run tests
24-
run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"
27+
run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make test

‎Dockerfile

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ FROM php:8.2-cli
33
# OS requirements for PHP
44
RUN apt-get update && apt-get install -y git unzip
55

6+
# Safe requirements to allow Makefile tasks to run
7+
RUN git config --global --add safe.directory /app
8+
69
# PHP requirements
710
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
811
WORKDIR /app

‎Makefile

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
.PHONY: test all
1+
.PHONY: build test lint
2+
3+
build:
4+
composer install
25

36
test:
47
composer test:unit
58

6-
all: test
9+
lint:
10+
composer lint

‎composer.json

+7-4
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,22 @@
1111
},
1212
"require-dev": {
1313
"phpunit/phpunit": "11.5.0",
14-
"squizlabs/php_codesniffer": "2.*",
14+
"squizlabs/php_codesniffer": "3.*",
1515
"phpmd/phpmd": "@stable",
1616
"fakerphp/faker": "^1.24.1",
1717
"psy/psysh": "@stable"
1818
},
1919
"autoload": {
2020
"psr-0": {
2121
"Zendesk\\API\\": "src/",
22-
"Zendesk\\Console\\": "src/"
22+
"Zendesk\\Console\\": "src/",
23+
"Zendesk\\Fixtures\\": "src/"
2324
}
24-
},
25+
},
2526
"scripts": {
2627
"test:unit": "vendor/bin/phpunit --testsuite 'Zendesk API Unit Test Suites'",
27-
"test:live": "vendor/bin/phpunit --testsuite 'Zendesk API Live Test Suites'"
28+
"test:live": "vendor/bin/phpunit --testsuite 'Zendesk API Live Test Suites'",
29+
"lint": "vendor/bin/phpcs --runtime-set ignore_warnings_on_exit 1 --standard=PSR12 --extensions=php --ignore=vendor/ .",
30+
"lint:fix": "vendor/bin/phpcbf --runtime-set ignore_warnings_on_exit 1 --standard=PSR12 --extensions=php --ignore=vendor/ ."
2831
}
2932
}

‎composer.lock

+27-44
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎samples/attachments/uploadFileAttachment.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@
2828
print_r($attachment);
2929
echo "</pre>";
3030
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
31-
echo $e->getMessage().'</br>';
31+
echo $e->getMessage() . '</br>';
3232
}

‎samples/attachments/uploadStreamAttachment.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@
2929
print_r($attachment);
3030
echo "</pre>";
3131
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
32-
echo $e->getMessage().'</br>';
32+
echo $e->getMessage() . '</br>';
3333
}

‎samples/groups/createGroup.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34

45
use Zendesk\API\HttpClient as ZendeskAPI;

‎samples/groups/getGroups.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34

45
use Zendesk\API\HttpClient as ZendeskAPI;

‎samples/helpcenter/createArticles.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,5 @@
2626
print_r($article);
2727
echo "</pre>";
2828
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
29-
echo $e->getMessage().'</br>';
29+
echo $e->getMessage() . '</br>';
3030
}
31-

‎samples/helpcenter/createSections.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@
2828
print_r($section);
2929
echo "</pre>";
3030
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
31-
echo $e->getMessage().'</br>';
31+
echo $e->getMessage() . '</br>';
3232
}

‎samples/helpcenter/findArticles.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@
2424
print_r($articles);
2525
echo "</pre>";
2626
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
27-
echo $e->getMessage().'</br>';
27+
echo $e->getMessage() . '</br>';
2828
}

‎samples/helpcenter/findArticlesBySectionId.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@
2525
print_r($articles);
2626
echo "</pre>";
2727
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
28-
echo $e->getMessage().'</br>';
28+
echo $e->getMessage() . '</br>';
2929
}

‎samples/helpcenter/findCategories.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@
2323
print_r($categories);
2424
echo "</pre>";
2525
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
26-
echo $e->getMessage().'</br>';
26+
echo $e->getMessage() . '</br>';
2727
}

‎samples/helpcenter/findSections.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@
4141
print_r($sections);
4242
echo "</pre>";
4343
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
44-
echo $e->getMessage().'</br>';
44+
echo $e->getMessage() . '</br>';
4545
}

‎samples/organizations/createOrganization.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34
use Zendesk\API\HttpClient as ZendeskAPI;
45

‎samples/sell/getContacts.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@
2323
print_r($contacts);
2424
echo "</pre>";
2525
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
26-
echo $e->getMessage().'</br>';
26+
echo $e->getMessage() . '</br>';
2727
}

‎samples/ticket_fields/createDropdownOption.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34
use Zendesk\API\HttpClient as ZendeskAPI;
45

‎samples/ticket_fields/editDropdownOption.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34
use Zendesk\API\HttpClient as ZendeskAPI;
45

‎samples/ticket_fields/replaceDropdownOptions.php

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34
use Zendesk\API\HttpClient as ZendeskAPI;
45

@@ -11,14 +12,14 @@
1112
$client = new ZendeskAPI($subdomain);
1213
$client->setAuth('basic', ['username' => $username, 'token' => $token]);
1314
try {
14-
$result = $client->ticketFields()->update(51931448, ["custom_field_options"=> [
15+
$result = $client->ticketFields()->update(51931448, ["custom_field_options" => [
1516
[
16-
"name"=> "Apple Pie",
17-
"value"=> "apple_pie"
17+
"name" => "Apple Pie",
18+
"value" => "apple_pie"
1819
],
1920
[
20-
"name"=> "Pecan Pie",
21-
"value"=> "pecan_pie"
21+
"name" => "Pecan Pie",
22+
"value" => "pecan_pie"
2223
]
2324
]
2425
]);

‎samples/tickets/createTicket.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@
3636
print_r($newTicket);
3737
echo "</pre>";
3838
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
39-
echo $e->getMessage().'</br>';
39+
echo $e->getMessage() . '</br>';
4040
}

‎samples/tickets/createTicketWithAttachment.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
$subdomain = "subdomain";
1212
$username = "[email protected]";
1313
$token = "6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv";
14-
$attachment = getcwd().'/sample.jpg';
14+
$attachment = getcwd() . '/sample.jpg';
1515

1616
$client = new ZendeskAPI($subdomain);
1717
$client->setAuth('basic', ['username' => $username, 'token' => $token]);
@@ -46,5 +46,5 @@
4646
print_r($newTicket);
4747
echo "</pre>";
4848
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
49-
echo $e->getMessage().'</br>';
49+
echo $e->getMessage() . '</br>';
5050
}

‎samples/tickets/deleteTicket.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@
2121
$deleteTicket = $client->tickets()->delete($id);
2222
echo "Ticket ($id) has been removed";
2323
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
24-
echo $e->getMessage().'</br>';
24+
echo $e->getMessage() . '</br>';
2525
}

‎samples/tickets/getTicketComments.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@
2525
print_r($tickets);
2626
echo "</pre>";
2727
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
28-
echo $e->getMessage().'</br>';
28+
echo $e->getMessage() . '</br>';
2929
}

‎samples/tickets/getTicketMetrics.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@
2424
print_r($metrics);
2525
echo "</pre>";
2626
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
27-
echo $e->getMessage().'</br>';
27+
echo $e->getMessage() . '</br>';
2828
}

‎samples/tickets/getTickets.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@
2424
print_r($tickets);
2525
echo "</pre>";
2626
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
27-
echo $e->getMessage().'</br>';
27+
echo $e->getMessage() . '</br>';
2828
}

‎samples/tickets/searchTickets.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
try {
1919
// Search the current customer
20-
$params = ['query' =>'[email protected]'];
20+
$params = ['query' => '[email protected]'];
2121
$search = $client->users()->search($params);
2222

2323
if (empty($search->users)) {
@@ -34,5 +34,5 @@
3434
}
3535
}
3636
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
37-
echo $e->getMessage().'</br>';
37+
echo $e->getMessage() . '</br>';
3838
}

‎samples/tickets/updateTicket.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@
2929
print_r($updateTicket);
3030
echo "</pre>";
3131
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
32-
echo $e->getMessage().'</br>';
32+
echo $e->getMessage() . '</br>';
3333
}

‎samples/tickets/viewTicket.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@
2626
print_r($tickets->ticket);
2727
echo "</pre>";
2828
} catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
29-
echo $e->getMessage().'</br>';
29+
echo $e->getMessage() . '</br>';
3030
}

‎samples/users/createUser.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
include("../../vendor/autoload.php");
34

45
use Zendesk\API\HttpClient as ZendeskAPI;

0 commit comments

Comments
 (0)