diff --git a/.gitignore b/.gitignore index 8f74009cd..c682ada43 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,21 @@ -.build/* +# IDE - IntelliJ .idea/* +# Keep the code styles. +!.idea/codeStyles +.idea/codeStyles/* +!.idea/codeStyles/Project.xml +!.idea/codeStyles/codeStyleConfig.xml +# Keep the inspection levels +!.idea/inspectionProfiles +.idea/inspectionProfiles/* +!.idea/inspectionProfiles/Project_Default.xml + +# project stuff +.build/* docs/* vendor/* composer.lock +phpcs.xml +phpdoc.xml +phpmd.xml +phpunit.xml diff --git a/composer.json b/composer.json index ba4e40ab8..d99f46edb 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "chillerlan/php-qrcode", - "description": "A QR code generator. PHP 7.4+", + "description": "A QR code generator with a user friendly API. PHP 7.4+", "homepage": "https://github.com/chillerlan/php-qrcode", "license": "MIT", "minimum-stability": "stable", @@ -29,13 +29,16 @@ "chillerlan/php-settings-container": "^2.1.4" }, "require-dev": { - "phpunit/phpunit": "^9.6", "phan/phan": "^5.4", - "setasign/fpdf": "^1.8.2" + "phpmd/phpmd": "^2.13", + "phpunit/phpunit": "^9.6", + "setasign/fpdf": "^1.8.2", + "squizlabs/php_codesniffer": "^3.7" }, "suggest": { "chillerlan/php-authenticator": "Yet another Google authenticator! Also creates URIs for mobile apps.", - "setasign/fpdf": "Required to use the QR FPDF output." + "setasign/fpdf": "Required to use the QR FPDF output.", + "simple-icons/simple-icons": "SVG icons that you can use to embed as logos in the QR Code" }, "autoload": { "psr-4": { diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 000000000..926e5aca4 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,188 @@ + + + php-qrcode rules for phpcs + + examples + src + tests + + + + + + error + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + error + + + + error + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + examples + + + + examples + + + + examples + + + + examples + + + + examples + + + diff --git a/phpdoc.xml b/phpdoc.xml.dist similarity index 100% rename from phpdoc.xml rename to phpdoc.xml.dist diff --git a/phpmd.xml.dist b/phpmd.xml.dist new file mode 100644 index 000000000..a6da2dbf9 --- /dev/null +++ b/phpmd.xml.dist @@ -0,0 +1,55 @@ + + + + codemasher/php-qrcode PMD ruleset + */examples/* + */vendor/* + */tests/* + + + + + + + 1 + + + + + + 1 + + + + + + 1 + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/phpunit.xml b/phpunit.xml.dist similarity index 100% rename from phpunit.xml rename to phpunit.xml.dist