use GitHub Actions and PHAN

.github/workflows/lint.yml

@@ -0,0 +1,49 @@
+name: Lint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  lint-js:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+    - name: Set up Node
+      uses: actions/setup-node@v1
+    - name: Set up Stylelint Problem Matcher
+      uses: xt0rted/stylelint-problem-matcher@v1
+    - name: Install Dependencies
+      run: npm ci
+    - name: lint JavaScript
+      run: make lint-js
+    - name: lint Stylesheets
+      run: make lint-css
+    - name: build JavaScript
+      run: make build-js-production
+    env:
+      CI: true
+
+  lint-xml:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+    - name: Setup xmllint
+      run: sudo apt-get install --no-install-recommends -y libxml2-utils
+    - name: lint XML
+      run: make lint-xml
+
+  lint-php:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+    - name: Set up php${{ matrix.php-versions }}
+      uses: shivammathur/setup-php@master
+    - name: Install Dependencies
+      run: composer install --prefer-dist
+    - name: lint PHP
+      run: make lint-php

.phan/config.php

@@ -0,0 +1,11 @@
+<?php
+
+return [
+    'directory_list' => [
+        'lib/',
+        'vendor/',
+    ],
+    "exclude_analysis_directory_list" => [
+        'vendor/',
+    ],
+];

.phan/to-annotation.php

@@ -0,0 +1,21 @@
+<?php
+
+$json = file_get_contents('php://stdin');
+$items = json_decode($json);
+$errors = 0;
+
+foreach ($items as $item) {
+	$type = ($item->severity >= 10 ? 'error' : 'warning');
+	echo '::' . $type;
+	echo ' file=' . $item->location->path;
+	echo ',line=' . $item->location->lines->begin;
+	$message = explode(' ', $item->description, 3);
+	echo '::' . $message[2] . ' ['.$message[1].']';
+	echo PHP_EOL;
+	if ($type === 'error') {
+		$errors++;
+	}
+}
+
+exit($errors);
+

.scrutinizer.yml

@@ -11,8 +11,6 @@ build:
                         tests:
                                 override:
                                         - php-scrutinizer-run
-                                        - phpcs-run --standard=phpcs.xml appinfo/ lib/
-                                        - eslint-run --ext .js,.vue src
 
 tools:
         external_code_coverage: false

Makefile

@@ -91,26 +91,28 @@ test-coverage:
 	npm run test:coverage
 
 # Linting
-lint: lint-php lint-js lint-css lint-nextcloud
+lint: lint-php lint-js lint-css lint-xml
 
 lint-php:
 	# Check PHP syntax errors
 	@! find lib/ -name "*.php" | xargs -I{} php -l '{}' | grep -v "No syntax errors detected"
 	# PHP CodeSniffer
 	vendor/bin/phpcs --standard=phpcs.xml --runtime-set ignore_warnings_on_exit 1 appinfo/ lib/
+	# PHAN
+	vendor/phan/phan/phan --allow-polyfill-parser -k .phan/config.php --no-progress-bar -m json | php .phan/to-annotation.php
+	# Check min-version consistency
+	php tests/nextcloud-version.php
 
 lint-js:
 	npm run lint
 
 lint-css:
 	npm run stylelint
 
-lint-nextcloud:
+lint-xml:
 	# Check info.xml schema validity
 	wget https://apps.nextcloud.com/schema/apps/info.xsd -P appinfo/ -N --no-verbose || [ -f appinfo/info.xsd ]
 	xmllint appinfo/info.xml --schema appinfo/info.xsd --noout
-	# Check min-version consistency
-	php tests/nextcloud-version.php
 
 # Fix lint
 lint-fix: lint-php-fix lint-js-fix lint-css-fix

composer.json

@@ -1,6 +1,7 @@
 {
 	"require-dev": {
 		"christophwurst/nextcloud": "^15.0",
-		"squizlabs/php_codesniffer": "3.*"
+		"squizlabs/php_codesniffer": "3.*",
+		"phan/phan": "^2.0"
 	}
 }

lib/Controller/NotesController.php

@@ -111,7 +111,7 @@ public function get($id) {
 			$this->userId,
 			$this->appName,
 			'notesLastViewedNote',
-			$id
+			strval($id)
 		);
 
 		$note = $this->notesService->get($id, $this->userId);
