Merge pull request #24 from jkowalleck/QA-tools

maintenance and config files - QA prep for #23

.editorconfig

@@ -0,0 +1,34 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.php]
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+# trailing white spaces are used for linebreaks in paragraphs.
+trim_trailing_whitespace = false
+
+[composer.{json,lock}]
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[{.php_cs,.php_cs.dist}]
+# in fact its another php file
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.{yml,yaml,neon,neon.dist}]
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,23 @@
+* text=auto
+
+*.md          diff=markdown
+*.php         diff=php
+composer.lock diff=json
+.php_cs       diff=php
+.php_cs.dist  diff=php
+*.xml.dist    diff=xml
+*.neon        diff=yaml
+*.neon.dist   diff=yaml
+
+# files that are not bundled into the "dist" release are marked `export-ignore`
+.gitattributes      export-ignore
+.gitignore          export-ignore
+.editorconfig       export-ignore
+/.github            export-ignore
+/tests              export-ignore
+/tools              export-ignore
+/.php_cs.dist       export-ignore
+/phpunit.xml.dist   export-ignore
+/psalm.xml.dist     export-ignore
+/HISTORY.md         export-ignore
+/CODEOWNERS         export-ignore

.gitignore

@@ -1,4 +1,20 @@
 /vendor/
 
-# Because we're supporting PHP 5 and 7, we cannot distribute the lockfile
-composer.lock
+# This is not a project.
+# Therefore we MUST NOT keep the lock file, so to support (CI-)tests on different setups/systems.
+# That is also the reason why we dont do exact dev-requirements pinning but use ranges.
+/composer.lock
+
+/.php_cs
+/.php_cs.cache
+
+/phpunit.xml
+/.phpunit.cache/
+
+/psalm.xml
+/.psalm.cache/
+
+
+# these are the target of test tools and such
+/reports/
+/CI_reports/

composer.json

@@ -3,12 +3,25 @@
     "description": "Creates CycloneDX Software Bill-of-Materials (SBOM) from PHP Composer projects",
     "type": "composer-plugin",
     "license": "Apache-2.0",
+    "homepage": "https://github.com/CycloneDX/cyclonedx-php-composer/",
+    "support": {
+        "issues": "https://github.com/CycloneDX/cyclonedx-php-composer/issues"
+    },
     "authors": [
         {
             "name": "nscuro",
-            "email": "[email protected]"
+            "email": "[email protected]",
+            "role": "Developer"
         }
     ],
+    "extra": {
+        "class": "CycloneDX\\ComposerPlugin"
+    },
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
+    },
+    "prefer-stable": true,
     "require": {
         "php": "^7.1 || ^8.0",
         "ext-xmlwriter": "*",
@@ -30,8 +43,5 @@
         "test": [
             "phpunit --bootstrap vendor/autoload.php tests"
         ]
-    },
-    "extra": {
-        "class": "CycloneDX\\ComposerPlugin"
     }
 }