use composer for psalm

Boris-de · Oct 3, 2023 · a3506a6 · a3506a6
1 parent b1f64f4
commit a3506a6
Show file tree

Hide file tree

Showing 5 changed files with 2,111 additions and 5 deletions.
diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml
@@ -28,12 +28,17 @@ jobs:
 
       - name: Psalm
         uses: docker://vimeo/psalm-github-actions
+        with:
+          composer_require_dev: true
+          composer_ignore_platform_reqs: true
 
       - name: Psalm Security Analysis
         uses: docker://vimeo/psalm-github-actions
         with:
           security_analysis: true
           report_file: results.sarif
+          composer_require_dev: true
+          composer_ignore_platform_reqs: true
 
       - name: Upload Security Analysis results to GitHub
         uses: github/codeql-action/upload-sarif@v2

diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ albums
 test-album
 *-private
 test/tmp
+vendor
diff --git a/Makefile b/Makefile
@@ -18,6 +18,7 @@ DOCKER ?= docker
 TEST_ALBUM_DIR = test-album
 
 PSALM_MARKER = $(BUILD_DIR)/.psalm
+COMPOSER_PSALM_MARKER = $(BUILD_DIR)/.composer-psalm
 COVERAGE_MARKER = $(BUILD_DIR)/coverage/.marker
 MIG_SITE_MARKER = $(BUILD_DIR)/.site
 BUILD_DIR_MARKER = $(BUILD_DIR)/.marker
@@ -178,10 +179,14 @@ container-webserver: $(INDEX_PHP) $(TEST_ALBUM_DIR)
 	$(DOCKER) stop $(CONTAINER_NAME)
 	$(DOCKER) rm $(CONTAINER_NAME)
 
+$(COMPOSER_PSALM_MARKER):
+	composer install
+	@touch $(COMPOSER_PSALM_MARKER)
+
 psalm: $(PSALM_MARKER)
-$(PSALM_MARKER): $(INDEX_PHP) $(BUILD_DIR_MARKER)
-	psalm $<
-	psalm --taint-analysis $<
+$(PSALM_MARKER): $(INDEX_PHP) $(BUILD_DIR_MARKER) $(COMPOSER_PSALM_MARKER)
+	./vendor/vimeo/psalm/psalm $<
+	./vendor/vimeo/psalm/psalm --taint-analysis $<
 	@touch $(PSALM_MARKER)
 
 albums: $(TEST_ALBUM_MARKER)
@@ -193,13 +198,14 @@ dev-server: albums
 
 clean-marker:
 	rm -f $(PSALM_MARKER) $(COVERAGE_MARKER) $(MIG_SITE_MARKER) $(BUILD_DIR_MARKER) $(UNITTESTS_MARKER) \
-		$(TEST_ALBUM_MARKER) $(CONTAINER_UNITTESTS_MARKER) $(CONTAINER_UNITTESTS_ALL_MARKER) $(PHPUNIT_DIR_MARKER)
+		$(TEST_ALBUM_MARKER) $(CONTAINER_UNITTESTS_MARKER) $(CONTAINER_UNITTESTS_ALL_MARKER) $(PHPUNIT_DIR_MARKER) \
+		$(COMPOSER_PSALM_MARKER)
 
 clean: clean-marker
 	make -C docs clean
 	$(DOCKER) image rm $(CONTAINER_NAME) $(CONTAINER_NAME_PHPUNIT) 1>/dev/null 2>&1 || true
 	rm -f $(INDEX_PHP) albums $(PHPUNIT_FILES)
-	rm -rf test-album $(PHPUNIT_DIR) $(BUILD_DIR) $(CONTAINER_UNITTEST_TMP)
+	rm -rf test-album $(PHPUNIT_DIR) $(BUILD_DIR) $(CONTAINER_UNITTEST_TMP) vendor
 
 $(BUILD_DIR_MARKER):
 	mkdir -p $(BUILD_DIR)

diff --git a/composer.json b/composer.json
@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "vimeo/psalm": "^5.15"
+    }
+}