@@ -180,7 +180,7 @@ public function category($id, $category) {
 	 */
 	public function favorite($id, $favorite) {
 		$result = $this->notesService->favorite($id, $favorite, $this->userId);
-		return new DataResponse($result);
+		return new DataResponse($result); // @phan-suppress-current-line PhanTypeMismatchArgument
 	}
 
 

lib/Controller/SettingsController.php

@@ -3,11 +3,8 @@
 
 use OCP\AppFramework\Controller;
 
-use OCP\IConfig;
 use OCP\IRequest;
-use OCP\IUserManager;
 use OCP\IUserSession;
-use OCP\Files\IRootFolder;
 use OCP\AppFramework\Http\JSONResponse;
 use OCA\Notes\Service\SettingsService;
 

lib/Db/Note.php

@@ -38,6 +38,8 @@ class Note extends Entity {
 	public $error = false;
 	public $errorMessage='';
 
+	private const TAG_FAVORITE = \OC\Tags::TAG_FAVORITE; // @phan-suppress-current-line PhanUndeclaredClassConstant
+
 	public function __construct() {
 		$this->addType('modified', 'integer');
 		$this->addType('favorite', 'boolean');
@@ -54,7 +56,6 @@ public static function fromFile(File $file, Folder $notesFolder, $tags = [], $on
 			$fileContent=$file->getContent();
 			$note->setContent(self::convertEncoding($fileContent));
 		}
-		$note->setModified($file->getMTime());
 		if (!$onlyMeta) {
 			$note->updateETag();
 		}
@@ -72,7 +73,6 @@ public static function fromException($message, File $file, Folder $notesFolder,
 		$note->setErrorMessage($message);
 		$note->setError(true);
 		$note->setContent($message);
-		$note->setModified(null);
 		$note->resetUpdatedFields();
 		return $note;
 	}
@@ -87,11 +87,12 @@ private static function convertEncoding($str) {
 	private function initCommonBaseFields(File $file, Folder $notesFolder, $tags) {
 		$this->setId($file->getId());
 		$this->setTitle(pathinfo($file->getName(), PATHINFO_FILENAME)); // remove extension
+		$this->setModified($file->getMTime());
 		$subdir = substr(dirname($file->getPath()), strlen($notesFolder->getPath())+1);
 		$this->setCategory($subdir ? $subdir : '');
-		if (is_array($tags) && in_array(\OC\Tags::TAG_FAVORITE, $tags)) {
+		if (is_array($tags) && in_array(self::TAG_FAVORITE, $tags)) {
 			$this->setFavorite(true);
-			//unset($tags[array_search(\OC\Tags::TAG_FAVORITE, $tags)]);
+			//unset($tags[array_search(self::TAG_FAVORITE, $tags)]);
 		}
 	}
 

lib/Service/MetaService.php

@@ -2,7 +2,6 @@
 
 namespace OCA\Notes\Service;
 
-use OCA\Notes\Db\Note;
 use OCA\Notes\Db\Meta;
 use OCA\Notes\Db\MetaMapper;
 

lib/Service/NoteUtil.php

@@ -2,35 +2,37 @@
 
 namespace OCA\Notes\Service;
 
+use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\ILogger;
-use OCP\Encryption\Exceptions\GenericEncryptionException;
 use OCP\Files\IRootFolder;
 use OCP\Files\FileInfo;
 use OCP\Files\File;
 use OCP\Files\Folder;
 
-use OCA\Notes\Db\Note;
-
 class NoteUtil {
 
+	private $db;
 	private $l10n;
 	private $root;
 	private $logger;
 	private $appName;
 
 	/**
+	 * @param IDBConnection $db
 	 * @param IRootFolder $root
 	 * @param IL10N $l10n
 	 * @param ILogger $logger
 	 * @param String $appName
 	 */
 	public function __construct(
+		IDBConnection $db,
 		IRootFolder $root,
 		IL10N $l10n,
 		ILogger $logger,
 		$appName
 	) {
+		$this->db = $db;
 		$this->root = $root;
 		$this->l10n = $l10n;
 		$this->logger = $logger;
@@ -44,7 +46,7 @@ public function gatherNoteFiles(Folder $folder) : array {
 		$notes = [];
 		$nodes = $folder->getDirectoryListing();
 		foreach ($nodes as $node) {
-			if ($node->getType() === FileInfo::TYPE_FOLDER) {
+			if ($node->getType() === FileInfo::TYPE_FOLDER && $node instanceof Folder) {
 				$notes = array_merge($notes, $this->gatherNoteFiles($node));
 				continue;
 			}
@@ -59,7 +61,7 @@ public function gatherNoteFiles(Folder $folder) : array {
 	/**
 	 * test if file is a note
 	 */
-	public function isNote(File $file) : bool {
+	public function isNote(FileInfo $file) : bool {
 		$allowedExtensions = ['txt', 'org', 'markdown', 'md', 'note'];
 		$ext = strtolower(pathinfo($file->getName(), PATHINFO_EXTENSION));
 		return $file->getType() === 'file' && in_array($ext, $allowedExtensions);
@@ -96,7 +98,10 @@ public function moveNote(Folder $notesFolder, File $file, $category, string $tit
 			$file->move($newFilePath);
 		}
 		if ($currentBasePath !== $basePath) {
-			$this->deleteEmptyFolder($notesFolder, $this->root->get($currentBasePath));
+			$fileBasePath = $this->root->get($currentBasePath);
+			if ($fileBasePath instanceof Folder) {
+				$this->deleteEmptyFolder($notesFolder, $fileBasePath);
+			}
 		}
 	}
 
@@ -171,7 +176,7 @@ public function sanitisePath(string $str) : string {
 
 		// if mysql doesn't support 4byte UTF-8, then remove those characters
 		// see \OC\Files\Storage\Common::verifyPath(...)
-		if (!\OC::$server->getDatabaseConnection()->supports4ByteText()) {
+		if (!$this->db->supports4ByteText()) {
 			$str = preg_replace('%(?:
                 \xF0[\x90-\xBF][\x80-\xBF]{2}      # planes 1-3
               | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15

lib/Service/NotesService.php

@@ -4,7 +4,6 @@
 
 use OCP\Encryption\Exceptions\GenericEncryptionException;
 use OCP\Files\File;
-use OCP\Files\FileInfo;
 use OCP\Files\Folder;
 use OCP\Files\IRootFolder;
 use OCP\IConfig;

lib/Service/SettingsService.php

@@ -2,14 +2,7 @@
 
 namespace OCA\Notes\Service;
 
-use OCP\AppFramework\Controller;
-
 use OCP\IConfig;
-use OCP\IRequest;
-use OCP\IUserManager;
-use OCP\IUserSession;
-use OCP\Files\IRootFolder;
-use OCP\AppFramework\Http\JSONResponse;
 
 class SettingsService {
 

src/components/EditorMarkdownIt.vue

@@ -1,4 +1,5 @@
 <template>
+	<!-- eslint-disable-next-line vue/no-v-html -->
 	<div class="note-preview" v-html="html" />
 </template>
 <script>