use Nextcloud Coding Standard

iolate · Jul 13, 2020 · 017e825 · 017e825
1 parent 552bae2
commit 017e825
Show file tree

Hide file tree

Showing 33 changed files with 111 additions and 47 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@ js/
 report
 clover.xml
 composer.lock
+.php_cs.cache
 appinfo/info.xsd
 
 # just sane ignores

diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+require_once './vendor/autoload.php';
+
+use Nextcloud\CodingStandard\Config;
+
+$config = new Config();
+$config
+	->getFinder()
+	->ignoreVCSIgnored(true)
+	->notPath('build')
+	->notPath('l10n')
+	->notPath('src')
+	->notPath('vendor')
+	->in(__DIR__);
+return $config;
diff --git a/Makefile b/Makefile
@@ -88,8 +88,8 @@ test-api:
 lint: lint-php lint-js lint-css lint-xml
 
 
-lint-php: lint-php-lint lint-php-ncversion lint-php-phan lint-php-phpcs
-lint-phpfast: lint-php-lint lint-php-ncversion lint-php-phpcs
+lint-php: lint-phpfast lint-php-phan
+lint-phpfast: lint-php-lint lint-php-ncversion lint-php-cs-fixer lint-php-phpcs
 
 lint-php-lint:
 	# Check PHP syntax errors
@@ -107,6 +107,10 @@ lint-php-phpcs:
 	# PHP CodeSniffer
 	vendor/bin/phpcs --standard=tests/phpcs.xml appinfo/ lib/ tests/api/ --report=checkstyle | vendor/bin/cs2pr --graceful-warnings --colorize
 
+lint-php-cs-fixer:
+	# PHP Coding Standards Fixer (with Nextcloud coding standards)
+	vendor/bin/php-cs-fixer fix --dry-run --diff
+
 
 lint-js:
 	npm run lint
@@ -125,6 +129,7 @@ lint-fix: lint-php-fix lint-js-fix lint-css-fix
 
 lint-php-fix:
 	vendor/bin/phpcbf --standard=tests/phpcs.xml appinfo/ lib/ tests/api/
+	vendor/bin/php-cs-fixer fix
 
 lint-js-fix:
 	npm run lint:fix

diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -1,4 +1,5 @@
 <?php
