chore: switch to alchemy

mychidarko · mychidarko · commit 139fc71aab17 · 2025-01-20T20:03:11.000Z
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,34 @@
+name: Lint code
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          extensions: json, zip
+          tools: composer:v2
+          coverage: none
+
+      - name: Install PHP dependencies
+        run: composer update --no-interaction --no-progress
+
+      - name: Run Linter
+        run: composer run lint
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: 'chore: fix styling'
diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,6 @@ Thumbs.db
 
 # phpstorm
 .idea/*
+
+# Alchemy
+.alchemy
diff --git a/.php_cs.dist.php b/.php_cs.dist.php
diff --git a/alchemy.yml b/alchemy.yml
@@ -0,0 +1,61 @@
+app:
+  - src
+
+tests:
+  engine: pest
+  parallel: true
+  paths:
+    - tests
+  files:
+    - '*.test.php'
+  coverage:
+    processUncoveredFiles: true
+
+lint:
+  preset: PSR12
+  rules:
+    single_quote: true
+    phpdoc_scalar: true
+    no_unused_imports: true
+    unary_operator_spaces: true
+    binary_operator_spaces: true
+    phpdoc_var_without_name: true
+    trailing_comma_in_multiline: true
+    phpdoc_single_line_var_spacing: true
+    single_trait_insert_per_statement: true
+    not_operator_with_successor_space: false
+    array_syntax:
+      syntax: short
+    ordered_imports:
+      sort_algorithm: alpha
+    method_argument_space:
+      on_multiline: ensure_fully_multiline
+      keep_multiple_spaces_after_comma: true
+    blank_line_before_statement:
+      statements:
+        - try
+        - break
+        - throw
+        - return
+        - declare
+        - continue
+
+actions:
+  run:
+    - lint
+    - tests
+  os:
+    - macos-latest
+    - ubuntu-latest
+    - windows-latest
+  php:
+    extensions: json, zip
+    versions:
+      - '8.3'
+      - '8.2'
+      - '8.1'
+      - '8.0'
+      - '7.4'
+  events:
+    - push
+    - pull_request
diff --git a/composer.json b/composer.json
@@ -1,49 +1,53 @@
 {
-  "name": "leafs/session",
-  "description": "Leaf PHP session + flash modules",
-  "keywords": [
-    "session",
-    "http",
-    "flash",
-    "leaf",
-    "php",
-    "framework"
-  ],
-  "homepage": "https://leafphp.dev/modules/session/",
-  "type": "library",
-  "license": "MIT",
-  "authors": [
-    {
-      "name": "Michael Darko",
-      "email": "mickdd22@gmail.com",
-      "homepage": "https://mychi.netlify.app",
-      "role": "Developer"
-    }
-  ],
-  "autoload": {
-    "psr-4": {
-      "Leaf\\": "src"
+    "name": "leafs/session",
+    "description": "Leaf PHP session + flash modules",
+    "keywords": [
+        "session",
+        "http",
+        "flash",
+        "leaf",
+        "php",
+        "framework"
+    ],
+    "homepage": "https://leafphp.dev/modules/session/",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Michael Darko",
+            "email": "mickdd22@gmail.com",
+            "homepage": "https://mychi.netlify.app",
+            "role": "Developer"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Leaf\\": "src"
+        },
+        "files": [
+            "src/functions.php"
+        ]
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "leafs/anchor": "*"
+    },
+    "require-dev": {
+        "pestphp/pest": "^1.21",
+        "friendsofphp/php-cs-fixer": "^3.0",
+        "leafs/alchemy": "^2.2"
+    },
+    "scripts": {
+        "format": "vendor/bin/php-cs-fixer fix --config=.php_cs.dist.php --allow-risky=yes",
+        "test": "./vendor/bin/alchemy setup --test",
+        "alchemy": "./vendor/bin/alchemy setup",
+        "lint": "./vendor/bin/alchemy setup --lint",
+        "actions": "./vendor/bin/alchemy setup --actions"
     },
-    "files": [
-      "src/functions.php"
-    ]
-  },
-  "minimum-stability": "dev",
-  "prefer-stable": true,
-  "require": {
-    "leafs/anchor": "*"
-  },
-  "require-dev": {
-    "pestphp/pest": "^1.21",
-    "friendsofphp/php-cs-fixer": "^3.0"
-  },
-  "scripts": {
-    "format": "vendor/bin/php-cs-fixer fix --config=.php_cs.dist.php --allow-risky=yes",
-    "test": "vendor/bin/pest"
-  },
-  "config": {
-    "allow-plugins": {
-      "pestphp/pest-plugin": true
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     }
-  }
-}
+}
diff --git a/phpunit.xml b/phpunit.xml
diff --git a/src/Http/Session.php b/src/Http/Session.php
@@ -53,7 +53,7 @@ public static function get($param, $default = null, bool $sanitize = true)
      *
      * @param string $key the key to retrieve and remove the value for
      * @param mixed $defaultValue the default value to return if the requested value cannot be found
-     * @param boolean $sanitize Whether to sanitize the returned value
+     * @param bool $sanitize Whether to sanitize the returned value
      *
      * @return mixed the requested value or the default value
      */

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public static function get($param, $default = null, bool $sanitize = true)`
`53`	`53`	`*`
`54`	`54`	`* @param string $key the key to retrieve and remove the value for`
`55`	`55`	`* @param mixed $defaultValue the default value to return if the requested value cannot be found`
`56`		`- * @param boolean $sanitize Whether to sanitize the returned value`
	`56`	`+ * @param bool $sanitize Whether to sanitize the returned value`
`57`	`57`	`*`
`58`	`58`	`* @return mixed the requested value or the default value`
`59`	`59`	`*/`