Harmonize CI & files (#46)

Author: yoanm

.github/workflows/CI.yml

@@ -10,11 +10,8 @@ on: # Build any PRs and main branch changes
       # In case of updates to those workflows, they must be pre-checked by `pre-check-CI-updates.yml` rather than this workflow !
       # Any updates on those workflows are expected to be restricted to those workflows only ! (no update on code for instance)
       - '.github/workflows/pre-check-CI-updates.yml'
-      - '.github/workflows/CI.yml'
-      - '.github/workflows/coverage-upload.yml'
       - '.github/workflows/reusable-CI-workflow.yml'
       - '.github/workflows/reusable-coverage-upload-workflow.yml'
-      - '.github/workflows/auto-merge-dependabot.yml'
   push:
     branches: [ master ]
   schedule:
@@ -29,7 +26,6 @@ concurrency:
 
 env:
   TEST_OUTPUT_STYLE: pretty
-  COMPOSER_OPTIONS: --optimize-autoloader
 
 jobs:
   tests:

.github/workflows/auto-merge-dependabot.yml

@@ -18,6 +18,12 @@ jobs:
         uses: dependabot/fetch-metadata@v2.4.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Add custom labels
+        run: gh pr edit "${{github.event.pull_request.html_url}}" --add-label "with-nightly-tests"
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
       - name: Enable auto-merge for Dependabot PRs
         if: ${{ steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
         run: gh pr merge --auto --squash "$PR_URL"

.github/workflows/coverage-upload.yml

@@ -9,7 +9,7 @@ permissions:
   checks: write # For the check run creation !
 
 jobs:
-  upload:
+  coverage:
     name: Coverage
     permissions:
       contents: read

.github/workflows/pre-check-CI-updates.yml

@@ -12,11 +12,8 @@ on:
     branches: [master] # Only for PR targeting master branch
     paths: # /!\ Duplicate the same list as `on.pull_request.paths-ignore` property value for CI workflow !
       - '.github/workflows/pre-check-CI-updates.yml' # This workflow
-      - '.github/workflows/CI.yml'
-      - '.github/workflows/coverage-upload.yml'
       - '.github/workflows/reusable-CI-workflow.yml'
       - '.github/workflows/reusable-coverage-upload-workflow.yml'
-      - '.github/workflows/auto-merge-dependabot.yml'
 
 permissions:
   contents: read
@@ -33,7 +30,7 @@ jobs:
       contents: read
     uses: ./.github/workflows/reusable-CI-workflow.yml
 
-  upload:
+  coverage:
     name: Coverage
     needs: [tests]
     permissions:

.remarkrc

@@ -1,6 +1,10 @@
 {
   "plugins": [
     "remark-preset-lint-consistent",
-    "remark-preset-lint-recommended"
+    "remark-preset-lint-recommended",
+    [
+      "remark-lint-list-item-indent",
+      "space"
+    ]
   ]
 }

.scrutinizer.yml

@@ -41,7 +41,6 @@ build:
     variables:
       CI: 'true'
       TEST_OUTPUT_STYLE: 'pretty'
-      COMPOSER_OPTIONS: '--optimize-autoloader'
       COVERAGE_OUTPUT_STYLE: 'clover'
       COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml'
       PHPCS_DISABLE_WARNING: 'true'

CODE_OF_CONDUCT.md

@@ -23,13 +23,13 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
- advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+  address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
 ## Our Responsibilities
 

CONTRIBUTING.md

@@ -1,33 +1,39 @@
 # Contributing
 
 ## Getting Started
- * Fork, then clone the repo:
+
+* Fork, then clone the repo:
+
 ```bash
 git clone git@github.com:your-username/php-jsonrpc-server-doc-sdk.git
-````
+```
+
+* Make sure everything goes well:
 
- * Make sure everything goes well:
 ```bash
 make build
 make test
 ```
 
- * Make your changes (Add/Update tests according to your changes).
- * Make sure tests are still green:
+* Make your changes (Add/Update tests according to your changes).
+* Make sure tests are still green:
+
 ```bash
 make test
 ```
 
- * To check code coverage, launch
+* To check code coverage, launch
+
 ```bash
 make coverage
 ```
 
- * Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/compare/).
- * Wait for feedback or merge.
+* Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/compare/).
+* Wait for feedback or merge.
+
+Some stuff that will increase your pull request's acceptance:
 
-  Some stuff that will increase your pull request's acceptance:
-   * Write tests.
-   * Follow PSR-2 coding style.
-   * Write good commit messages.
-   * Do not rebase or squash your commits when a review has been made.
+* Write tests.
+* Follow PSR-2 coding style.
+* Write good commit messages.
+* Do not rebase or squash your commits when a review has been made.

Makefile

@@ -109,5 +109,13 @@ scrutinizer-behat:
 create-build-directories:
 	mkdir -p ${PHPUNIT_COVERAGE_DIRECTORY} ${BEHAT_COVERAGE_DIRECTORY} ${REPORTS_DIRECTORY}
 
+.PHONY: configure-dev-env
+configure-dev-env:
+	npm install --global remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent
+
+.PHONY: lint-markdown
+lint-markdown:
+	npx remark . --output
+
 .PHONY: build install configure test test-unit test-functional codestyle create-build-directories scrutinizer-behat scrutinizer-phpunit
 .DEFAULT: build

README.md

@@ -2,11 +2,12 @@
 
 [![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)
 [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\&repo=yoanm/php-jsonrpc-server-doc-sdk)](https://dependabot.com)
+![Dependabot Status](https://flat.badgen.net/github/dependabot/yoanm/php-jsonrpc-server-doc-sdk)
+![Last commit](https://badgen.net/github/last-commit/yoanm/php-jsonrpc-server-doc-sdk)
 
 [![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-server-doc-sdk.svg?label=Scrutinizer\&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/build-status/master)
 [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/20dd4e48499342b2ad40d6ce4e17daf2)](https://app.codacy.com/gh/yoanm/php-jsonrpc-server-doc-sdk/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/20dd4e48499342b2ad40d6ce4e17daf2)](https://app.codacy.com/gh/yoanm/php-jsonrpc-server-doc-sdk/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
 
 [![CI](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk/actions/workflows/CI.yml)
 [![codecov](https://codecov.io/gh/yoanm/php-jsonrpc-server-doc-sdk/branch/master/graph/badge.svg?token=NHdwEBUFK5)](https://codecov.io/gh/yoanm/php-jsonrpc-server-doc-sdk)
@@ -22,76 +23,76 @@ See [yoanm/jsonrpc-params-symfony-constraint-doc-sdk](https://github.com/yoanm/p
 
 ## Availble formats
 
-*   Raw : Built-in `json` format
-*   Swagger : [yoanm/jsonrpc-http-server-swagger-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
-*   OpenApi : [yoanm/jsonrpc-http-server-openapi-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)
+* Raw : Built-in `json` format
+* Swagger : [yoanm/jsonrpc-http-server-swagger-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
+* OpenApi : [yoanm/jsonrpc-http-server-openapi-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)
 
 ## How to use
 
 ### Php objects
 
 Available documentation objects:
 
-*   [`ServerDoc`](./src/Domain/Model/ServerDoc.php) and [`HttpServerDoc`](./src/Domain/Model/HttpServerDoc.php) for HTTP server
-*   [`MethodDoc`](./src/Domain/Model/MethodDoc.php)
-*   [`ErrorDoc`](./src/Domain/Model/ErrorDoc.php)
-*   [`TagDoc`](./src/Domain/Model/TagDoc.php) : Allow to tag methods
-*   Types :
-    *   [`TypeDoc`](./src/Domain/Model/Type/TypeDoc.php) : Basic type
-        *   [`BooleanDoc`](./src/Domain/Model/Type/BooleanDoc.php)
-        *   [`ScalarDoc`](./src/Domain/Model/Type/ScalarDoc.php)
-            *   [`StringDoc`](./src/Domain/Model/Type/StringDoc.php)
-            *   [`NumberDoc`](./src/Domain/Model/Type/NumberDoc.php)
-                *   [`IntegerDoc`](./src/Domain/Model/Type/IntegerDoc.php)
-                *   [`FloatDoc`](./src/Domain/Model/Type/FloatDoc.php)
-        *   [`CollectionDoc`](./src/Domain/Model/Type/CollectionDoc.php)
-            *   [`ArrayDoc`](./src/Domain/Model/Type/ArrayDoc.php)
-            *   [`ObjectDoc`](./src/Domain/Model/Type/ObjectDoc.php)
+* [`ServerDoc`](./src/Domain/Model/ServerDoc.php) and [`HttpServerDoc`](./src/Domain/Model/HttpServerDoc.php) for HTTP server
+* [`MethodDoc`](./src/Domain/Model/MethodDoc.php)
+* [`ErrorDoc`](./src/Domain/Model/ErrorDoc.php)
+* [`TagDoc`](./src/Domain/Model/TagDoc.php) : Allow to tag methods
+* Types :
+  * [`TypeDoc`](./src/Domain/Model/Type/TypeDoc.php) : Basic type
+    * [`BooleanDoc`](./src/Domain/Model/Type/BooleanDoc.php)
+    * [`ScalarDoc`](./src/Domain/Model/Type/ScalarDoc.php)
+      * [`StringDoc`](./src/Domain/Model/Type/StringDoc.php)
+      * [`NumberDoc`](./src/Domain/Model/Type/NumberDoc.php)
+        * [`IntegerDoc`](./src/Domain/Model/Type/IntegerDoc.php)
+        * [`FloatDoc`](./src/Domain/Model/Type/FloatDoc.php)
+    * [`CollectionDoc`](./src/Domain/Model/Type/CollectionDoc.php)
+      * [`ArrayDoc`](./src/Domain/Model/Type/ArrayDoc.php)
+      * [`ObjectDoc`](./src/Domain/Model/Type/ObjectDoc.php)
 
 ### Normalizers
 
 Available normalizers :
 
-*   [`TypeDocNormalizer`](./src/Infra/Normalizer/TypeDocNormalizer.php)
-    ```php
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TypeDocNormalizer;
-
-    $typeDocNormalizer = new TypeDocNormalizer();
-    ```
-*   [`TagDocNormalizer`](./src/Infra/Normalizer/TagDocNormalizer.php)
-    ```php
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TagDocNormalizer;
-
-    $tagDocNormalizer = new TagDocNormalizer();
-    ```
-*   [`ErrorDocNormalizer`](./src/Infra/Normalizer/ErrorDocNormalizer.php)
-    ```php
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
-
-    $errorDocNormalizer = new ErrorDocNormalizer($typeDocNormalizer);
-    ```
-*   [`MethodDocNormalizer`](./src/Infra/Normalizer/MethodDocNormalizer.php)
-    ```php
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
-
-    $tagDocNormalizer = new MethodDocNormalizer(
-      $typeDocNormalizer,
-      $errorDocNormalizer
-    );
-    ```
-*   [`ServerDocNormalizer`](./src/Infra/Normalizer/ServerDocNormalizer.php) and [`HttpServerDocNormalizer`](./src/Infra/Normalizer/HttpServerDocNormalizer.php) for HTTP server
-    ```php
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer;
-    use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer;
-
-    $normalizer = new ServerDocNormalizer(
-      $methodDocNormalizer,
-      $tagDocNormalizer,
-      $errorDocNormalizer
-    );
-
-    $httpNormalizer = new HttpServerDocNormalizer($normalizer);
-    ```
+* [`TypeDocNormalizer`](./src/Infra/Normalizer/TypeDocNormalizer.php)
+  ```php
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TypeDocNormalizer;
+
+  $typeDocNormalizer = new TypeDocNormalizer();
+  ```
+* [`TagDocNormalizer`](./src/Infra/Normalizer/TagDocNormalizer.php)
+  ```php
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TagDocNormalizer;
+
+  $tagDocNormalizer = new TagDocNormalizer();
+  ```
+* [`ErrorDocNormalizer`](./src/Infra/Normalizer/ErrorDocNormalizer.php)
+  ```php
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
+
+  $errorDocNormalizer = new ErrorDocNormalizer($typeDocNormalizer);
+  ```
+* [`MethodDocNormalizer`](./src/Infra/Normalizer/MethodDocNormalizer.php)
+  ```php
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
+
+  $tagDocNormalizer = new MethodDocNormalizer(
+    $typeDocNormalizer,
+    $errorDocNormalizer
+  );
+  ```
+* [`ServerDocNormalizer`](./src/Infra/Normalizer/ServerDocNormalizer.php) and [`HttpServerDocNormalizer`](./src/Infra/Normalizer/HttpServerDocNormalizer.php) for HTTP server
+  ```php
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer;
+  use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer;
+
+  $normalizer = new ServerDocNormalizer(
+    $methodDocNormalizer,
+    $tagDocNormalizer,
+    $errorDocNormalizer
+  );
+
+  $httpNormalizer = new HttpServerDocNormalizer($normalizer);
+  ```
 
 ## Contributing