Update doc (#1)

Author: ArthurJCQ

.github/dependabot.yml

@@ -8,3 +8,7 @@ updates:
     labels:
       - "RFR"
       - "dependencies"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/php.code_quality.yaml

@@ -12,17 +12,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Fetch latest changes
-        uses: actions/checkout@a12a3943b4bdde767164f792f33f40b04645d846 # renovate: tag=v3.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       - name: Prepare/restore dependencies cache
-        uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed # renovate: tag=v2.1.7
+        uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2
         with:
           # NOTE: the allows to reuse it if the composer.json has not changed
           key: composer/${{ runner.os }}/${{ hashFiles('**/composer.json') }}
           path: |
             composer.lock
             vendor/
       - name: Install/update dependencies
-        uses: php-actions/composer@d936bcb900310224b9089aff3337f2221a8df9a0 # renovate: tag=v6.0.0
+        uses: php-actions/composer@8a65f0d3c6a1d17ca4800491a40b5756a4c164f3
         with:
           php_version: ${{ env.PHP_VERSION }}
           args: --ignore-platform-reqs
@@ -37,13 +37,13 @@ jobs:
         tool: [phpcs, phpmd, phpstan, phpunit]
     steps:
       - name: Setup PHP ${{ env.PHP_VERSION }} environment
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@6d7209f44a25a59e904b1ee9f3b0c33ab2cd888d
         with:
           php-version: ${{ env.PHP_VERSION }}
       - name: Fetch lastest changes
-        uses: actions/checkout@v4
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       - name: Restore dependencies cache
-        uses: actions/cache@v4
+        uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2
         with:
           key: composer/${{ runner.os }}/${{ hashFiles('**/composer.json') }}
           path: |
@@ -52,7 +52,7 @@ jobs:
       - name: Run ${{ matrix.tool }}
         run: make ${{ matrix.tool }}-ci
       - name: Upload ${{ matrix.tool }} reports
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@694cdabd8bdb0f10b2cea11669e1bf5453eed0a6
         if: always()
         with:
           name: ${{ matrix.tool }}-reports
@@ -70,18 +70,18 @@ jobs:
 
       # NOTE: only phpunit, phpcs generate reports
       - name: Download phpunit reports
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935
         with:
           name: phpunit-reports
           path: build/
       - name: Download phpcs reports
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935
         with:
           name: phpcs-reports
           path: build/
 
       - name: Report analisys results
-        uses: mikepenz/action-junit-report@v4
+        uses: mikepenz/action-junit-report@b1b7f659602565970688b2e2588738b9398e895d
         with:
           check_name: See PHP code quality reports
           report_paths: build/reports/*.xml

.github/workflows/security.gh-action.yaml

@@ -10,6 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Fetch lastest changes
-        uses: actions/checkout@v4
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       - name: Ensure SHA pinned actions
-        uses: zgosalvez/github-actions-ensure-sha-pinned-actions@v3
+        uses: zgosalvez/github-actions-ensure-sha-pinned-actions@ba37328d4ea95eaf8b3bd6c6cef308f709a5f2ec

Makefile

@@ -24,12 +24,12 @@ phpstan-ci: prepare-ci ## Run PHPStan (CI)
 	EXTRA_ARGS="--error-format=github --no-progress" $(MAKE) phpstan
 .PHONY: phpstan phpstan-ci
 
-#unit-tests: phpunit ## Run unit tests (alias to phpunit)
-#phpunit: ## Run PHPUnit
-#	vendor/bin/phpunit --exclude-group=functional $(EXTRA_ARGS)
-#phpunit-ci: prepare-ci ## Run unit tests (CI)
-#	EXTRA_ARGS="--log-junit $(REPORTS_DIR)/unit-tests.junit.xml" $(MAKE) unit-tests
-#.PHONY: unit-tests unit-tests-ci
+unit-tests: phpunit ## Run unit tests (alias to phpunit)
+phpunit: ## Run PHPUnit
+	vendor/bin/phpunit --exclude-group=functional $(EXTRA_ARGS)
+phpunit-ci: prepare-ci ## Run unit tests (CI)
+	EXTRA_ARGS="--log-junit $(REPORTS_DIR)/unit-tests.junit.xml" $(MAKE) unit-tests
+.PHONY: unit-tests unit-tests-ci
 
 prepare-ci:
 	@mkdir -p build/reports

README.md

@@ -2,26 +2,73 @@
 
 This is the coding style tools config I use everyday on my projects.
 
-## PHPCS
+it includes :
+- PHPCS for code sniffing.
+- PHPStan for static bug finding into code.
+- PHPMD for static performance analysis (complexity, unused expressions, optimizing).
 
-PHPCS for code sniffing : 
+## Installation
 
+Installation with composer :
+
+```bash
+composer require etsglobal/php-static-analysis --dev
+```
+
+## Usage
+
+### PHPCS
+
+In your project, create a `phpcs.xml` file and fill it up with :
+
+```xml
+<?xml version="1.0"?>
+<ruleset name="Arty Coding Standard" 
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+         xsi:noNamespaceSchemaLocation="../../vendor/squizlabs/php_codesniffer/phpcs.xsd">
+    <rule ref="./vendor/arty/php-coding-standard/lib/phpcs/phpcs.xml" />
+</ruleset>
+```
+
+Run it with :
 ```bash
-$ ./vendor/bin/phpcs
+$ ./vendor/bin/phpcs src
 ```
 
-## PHPStan
+### PHPStan
 
-PHPStan for static bug finding into code.
+In your project, create a `phpstan.neon` file and fill it up with :
+
+```neon
+includes:
+    - vendor/arty/php-coding-standard/lib/phpstan/phpstan.neon
+```
 
+Run it with :
 ```bash
-$ ./vendor/bin/phpstan
+$ ./vendor/bin/phpstan analyse --level=max src
 ```
 
-## PHPMD
+### PHPMD
 
-PHPMD for static performance analysis (complexity, unused expressions, optimizing).
+In your project, create a `pphmd.xml` file and fill it up with :
+
+```xml
+<?xml version="1.0"?>
+<ruleset name="Arty ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>
+        Arty ruleset
+    </description>
+
+    <rule ref="./vendor/etsglobal/php-static-analysis/lib/phpmd/phpmd.xml"/>
+</ruleset>
+```
 
+Run it with :
 ```bash
-$ ./vendor/bin/phpmd
+$ ./vendor/bin/phpmd src text phpmd.xml
 ```