feat: add php mess detector

myparcelnl · Jul 29, 2022 · df9abe2 · df9abe2
commit df9abe2
Show file tree

Hide file tree

Showing 17 changed files with 4,703 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+*   @myparcelnl/integration
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+
+  - package-ecosystem: 'composer'
+    directory: '/'
+    schedule:
+      interval: 'daily'
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -0,0 +1,11 @@
+name: 'Release 🚀'
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    uses: myparcelnl/actions/.github/workflows/--semantic-release.yml@v2
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+node_modules
+vendor
+
+.*.cache
+.DS_Store
+yarn-*.log
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/jsLibraryMappings.xml b/.idea/jsLibraryMappings.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/mypa-devtools.iml b/.idea/mypa-devtools.iml
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+# MyParcel PHP DevTools
+
+These tools are used to make a consistent php workflow.
+
+## Installation
+
+```bash
+composer require --dev myparcelnl/devtools
+```
+
+## Included tools
+
+- [PHPMD](#PHPMD)
+
+## Configuration
+
+### PHPMD
+
+Create a new file in your project root called `phpmd.xml`.
+
+Paste the following content into it:
+
+```xml
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         name="MyParcel"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sourceforge.io/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="https://pmd.sourceforge.io/ruleset_xml_schema.xsd">
+    <description />
+
+    <rule ref="vendor/myparcelnl/devtools/phpmd.xml">
+        <exclude name="StaticAccess" />
+    </rule>
+</ruleset>
+```
+
+Then set up your IDE so PHPMD inspections are enabled.
diff --git a/composer.json b/composer.json
@@ -0,0 +1,16 @@
+{
+  "name": "myparcelnl/devtools",
+  "version": "0.0.0",
+  "description": "Dev tools for linting and analysing php projects.",
+  "require": {
+    "php": ">= 7",
+    "phpmd/phpmd": ">= 2.0"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Edie Lemoine",
+      "email": "[email protected]"
+    }
+  ]
+}