+
 return ['routes' => [
 	//////////  P A G E  //////////
 	[

diff --git a/composer.json b/composer.json
@@ -1,6 +1,7 @@
 {
 	"require-dev": {
 		"christophwurst/nextcloud": "^16.0",
+		"nextcloud/coding-standard": "^0.3.0",
 		"squizlabs/php_codesniffer": "3.*",
 		"phan/phan": "^3.0",
 		"guzzlehttp/guzzle": "^7.0",

diff --git a/lib/Application.php b/lib/Application.php
@@ -1,11 +1,12 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes;
 
 use OCP\AppFramework\App;
 
 class Application extends App {
-
 	public static $API_VERSIONS = [ '0.2', '1.1' ];
 
 	public function __construct(array $urlParams = []) {

diff --git a/lib/Capabilities.php b/lib/Capabilities.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes;
 

diff --git a/lib/Controller/Helper.php b/lib/Controller/Helper.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Controller;
 

diff --git a/lib/Controller/NotesApiController.php b/lib/Controller/NotesApiController.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Controller;
 

diff --git a/lib/Controller/NotesController.php b/lib/Controller/NotesController.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Controller;
 

diff --git a/lib/Controller/PageController.php b/lib/Controller/PageController.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Controller;
 
@@ -8,7 +10,6 @@
 use OCP\IRequest;
 
 class PageController extends Controller {
-
 	public function __construct(string $AppName, IRequest $request) {
 		parent::__construct($AppName, $request);
 	}

diff --git a/lib/Controller/SettingsController.php b/lib/Controller/SettingsController.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Controller;
 
@@ -10,7 +12,6 @@
 use OCP\IUserSession;
 
 class SettingsController extends Controller {
-
 	private $service;
 	private $userSession;
 

diff --git a/lib/Db/Meta.php b/lib/Db/Meta.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Db;
 
@@ -21,7 +23,6 @@
  * @package OCA\Notes\Db
  */
 class Meta extends Entity {
-
 	protected $userId;
 	protected $fileId;
 	protected $lastUpdate;

diff --git a/lib/Db/MetaMapper.php b/lib/Db/MetaMapper.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Db;
 
@@ -7,7 +9,6 @@
 use OCP\DB\QueryBuilder\IQueryBuilder;
 
 class MetaMapper extends QBMapper {
-
 	public function __construct(IDBConnection $db) {
 		parent::__construct($db, 'notes_meta');
 	}

diff --git a/lib/Migration/Cleanup.php b/lib/Migration/Cleanup.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Migration;
 
@@ -8,7 +10,6 @@
 use OCP\Migration\IOutput;
 
 class Cleanup implements IRepairStep {
-
 	private $metaMapper;
 
 	public function __construct(MetaMapper $metaMapper) {

diff --git a/lib/Migration/Version3005Date20200528204430.php b/lib/Migration/Version3005Date20200528204430.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Migration;
 

diff --git a/lib/Migration/Version3005Date20200528204431.php b/lib/Migration/Version3005Date20200528204431.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Migration;
 

diff --git a/lib/NotesHooks.php b/lib/NotesHooks.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes;
 

diff --git a/lib/Service/InsufficientStorageException.php b/lib/Service/InsufficientStorageException.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 

diff --git a/lib/Service/MetaService.php b/lib/Service/MetaService.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 
@@ -47,7 +49,6 @@
  * with this approach! :-)
  */
 class MetaService {
-
 	private $metaMapper;
 
 	public function __construct(MetaMapper $metaMapper) {
@@ -105,7 +106,7 @@ public function update(string $userId, Note $note) : void {
 	private function getIndexedArray(array $data, string $property) : array {
 		$property = ucfirst($property);
 		$getter = 'get'.$property;
-		$result = array();
+		$result = [];
 		foreach ($data as $entity) {
 			$result[$entity->$getter()] = $entity;
 		}

diff --git a/lib/Service/Note.php b/lib/Service/Note.php
@@ -1,12 +1,13 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 
 use OCP\Files\File;
 use OCP\Files\Folder;
 
 class Note {
-
 	private $file;
 	private $notesFolder;
 	private $noteUtil;

diff --git a/lib/Service/NoteDoesNotExistException.php b/lib/Service/NoteDoesNotExistException.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 

diff --git a/lib/Service/NoteUtil.php b/lib/Service/NoteUtil.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 
@@ -9,7 +11,6 @@
 use OCP\ILogger;
 
 class NoteUtil {
-
 	private $db;
 	private $l10n;
 	private $root;

diff --git a/lib/Service/NotesFolderException.php b/lib/Service/NotesFolderException.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 

diff --git a/lib/Service/NotesService.php b/lib/Service/NotesService.php
@@ -1,15 +1,14 @@
-<?php declare(strict_types=1);
+<?php
 
-namespace OCA\Notes\Service;
+declare(strict_types=1);
 
-use OCA\Notes\Service\SettingsService;
+namespace OCA\Notes\Service;
 
 use OCP\Files\File;
 use OCP\Files\FileInfo;
 use OCP\Files\Folder;
 
 class NotesService {
-
 	private $metaService;
 	private $settings;
 	private $noteUtil;

diff --git a/lib/Service/SettingsService.php b/lib/Service/SettingsService.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 
@@ -7,7 +9,6 @@
 use OCP\Files\IRootFolder;
 
 class SettingsService {
-
 	private $config;
 	private $l10n;
 	private $root;

diff --git a/lib/Service/TagService.php b/lib/Service/TagService.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Service;
 

diff --git a/templates/main.php b/templates/main.php
@@ -1,4 +1,4 @@
 <?php
+
 script('notes', 'notes');
 style('notes', 'notes');
-?>
diff --git a/tests/api/APIv02Test.php b/tests/api/APIv02Test.php
@@ -1,9 +1,10 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Tests\API;
 
 class APIv02Test extends CommonAPITest {
-
 	public function __construct() {
 		parent::__construct('0.2', true);
 	}

diff --git a/tests/api/APIv1Test.php b/tests/api/APIv1Test.php
@@ -1,9 +1,10 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Tests\API;
 
 class APIv1Test extends CommonAPITest {
-
 	public function __construct() {
 		parent::__construct('1.1', false);
 	}

diff --git a/tests/api/AbstractAPITest.php b/tests/api/AbstractAPITest.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Tests\API;
 

diff --git a/tests/api/CapabilitiesTest.php b/tests/api/CapabilitiesTest.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace OCA\Notes\Tests\API;