diff --git a/.github/workflows/assembly-readme.yml b/.github/workflows/assembly-readme.yml index c589c8c..e71c018 100644 --- a/.github/workflows/assembly-readme.yml +++ b/.github/workflows/assembly-readme.yml @@ -10,13 +10,12 @@ on: env: # PHP Configuration - PHP_MODULES-7.4: none,xdebug-3.1.6,bcmath,bz2,calendar,Core,ctype,curl,date,dom,exif,fileinfo,filter,gd,hash,iconv,intl,json,libxml,mbstring,openssl,pcre,PDO,Phar,readline,Reflection,session,SimpleXML,soap,sockets,SPL,standard,tokenizer,xml,xmlreader,xmlwriter,xsl,zip,zlib PHP_MODULES: none,bcmath,bz2,calendar,Core,ctype,curl,date,dom,exif,fileinfo,filter,gd,hash,iconv,intl,json,libxml,mbstring,openssl,pcre,PDO,Phar,readline,Reflection,session,SimpleXML,soap,sockets,SPL,standard,tokenizer,xml,xmlreader,xmlwriter,xsl,zip,zlib PHPUNIT_DIR: ${{ github.workspace }}/target/analysis/phpunit PHPUNIT_LOG: ${{ github.workspace }}/target/analysis/phpunit/phpunit-test.log # User Configuration - AUTH_DIR: "${HOME}/.ya-corapi" + AUTH_DIR: "${HOME}" DOCU_SRC_DIR: "site/resources" @@ -55,27 +54,27 @@ jobs: run: asciidoctor-reducer --preserve-conditionals -o README.adoc ${{ env.DOCU_SRC_DIR }}/pj-readme.adoc - name: assembly config.adoc - run: asciidoctor-reducer --preserve-conditionals -o config.adoc ${{ env.DOCU_SRC_DIR }}/pj-config.adoc + run: asciidoctor-reducer --preserve-conditionals -o docu-config.adoc ${{ env.DOCU_SRC_DIR }}/pj-config.adoc - name: assembly analysis.adoc - run: asciidoctor-reducer --preserve-conditionals -o analysis.adoc ${{ env.DOCU_SRC_DIR }}/pj-analysis.adoc + run: asciidoctor-reducer --preserve-conditionals -o docu-analysis.adoc ${{ env.DOCU_SRC_DIR }}/pj-analysis.adoc - name: assembly commmands.adoc - run: asciidoctor-reducer --preserve-conditionals -o commands.adoc ${{ env.DOCU_SRC_DIR }}/pj-commands.adoc + run: asciidoctor-reducer --preserve-conditionals -o docu-commands.adoc ${{ env.DOCU_SRC_DIR }}/pj-commands.adoc - name: assembly examples.adoc - run: asciidoctor-reducer --preserve-conditionals -o examples.adoc ${{ env.DOCU_SRC_DIR }}/pj-examples.adoc + run: asciidoctor-reducer --preserve-conditionals -o docu-examples.adoc ${{ env.DOCU_SRC_DIR }}/pj-examples.adoc - name: assembly usage.adoc - run: asciidoctor-reducer --preserve-conditionals -o usage.adoc ${{ env.DOCU_SRC_DIR }}/pj-usage.adoc + run: asciidoctor-reducer --preserve-conditionals -o docu-usage.adoc ${{ env.DOCU_SRC_DIR }}/pj-usage.adoc - name: commit and push documents uses: EndBug/add-and-commit@v9.1.4 with: add: | - README.adoc - - config.adoc - - analysis.adoc - - commands.adoc - - examples.adoc - - usage.adoc + - docu-config.adoc + - docu-analysis.adoc + - docu-commands.adoc + - docu-examples.adoc + - docu-usage.adoc diff --git a/LICENSE b/LICENSE index 3b8039d..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -156,7 +156,7 @@ negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a - result of this License or output of the use or inability to use the + result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor diff --git a/analysis.adoc b/analysis.adoc deleted file mode 100644 index 073c0f5..0000000 --- a/analysis.adoc +++ /dev/null @@ -1,438 +0,0 @@ -:hide-uri-scheme: -:doctype: book - -:site_resource: . -// project settings - START -// user data -:acc_vcs_url: https://github.com -:acc_user: ollily -:acc_user_orga: The-oGlow -:acc_user_name: Oliver Glowa -:acc_user_email: coding at glowa-net dot com -:acc_user_hp: http://coding.glowa-net.com -:acc_user_url: {acc_vcs_url}/{acc_user}[{acc_user_name}] - -// organization -:orga_vcs_url: {acc_vcs_url} -:orga_user: The-oGlow -:orga_user_name: The oGlow -:orga_user_email: {acc_user_email} -:orga_user_hp: {acc_user_hp} -:orga_user_url: {orga_vcs_url}/{orga_user}[{orga_user_name}] - -// organization team -:orga_team_user: oteam -:orga_team_user_name: The oTeam -:orga_team_email: {orga_user_email} -:orga_team_hp: {orga_user_hp} -:orga_team_url: {orga_vcs_url}/orgs/{orga_user}/teams/{orga_team_user}[{orga_team_user_name}] - -// module data -// Description of this project -// Name of the author or Github user name (acc_user_name or orga_user_name) -:pj_author: {acc_user_name} -// Version or "latest version" -:pj_version: [latest version] -// Creation year -:pj_year: 2025 -// Github description -:pj_description: Simplify the usage of - Testing with PHPUnit - Reflection with PHP - Developer shortkeys for composer - -// Id of this project -// Prefix of the Github URL (acc_vcs_url or orga_vcs_url) -:pj_gh_vcs_url: {orga_vcs_url} -// Github User or Organisation (acc_user or orga_user) -:pj_gh_account: {orga_user} -// Github repo name -:pj_gh_repo: ezkoding -// Github projectid or -1 -:pj_gh_vcsid: {pj_gh_account}/{pj_gh_repo} - -// Tools for this project -// Soonar projectid or -1 -:pj_snr_projid: {pj_gh_account}_{pj_gh_repo} -// Codacy Token or -1 -:pj_cdcy_id: c029d57bf66e4574b403c91604a08669 -// Coveralls projectid or -1 -:pj_cvrlls_id: {pj_gh_account}/{pj_gh_repo} -// OpenSSF projectid or -1 -:pj_opnssf_id: -1 -// Coverty projectid or -1 -:pj_cvrty_id: -1 -// project settings - END -// common settings - START -:site_resource: . - -// common settings - START -:brnch1: master -:brnch2: develop - -// project settings (generated) -// module data generated -:pj_cright_author: (c) {pj_year} by {acc_user_url} -:pj_cright_orga: (c) {pj_year} by {orga_user_url} - -// Shields - START -:cm_shlds_url: https://img.shields.io -:cm_shlds_badge_url: {cm_shlds_url}/badge -:cm_shlds_img_style: &style=plastic -:cm_shlds_notsupp_url: {cm_shlds_badge_url}/info-not%20supported-lightgrey?{cm_shlds_img_style} -:cm_shlds_notneed_url: {cm_shlds_badge_url}/info-not%20needed-lightgrey?{cm_shlds_img_style} - -:cm_shlds_tool_style: -orange?{cm_shlds_img_style} -:cm_shlds_tool_phpcsfixer_url: {cm_shlds_badge_url}/php_cs_fixer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpunit_url: {cm_shlds_badge_url}/phpunit-UNIT_Tests{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpstan_url: {cm_shlds_badge_url}/phpstan-Level_8_Strict{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_psalm_url: {cm_shlds_badge_url}/psalm-Level_2{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpmd_url: {cm_shlds_badge_url}/php_mess_detector-codesize_&_cleancode_&_controversial_&_design_&_naming_&_unusedcode{cm_shlds_tool_style}&logo=php - -:cm_shlds_tool_phpunit_img: image:{cm_shlds_tool_phpunit_url}[title="PHPUnit Tests"] -// Shields - END -// github - START -ifeval::["{pj_gh_vcsid}" != "-1"] -:cm_gh_wrkflw_link: actions/workflows - -// shields for github -:cm_shlds_gh_url: {cm_shlds_url}/github -:cm_shlds_gh_logo: logo=github -:cm_shlds_gh_style: &{cm_shlds_gh_logo}{cm_shlds_img_style} -:cm_shlds_gh_status_url: {cm_shlds_gh_url}/actions/workflow/status -:cm_shlds_gh_issues_url: {cm_shlds_gh_url}/issues -// :cm_shlds_gh_pulls_url: {cm_shlds_gh_url}/pulls -:cm_shlds_gh_license_url: {cm_shlds_gh_url}/license -:cm_shlds_gh_release_url: {cm_shlds_gh_url}/v/release -:cm_shlds_gh_langtop_url: {cm_shlds_gh_url}/languages/count -:cm_shlds_gh_langcount_url: {cm_shlds_gh_url}/languages/top -:cm_shlds_gh_checkruns_url: {cm_shlds_gh_url}/check-runs - -// project settings (generated) -// module data generated -:pj_gh_vcsid_url: {pj_gh_vcs_url}/{pj_gh_vcsid} -:pj_gh_wflow_url: {pj_gh_vcsid_url}/{cm_gh_wrkflw_link} - -// project status -// ps github -:pj_ps_release_url: {cm_shlds_gh_release_url}/{pj_gh_vcsid}?{cm_shlds_gh_style}&sort=semver -:pj_ps_license_url: {cm_shlds_gh_license_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langtop_url: {cm_shlds_gh_langtop_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langcount_url: {cm_shlds_gh_langcount_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_issues_url: {cm_shlds_gh_issues_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_release_img: image:{pj_ps_license_url}[title="License"] -:pj_ps_license_img: image:{pj_ps_release_url}[title="Latest Release"] -:pj_ps_langtop_img: image:{pj_ps_langtop_url}[title="Main Language"] -:pj_ps_langcount_img: image:{pj_ps_langcount_url}[title="No of Languages"] -:pj_ps_issues_img: image:{pj_ps_issues_url}[title="Open Issues"] - -// build status -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch1}&label={brnch1} -:pj_bs_brnch2_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch2}&label={brnch2} -:pj_bs_brnch1_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch1}?{cm_shlds_snr_style} -:pj_bs_brnch2_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_gh_vcsid}" == "-1"] -// module data generated -:pj_gh_vcsid_url: -:pj_gh_wflow_url: -// ps github -:pj_ps_release_url: -:pj_ps_license_url: -:pj_ps_langtop_url: -:pj_ps_langcount_url: -:pj_ps_issues_url: -:pj_ps_release_img: -:pj_ps_license_img: -:pj_ps_langtop_img: -:pj_ps_langcount_img: -:pj_ps_issues_img: -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch1_checkruns_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_checkruns_url: {cm_shlds_notsupp_url} -endif::[] -// github - END -// sonar - START -ifeval::["{pj_snr_projid}" != "-1"] -:cm_snr_url: https://sonarcloud.io -:cm_snr_badge_url: {cm_snr_url}/images/project_badges -:cm_snr_dash_url: {cm_snr_url}/dashboard?id= -:cm_snr_api_url: {cm_snr_url}/api -:cm_snr_qgate_url: {cm_snr_api_url}/project_badges/quality_gate?project= -:cm_snr_brnch_url: {cm_snr_url}/summary/new_code?id= -:cm_snr_mes_tsd: component_measures?metric=test_success_density&view=list -:cm_snr_mes_test: component_measures?metric=tests&view=list -:cm_snr_mes_cov: component_measures?metric=coverage&view=list -:cm_snr_logo_url: {cm_snr_badge_url}/sonarcloud-black.svg -:cm_snr_logo_url2: {cm_snr_badge_url}/sonarcloud-light.svg -:cm_snr_tool_sonarcloud_url: {cm_snr_logo_url2} - -// shields for sonar -:cm_shlds_snr_url: {cm_shlds_url}/sonar -:cm_shlds_snr_logo: logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io -:cm_shlds_snr_style: &{cm_shlds_snr_logo}{cm_shlds_img_style} -:cm_shlds_snr_qgate_url: {cm_shlds_snr_url}/quality_gate -:cm_shlds_snr_tsd_url: {cm_shlds_snr_url}/test_success_density -:cm_shlds_snr_tests_url: {cm_shlds_snr_url}/tests -:cm_shlds_snr_coverage_url: {cm_shlds_snr_url}/coverage -:cm_shlds_snr_violations_url: {cm_shlds_snr_url}/violations -:cm_shlds_tool_sonarcloud_url: {cm_shlds_badge_url}/sonarcloud-oGlow_way{cm_shlds_tool_style}&logo=sonar -:cm_shlds_tool_sonarcloud_img: image:{cm_shlds_tool_sonarcloud_url}[title="Sonarcloud Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_snr_component: {pj_gh_account}:{pj_gh_repo} -:pj_snr_dash_url: {cm_snr_dash_url}{pj_snr_projid} -:pj_snr_brnch_main_url: {cm_snr_brnch_url}{pj_snr_projid} -:pj_snr_brnch1_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch1} -:pj_snr_brnch2_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch2} - -// quality information -// qi shields -:pj_qi_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tsd_url: {cm_shlds_snr_tsd_url_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}?{cm_shlds_snr_style} - -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_qi_snr_qgate_url: {cm_snr_qgate_url}{pj_snr_projid} -:pj_qi_snr_logo_url: {cm_snr_logo_url} - -// test information -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_snr_projid}" == "-1"] -// shields for sonar -:cm_shlds_tool_sonarcloud_url: -:cm_shlds_tool_sonarcloud_img: -// module data generated -:pj_snr_dash_url: -:pj_snr_brnch_main_url: -// qi shields -:pj_qi_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_tsd_url: {cm_shlds_notsupp_url} -:pj_qi_tests_url: {cm_shlds_notsupp_url} -:pj_qi_coverage_url: {cm_shlds_notsupp_url} -:pj_qi_violations_url: {cm_shlds_notsupp_url} -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_logo_url: {cm_shlds_notsupp_url} -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_notsupp_url} -endif::[] -// sonar - END -// codacy - START -ifeval::["{pj_cdcy_id}" != "-1"] -:cm_cdcy_url: https://www.codacy.com -:cm_cdcy_app: https://app.codacy.com -:cm_cdcy_badge_grade_url: {cm_cdcy_app}/project/badge/Grade -:cm_cdcy_badge_coverage_url: {cm_cdcy_app}/project/badge/Coverage -:cm_cdcy_dash_gh_url: {cm_cdcy_app}/gh - -// shields for codacy -:cm_shlds_cdcy_url: {cm_shlds_url}/codacy -:cm_shlds_cdcy_logo: logo=codacy -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_cdcy_grade_url: {cm_shlds_cdcy_url}/grade -:cm_shlds_cdcy_coverage_url: {cm_shlds_cdcy_url}/coverage -:cm_shlds_tool_cdcy_url: {cm_shlds_badge_url}/codacy-oGlow_Rulset{cm_shlds_tool_style}&logo=codacy -:cm_shlds_tool_cdcy_img: image:{cm_shlds_tool_cdcy_url}[title="Codacy Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_cdcy_vcsid: {pj_gh_vcsid} - -// quality information -// qi codacy -:pj_cdcy_vcsid_url: {cm_cdcy_dash_gh_url}/{pj_cdcy_vcsid}/dashboard -:pj_cdcy_branch1_url: {pj_cdcy_vcsid_url}?branch={brnch1} -:pj_cdcy_branch2_url: {pj_cdcy_vcsid_url}?branch={brnch2} -:pj_qi_cdcy_badge_grade_url: {cm_cdcy_badge_grade_url}/{pj_cdcy_id} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_badge_coverage_url: {cm_cdcy_badge_coverage_url}/{pj_cdcy_id} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -endif::[] -ifeval::["{pj_cdcy_id}" == "-1"] -// shields for codacy -:cm_shlds_tool_cdcy_url: -:cm_shlds_tool_cdcy_img: -// qi codacy -:pj_cdcy_vcsid_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch1_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch2_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_badge_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_badge_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_notsupp_url} -endif::[] -// codacy - END -//coveralls - START -ifeval::["{pj_cvrlls_id}" != "-1"] -:cm_cvrlls_url: https://coveralls.io -:cm_cvrlls_dash_gh_url: {cm_cvrlls_url}/github -:cm_cvrlls_repos_gh_url: {cm_cvrlls_url}/repos/github - -// shields for coveralls -:cm_shlds_cvrlls_url: {cm_shlds_url}/coveralls/github -:cm_shlds_cvrlls_logo: logo=coveralls -:cm_shlds_cvrlls_style: &{cm_shlds_cvrlls_logo}{cm_shlds_img_style} -:cm_shlds_tool_cvrlls_url: {cm_shlds_badge_url}/coveralls-Coverage{cm_shlds_tool_style}&logo=coveralls -:cm_shlds_tool_cvrlls_img: image:{cm_shlds_tool_cvrlls_url}[title="Coveralls Coverage"] -// project settings (generated) -// module data generated -:pj_cvrlls_vcsid: {pj_cvrlls_id} - -// test information -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid} -:pj_cvrlls_brnch1_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch1} -:pj_cvrlls_brnch2_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch2} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch1} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch2} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch1}?{cm_shlds_cvrlls_style} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch2}?{cm_shlds_cvrlls_style} -endif::[] -ifeval::["{pj_cvrlls_id}" == "-1"] -// shields for coveralls -:cm_shlds_tool_cvrlls_url: -:cm_shlds_tool_cvrlls_img: -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch1_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch2_dash_gh_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_notsupp_url} -endif::[] -//coveralls - END -// phpcodesniffer - START -:cm_phpcs_url: https://github.com/PHPCSStandards/PHP_CodeSniffer - -// shields for phpcodesniffer -:cm_shlds_phpcs_url: {cm_shlds_url}/phpcodesniffer -:cm_shlds_cdcy_logo: logo=php -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_tool_phpcs_url: {cm_shlds_badge_url}/php_codesniffer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -// phpcodesniffer - END -// openssf - START -ifeval::["{pj_opnssf_id}" != "-1"] -:cm_opnssf_url: https://www.bestpractices.dev -:cm_opnssf_badge_url: {cm_opnssf_url}/projects -:cm_opnssf_dash_url: {cm_opnssf_url}/projects - -// project settings (generated) -// module data generated -:pj_opnssf_vcsid: {pj_opnssf_id} - -// quality information -// qi openssf -:pj_opnssf_dash_url: {cm_opnssf_dash_url}/{pj_opnssf_vcsid} -:pj_qi_opnssf_status_url: {cm_opnssf_badge_url}/{pj_opnssf_vcsid}/badge -endif::[] -ifeval::["{pj_opnssf_id}" == "-1"] -:pj_opnssf_dash_url: {cm_shlds_notsupp_url} -:pj_qi_opnssf_status_url: {cm_shlds_notsupp_url} -endif::[] -// openssf - END -// common settings - END - -:source-highlighter: highlight.js - -= {pj_gh_repo} - Analysis -:toc: -:toclevels: 2 - -== Quality Analysis - -=== Project Status -.Project Status -[%header,frame=ends,valign=top,halign=center,width=200px] -|=== -^| ^|Branch '{brnch1}' ^|Branch '{brnch2}' -3+|link:{pj_gh_vcsid_url}[Github] -|Checks -^|image:{pj_bs_brnch1_checkruns_url}[] -^|image:{pj_bs_brnch2_checkruns_url}[] -|Status -^|image:{pj_bs_brnch1_status_url}[] -^|image:{pj_bs_brnch2_status_url}[] -|=== - -=== Quality Information -.Quality Information -[%header,frame=ends,valign=top,halign=center] -|=== -^| ^|Branch '{brnch1}' ^|Branch '{brnch2}' -3+|link:{pj_snr_dash_url}[Sonarcloud] -|Quality Gate -2+^|image:{pj_qi_snr_qgate_url}[] -|Details -^|image:{pj_qi_snr_brnch1_qgate_url}[] -^|image:{pj_qi_snr_brnch2_qgate_url}[] -3+|link:{pj_cdcy_vcsid_url}[Codacy] -|Code Quality -2+^|image:{pj_qi_cdcy_badge_grade_url}[] -3+|link:{pj_opnssf_dash_url}[Open SSF] -|Status -2+^|image:{pj_qi_opnssf_status_url}[] -|=== - -=== Test Information -.Test Information -[%header,frame=ends,valign=top,halign=center] -|=== -^| ^|Branch '{brnch1}' ^|Branch '{brnch2}' -3+|link:{pj_snr_dash_url}[Sonarcloud] -|Tests % -^|image:{pj_ti_snr_brnch1_tsd_url}[] -^|image:{pj_ti_snr_brnch2_tsd_url}[] -|Tests Count -^|image:{pj_ti_snr_brnch1_tests_url}[] -^|image:{pj_ti_snr_brnch2_tests_url}[] -|Coverage -^|image:{pj_ti_snr_brnch1_coverage_url}[] -^|image:{pj_ti_snr_brnch2_coverage_url}[] -|Violations -^|image:{pj_ti_snr_brnch1_violations_url}[] -^|image:{pj_ti_snr_brnch2_violations_url}[] -3+|link:{pj_cdcy_vcsid_url}[Codacy] -|Coverage -2+^|image:{pj_ti_cdcy_badge_coverage_url}[] -|Details -^|image:{pj_ti_cdcy_brnch1_coverage_url}[] -^|image:{pj_ti_cdcy_brnch2_coverage_url}[] -3+|link:{pj_cvrlls_dash_gh_url}[Coveralls] -|Coverage -^|image:{pj_ti_cvrlls_brnch1_coverage_url}[] -^|image:{pj_ti_cvrlls_brnch2_coverage_url}[] -|Details -^|image:{pj_ti_cvrlls_brnch1_status_url}[] -^|image:{pj_ti_cvrlls_brnch2_status_url}[] -|=== - -_{pj_cright_author}_ diff --git a/commands.adoc b/commands.adoc deleted file mode 100644 index 79ee061..0000000 --- a/commands.adoc +++ /dev/null @@ -1,411 +0,0 @@ -:hide-uri-scheme: -:doctype: book - -:site_resource: . -// project settings - START -// user data -:acc_vcs_url: https://github.com -:acc_user: ollily -:acc_user_orga: The-oGlow -:acc_user_name: Oliver Glowa -:acc_user_email: coding at glowa-net dot com -:acc_user_hp: http://coding.glowa-net.com -:acc_user_url: {acc_vcs_url}/{acc_user}[{acc_user_name}] - -// organization -:orga_vcs_url: {acc_vcs_url} -:orga_user: The-oGlow -:orga_user_name: The oGlow -:orga_user_email: {acc_user_email} -:orga_user_hp: {acc_user_hp} -:orga_user_url: {orga_vcs_url}/{orga_user}[{orga_user_name}] - -// organization team -:orga_team_user: oteam -:orga_team_user_name: The oTeam -:orga_team_email: {orga_user_email} -:orga_team_hp: {orga_user_hp} -:orga_team_url: {orga_vcs_url}/orgs/{orga_user}/teams/{orga_team_user}[{orga_team_user_name}] - -// module data -// Description of this project -// Name of the author or Github user name (acc_user_name or orga_user_name) -:pj_author: {acc_user_name} -// Version or "latest version" -:pj_version: [latest version] -// Creation year -:pj_year: 2025 -// Github description -:pj_description: Simplify the usage of - Testing with PHPUnit - Reflection with PHP - Developer shortkeys for composer - -// Id of this project -// Prefix of the Github URL (acc_vcs_url or orga_vcs_url) -:pj_gh_vcs_url: {orga_vcs_url} -// Github User or Organisation (acc_user or orga_user) -:pj_gh_account: {orga_user} -// Github repo name -:pj_gh_repo: ezkoding -// Github projectid or -1 -:pj_gh_vcsid: {pj_gh_account}/{pj_gh_repo} - -// Tools for this project -// Soonar projectid or -1 -:pj_snr_projid: {pj_gh_account}_{pj_gh_repo} -// Codacy Token or -1 -:pj_cdcy_id: c029d57bf66e4574b403c91604a08669 -// Coveralls projectid or -1 -:pj_cvrlls_id: {pj_gh_account}/{pj_gh_repo} -// OpenSSF projectid or -1 -:pj_opnssf_id: -1 -// Coverty projectid or -1 -:pj_cvrty_id: -1 -// project settings - END -// common settings - START -:site_resource: . - -// common settings - START -:brnch1: master -:brnch2: develop - -// project settings (generated) -// module data generated -:pj_cright_author: (c) {pj_year} by {acc_user_url} -:pj_cright_orga: (c) {pj_year} by {orga_user_url} - -// Shields - START -:cm_shlds_url: https://img.shields.io -:cm_shlds_badge_url: {cm_shlds_url}/badge -:cm_shlds_img_style: &style=plastic -:cm_shlds_notsupp_url: {cm_shlds_badge_url}/info-not%20supported-lightgrey?{cm_shlds_img_style} -:cm_shlds_notneed_url: {cm_shlds_badge_url}/info-not%20needed-lightgrey?{cm_shlds_img_style} - -:cm_shlds_tool_style: -orange?{cm_shlds_img_style} -:cm_shlds_tool_phpcsfixer_url: {cm_shlds_badge_url}/php_cs_fixer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpunit_url: {cm_shlds_badge_url}/phpunit-UNIT_Tests{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpstan_url: {cm_shlds_badge_url}/phpstan-Level_8_Strict{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_psalm_url: {cm_shlds_badge_url}/psalm-Level_2{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpmd_url: {cm_shlds_badge_url}/php_mess_detector-codesize_&_cleancode_&_controversial_&_design_&_naming_&_unusedcode{cm_shlds_tool_style}&logo=php - -:cm_shlds_tool_phpunit_img: image:{cm_shlds_tool_phpunit_url}[title="PHPUnit Tests"] -// Shields - END -// github - START -ifeval::["{pj_gh_vcsid}" != "-1"] -:cm_gh_wrkflw_link: actions/workflows - -// shields for github -:cm_shlds_gh_url: {cm_shlds_url}/github -:cm_shlds_gh_logo: logo=github -:cm_shlds_gh_style: &{cm_shlds_gh_logo}{cm_shlds_img_style} -:cm_shlds_gh_status_url: {cm_shlds_gh_url}/actions/workflow/status -:cm_shlds_gh_issues_url: {cm_shlds_gh_url}/issues -// :cm_shlds_gh_pulls_url: {cm_shlds_gh_url}/pulls -:cm_shlds_gh_license_url: {cm_shlds_gh_url}/license -:cm_shlds_gh_release_url: {cm_shlds_gh_url}/v/release -:cm_shlds_gh_langtop_url: {cm_shlds_gh_url}/languages/count -:cm_shlds_gh_langcount_url: {cm_shlds_gh_url}/languages/top -:cm_shlds_gh_checkruns_url: {cm_shlds_gh_url}/check-runs - -// project settings (generated) -// module data generated -:pj_gh_vcsid_url: {pj_gh_vcs_url}/{pj_gh_vcsid} -:pj_gh_wflow_url: {pj_gh_vcsid_url}/{cm_gh_wrkflw_link} - -// project status -// ps github -:pj_ps_release_url: {cm_shlds_gh_release_url}/{pj_gh_vcsid}?{cm_shlds_gh_style}&sort=semver -:pj_ps_license_url: {cm_shlds_gh_license_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langtop_url: {cm_shlds_gh_langtop_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langcount_url: {cm_shlds_gh_langcount_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_issues_url: {cm_shlds_gh_issues_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_release_img: image:{pj_ps_license_url}[title="License"] -:pj_ps_license_img: image:{pj_ps_release_url}[title="Latest Release"] -:pj_ps_langtop_img: image:{pj_ps_langtop_url}[title="Main Language"] -:pj_ps_langcount_img: image:{pj_ps_langcount_url}[title="No of Languages"] -:pj_ps_issues_img: image:{pj_ps_issues_url}[title="Open Issues"] - -// build status -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch1}&label={brnch1} -:pj_bs_brnch2_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch2}&label={brnch2} -:pj_bs_brnch1_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch1}?{cm_shlds_snr_style} -:pj_bs_brnch2_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_gh_vcsid}" == "-1"] -// module data generated -:pj_gh_vcsid_url: -:pj_gh_wflow_url: -// ps github -:pj_ps_release_url: -:pj_ps_license_url: -:pj_ps_langtop_url: -:pj_ps_langcount_url: -:pj_ps_issues_url: -:pj_ps_release_img: -:pj_ps_license_img: -:pj_ps_langtop_img: -:pj_ps_langcount_img: -:pj_ps_issues_img: -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch1_checkruns_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_checkruns_url: {cm_shlds_notsupp_url} -endif::[] -// github - END -// sonar - START -ifeval::["{pj_snr_projid}" != "-1"] -:cm_snr_url: https://sonarcloud.io -:cm_snr_badge_url: {cm_snr_url}/images/project_badges -:cm_snr_dash_url: {cm_snr_url}/dashboard?id= -:cm_snr_api_url: {cm_snr_url}/api -:cm_snr_qgate_url: {cm_snr_api_url}/project_badges/quality_gate?project= -:cm_snr_brnch_url: {cm_snr_url}/summary/new_code?id= -:cm_snr_mes_tsd: component_measures?metric=test_success_density&view=list -:cm_snr_mes_test: component_measures?metric=tests&view=list -:cm_snr_mes_cov: component_measures?metric=coverage&view=list -:cm_snr_logo_url: {cm_snr_badge_url}/sonarcloud-black.svg -:cm_snr_logo_url2: {cm_snr_badge_url}/sonarcloud-light.svg -:cm_snr_tool_sonarcloud_url: {cm_snr_logo_url2} - -// shields for sonar -:cm_shlds_snr_url: {cm_shlds_url}/sonar -:cm_shlds_snr_logo: logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io -:cm_shlds_snr_style: &{cm_shlds_snr_logo}{cm_shlds_img_style} -:cm_shlds_snr_qgate_url: {cm_shlds_snr_url}/quality_gate -:cm_shlds_snr_tsd_url: {cm_shlds_snr_url}/test_success_density -:cm_shlds_snr_tests_url: {cm_shlds_snr_url}/tests -:cm_shlds_snr_coverage_url: {cm_shlds_snr_url}/coverage -:cm_shlds_snr_violations_url: {cm_shlds_snr_url}/violations -:cm_shlds_tool_sonarcloud_url: {cm_shlds_badge_url}/sonarcloud-oGlow_way{cm_shlds_tool_style}&logo=sonar -:cm_shlds_tool_sonarcloud_img: image:{cm_shlds_tool_sonarcloud_url}[title="Sonarcloud Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_snr_component: {pj_gh_account}:{pj_gh_repo} -:pj_snr_dash_url: {cm_snr_dash_url}{pj_snr_projid} -:pj_snr_brnch_main_url: {cm_snr_brnch_url}{pj_snr_projid} -:pj_snr_brnch1_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch1} -:pj_snr_brnch2_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch2} - -// quality information -// qi shields -:pj_qi_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tsd_url: {cm_shlds_snr_tsd_url_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}?{cm_shlds_snr_style} - -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_qi_snr_qgate_url: {cm_snr_qgate_url}{pj_snr_projid} -:pj_qi_snr_logo_url: {cm_snr_logo_url} - -// test information -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_snr_projid}" == "-1"] -// shields for sonar -:cm_shlds_tool_sonarcloud_url: -:cm_shlds_tool_sonarcloud_img: -// module data generated -:pj_snr_dash_url: -:pj_snr_brnch_main_url: -// qi shields -:pj_qi_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_tsd_url: {cm_shlds_notsupp_url} -:pj_qi_tests_url: {cm_shlds_notsupp_url} -:pj_qi_coverage_url: {cm_shlds_notsupp_url} -:pj_qi_violations_url: {cm_shlds_notsupp_url} -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_logo_url: {cm_shlds_notsupp_url} -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_notsupp_url} -endif::[] -// sonar - END -// codacy - START -ifeval::["{pj_cdcy_id}" != "-1"] -:cm_cdcy_url: https://www.codacy.com -:cm_cdcy_app: https://app.codacy.com -:cm_cdcy_badge_grade_url: {cm_cdcy_app}/project/badge/Grade -:cm_cdcy_badge_coverage_url: {cm_cdcy_app}/project/badge/Coverage -:cm_cdcy_dash_gh_url: {cm_cdcy_app}/gh - -// shields for codacy -:cm_shlds_cdcy_url: {cm_shlds_url}/codacy -:cm_shlds_cdcy_logo: logo=codacy -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_cdcy_grade_url: {cm_shlds_cdcy_url}/grade -:cm_shlds_cdcy_coverage_url: {cm_shlds_cdcy_url}/coverage -:cm_shlds_tool_cdcy_url: {cm_shlds_badge_url}/codacy-oGlow_Rulset{cm_shlds_tool_style}&logo=codacy -:cm_shlds_tool_cdcy_img: image:{cm_shlds_tool_cdcy_url}[title="Codacy Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_cdcy_vcsid: {pj_gh_vcsid} - -// quality information -// qi codacy -:pj_cdcy_vcsid_url: {cm_cdcy_dash_gh_url}/{pj_cdcy_vcsid}/dashboard -:pj_cdcy_branch1_url: {pj_cdcy_vcsid_url}?branch={brnch1} -:pj_cdcy_branch2_url: {pj_cdcy_vcsid_url}?branch={brnch2} -:pj_qi_cdcy_badge_grade_url: {cm_cdcy_badge_grade_url}/{pj_cdcy_id} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_badge_coverage_url: {cm_cdcy_badge_coverage_url}/{pj_cdcy_id} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -endif::[] -ifeval::["{pj_cdcy_id}" == "-1"] -// shields for codacy -:cm_shlds_tool_cdcy_url: -:cm_shlds_tool_cdcy_img: -// qi codacy -:pj_cdcy_vcsid_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch1_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch2_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_badge_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_badge_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_notsupp_url} -endif::[] -// codacy - END -//coveralls - START -ifeval::["{pj_cvrlls_id}" != "-1"] -:cm_cvrlls_url: https://coveralls.io -:cm_cvrlls_dash_gh_url: {cm_cvrlls_url}/github -:cm_cvrlls_repos_gh_url: {cm_cvrlls_url}/repos/github - -// shields for coveralls -:cm_shlds_cvrlls_url: {cm_shlds_url}/coveralls/github -:cm_shlds_cvrlls_logo: logo=coveralls -:cm_shlds_cvrlls_style: &{cm_shlds_cvrlls_logo}{cm_shlds_img_style} -:cm_shlds_tool_cvrlls_url: {cm_shlds_badge_url}/coveralls-Coverage{cm_shlds_tool_style}&logo=coveralls -:cm_shlds_tool_cvrlls_img: image:{cm_shlds_tool_cvrlls_url}[title="Coveralls Coverage"] -// project settings (generated) -// module data generated -:pj_cvrlls_vcsid: {pj_cvrlls_id} - -// test information -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid} -:pj_cvrlls_brnch1_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch1} -:pj_cvrlls_brnch2_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch2} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch1} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch2} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch1}?{cm_shlds_cvrlls_style} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch2}?{cm_shlds_cvrlls_style} -endif::[] -ifeval::["{pj_cvrlls_id}" == "-1"] -// shields for coveralls -:cm_shlds_tool_cvrlls_url: -:cm_shlds_tool_cvrlls_img: -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch1_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch2_dash_gh_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_notsupp_url} -endif::[] -//coveralls - END -// phpcodesniffer - START -:cm_phpcs_url: https://github.com/PHPCSStandards/PHP_CodeSniffer - -// shields for phpcodesniffer -:cm_shlds_phpcs_url: {cm_shlds_url}/phpcodesniffer -:cm_shlds_cdcy_logo: logo=php -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_tool_phpcs_url: {cm_shlds_badge_url}/php_codesniffer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -// phpcodesniffer - END -// openssf - START -ifeval::["{pj_opnssf_id}" != "-1"] -:cm_opnssf_url: https://www.bestpractices.dev -:cm_opnssf_badge_url: {cm_opnssf_url}/projects -:cm_opnssf_dash_url: {cm_opnssf_url}/projects - -// project settings (generated) -// module data generated -:pj_opnssf_vcsid: {pj_opnssf_id} - -// quality information -// qi openssf -:pj_opnssf_dash_url: {cm_opnssf_dash_url}/{pj_opnssf_vcsid} -:pj_qi_opnssf_status_url: {cm_opnssf_badge_url}/{pj_opnssf_vcsid}/badge -endif::[] -ifeval::["{pj_opnssf_id}" == "-1"] -:pj_opnssf_dash_url: {cm_shlds_notsupp_url} -:pj_qi_opnssf_status_url: {cm_shlds_notsupp_url} -endif::[] -// openssf - END -// common settings - END - -:source-highlighter: highlight.js - -= {pj_gh_repo} - Composer -:toc: -:toclevels: 2 - -== Additional Commands - -There are severall shortkeys, which are useful for your development. - -.Additional Composer Commands -[%header%autowidth,frame=ends,valign=top,halign=center] -|=== -^|*Command* ^|*Description* -| c-all | CUSTOM: Run composer with c-check, c-test, c-format -| c-check | CUSTOM: Run composer with c-phpstan, c-psalm, c-phpmd -| c-da | CUSTOM: shortkey for 'dump-autoload' -| c-dry-fix | CUSTOM: See what PHP CS Fixer will fix (dry run) -| c-dry-psalter | CUSTOM: See what Psalter will fix (dry run) -| c-fix | CUSTOM: PHP CS Fixer fixes your code -| c-format | CUSTOM: Format the code with c-fix, c-phpcbf -| c-package | CUSTOM: Create deployable package -| c-phpcbf | CUSTOM: PHP Code Sniffer fixes your code -| c-phpcs | CUSTOM: PHP Code Sniffer verifies your code -| c-phpdoc | CUSTOM: phpDocumentor generates the API documentation -| c-phpmd | CUSTOM: PHP Mess Detector verifies your code -| c-phpstan | CUSTOM: PHPStan verifies your code -| c-psalm | CUSTOM: Psalm verifies your code -| c-psalter | CUSTOM: Psalter fixes your code -| c-sonar | CUSTOM: Sonarcloud verifies your code -| c-test | CUSTOM: PHPUnit executes all unit tests -|=== - -Call: - - $ composer list - -See section `scripts` & `scripts-description` in link:composer.json[composer.json]. + -Copy them to your `composer.json`, if you like them! - -== Reference -* link:https://getcomposer.org/[Composer] -* link:https://cs.symfony.com/[PHP CS Fixer] -* link:https://phpstan.org/[PHPStan] -* link:https://phpunit.de/[PHPUnit] -* link:https://psalm.dev/[Psalm] - -_{pj_cright_author}_ diff --git a/composer.json b/composer.json index ea1d46f..590c824 100644 --- a/composer.json +++ b/composer.json @@ -17,12 +17,6 @@ "email": "426229+ollily@users.noreply.github.com", "homepage": "https://github.com/ollily", "role": "Project Owner, Developer" - }, - { - "name": "oglowa", - "email": "36665428+oglowa@users.noreply.github.com", - "homepage": "https://github.com/The-oGlow", - "role": "Developer" } ], "support": { @@ -30,15 +24,19 @@ }, "minimum-stability": "stable", "prefer-stable": true, + "repositories": [ + { + "type":"path", + "url":"../../github-ollily/php-sonar-scanner" + } + ], "require": { "php": ">=8.4.1", "php-ds/php-ds": "^1.0", - "psr/log": "^1.0||^2.0||^3.0", + "psr/log": "^2.0||^3.0", "composer/composer": "^2.0" }, "provide": { - "psr/log-implementation": "^1.0||^2.0||^3.0", - "monolog/monolog": "^2.10" }, "suggest": { }, @@ -50,13 +48,9 @@ "psalm/plugin-phpunit": "^0.19", "friendsofphp/php-cs-fixer": "^3.0", "squizlabs/php_codesniffer": "^4.0", - "phpmd/phpmd": "^2.0", - "rogervila/php-sonarqube-scanner": "^1.0" + "phpmd/phpmd": "^2.0" }, "config": { - "platform": { - "php": "8.4.3" - }, "optimize-autoloader": false, "sort-packages": true, "allow-plugins": { @@ -90,8 +84,8 @@ "composer c-phpmd" ], "c-da": "@composer dump-autoload", - "c-dry-fix": "@php -d xdebug.mode=off vendor/bin/php-cs-fixer check --allow-unsupported-php-version=yes --allow-risky=yes --format txt", - "c-fix": "@php -d xdebug.mode=off vendor/bin/php-cs-fixer fix --allow-unsupported-php-version=yes --allow-risky=yes", + "c-dry-fix": "@php vendor/bin/php-cs-fixer check --allow-unsupported-php-version=yes --allow-risky=yes --format txt", + "c-fix": "@php vendor/bin/php-cs-fixer fix --allow-unsupported-php-version=yes --allow-risky=yes", "c-format": [ "composer c-fix", "composer c-phpcbf", @@ -99,33 +93,33 @@ ], "c-package": "@composer archive --format=zip --dir=target/staging", "c-phpcs": [ - "bash -c 'echo PHP Code Sniffer checking ...'", + "echo PHP Code Sniffer checking ...", "bash -c 'mkdir --p target/analysis/phpcs'", "bash -c 'rm -f target/analysis/phpcs/phpcsniffer-report.txt'", - "@php -d xdebug.mode=off vendor/bin/phpcs --colors || true", + "@php vendor/bin/phpcs --colors || true", "bash -c 'if [ -s target/analysis/phpcs/phpcsniffer-report.txt ]; then cat target/analysis/phpcs/phpcsniffer-report.txt; exit 0; else exit 0; fi'" ], "c-phpcbf": [ - "bash -c 'echo PHP Code Sniffer FIXING ...'", + "echo PHP Code Sniffer FIXING ...", "bash -c 'mkdir --p target/analysis/phpcs'", "bash -c 'rm -f target/analysis/phpcs/phpcsniffer-report.txt'", - "@php -d xdebug.mode=off vendor/bin/phpcbf || true", + "@php vendor/bin/phpcbf || true", "bash -c 'if [ -s target/analysis/phpcs/phpcsniffer-report.txt ]; then cat target/analysis/phpcs/phpcsniffer-report.txt; exit 0; else exit 0; fi'" ], "c-phpdoc": "phpDocumentor run", "c-phpmd": [ - "bash -c 'echo PHP Mess Dectector running ...'", + "echo PHP Mess Dectector running ...", "bash -c 'rm -f target/analysis/phpmd/phpmd-report.txt'", - "@php -d xdebug.mode=off vendor/bin/phpmd src,tests text .phpmd.xml.dist --report-file=target/analysis/phpmd/phpmd-report.txt --error-file=target/analysis/phpmd/zzz-phpmd-error.txt --color --cache --ignore-errors-on-exit --ignore-violations-on-exit", + "@php vendor/bin/phpmd src,tests text .phpmd.xml.dist --report-file=target/analysis/phpmd/phpmd-report.txt --error-file=target/analysis/phpmd/zzz-phpmd-error.txt --color --cache --ignore-errors-on-exit --ignore-violations-on-exit", "bash -c 'if [ -s target/analysis/phpmd/phpmd-report.txt ]; then cat target/analysis/phpmd/phpmd-report.txt; exit 1; else exit 0; fi'" ], - "c-phpstan": "@php -d xdebug.mode=off vendor/bin/phpstan analyse", - "c-psalm": "@php -d xdebug.mode=off vendor/bin/psalm --report=target/analysis/psalm/psalm-report.txt", - "c-dry-psalter": "@php -d xdebug.mode=off vendor/bin/psalter --dry-run --issues=MissingReturnType,MissingClosureReturnType,MissingParamType,MissingPropertyType,PossiblyUndefinedVariable,PossiblyUndefinedGlobalVariable,ParamNameMismatch", - "c-psalter": "@php -d xdebug.mode=off vendor/bin/psalter --issues=MissingReturnType,MissingClosureReturnType,MissingParamType,MissingPropertyType,PossiblyUndefinedVariable,PossiblyUndefinedGlobalVariable,ParamNameMismatch", + "c-phpstan": "@php vendor/bin/phpstan analyse", + "c-psalm": "@php vendor/bin/psalm --report=target/analysis/psalm/psalm-report.txt", + "c-dry-psalter": "@php vendor/bin/psalter --dry-run --issues=MissingReturnType,MissingClosureReturnType,MissingParamType,MissingPropertyType,PossiblyUndefinedVariable,PossiblyUndefinedGlobalVariable,ParamNameMismatch", + "c-psalter": "@php vendor/bin/psalter --issues=MissingReturnType,MissingClosureReturnType,MissingParamType,MissingPropertyType,PossiblyUndefinedVariable,PossiblyUndefinedGlobalVariable,ParamNameMismatch", "c-sonar": [ "composer c-test", - "@php -d xdebug.mode=off -Dproject.settings=sonar-project.properties vendor/bin/sonar-scanner" + "@php -Dproject.settings=sonar-project.properties vendor/bin/sonar-scanner" ], "c-test": "@php -d xdebug.mode=coverage vendor/bin/phpunit -c phpunit.xml.cov" }, diff --git a/composer.lock b/composer.lock index e014844..261f0f8 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "dbb4908e4edbe739a10c13ff05fafb14", + "content-hash": "1293960d729309011f7bfef5dd36efdd", "packages": [ { "name": "composer/ca-bundle", @@ -149,16 +149,16 @@ }, { "name": "composer/composer", - "version": "2.10.0", + "version": "2.10.1", "source": { "type": "git", "url": "https://github.com/composer/composer.git", - "reference": "c13824d95608b15913a7c0def0a3dea4474b71fc" + "reference": "4120703b9bda8795075047b40361d7ec4d2abe49" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/composer/zipball/c13824d95608b15913a7c0def0a3dea4474b71fc", - "reference": "c13824d95608b15913a7c0def0a3dea4474b71fc", + "url": "https://api.github.com/repos/composer/composer/zipball/4120703b9bda8795075047b40361d7ec4d2abe49", + "reference": "4120703b9bda8795075047b40361d7ec4d2abe49", "shasum": "" }, "require": { @@ -246,7 +246,7 @@ "irc": "ircs://irc.libera.chat:6697/composer", "issues": "https://github.com/composer/composer/issues", "security": "https://github.com/composer/composer/security/policy", - "source": "https://github.com/composer/composer/tree/2.10.0" + "source": "https://github.com/composer/composer/tree/2.10.1" }, "funding": [ { @@ -258,7 +258,7 @@ "type": "github" } ], - "time": "2026-05-28T09:22:08+00:00" + "time": "2026-06-04T08:25:59+00:00" }, { "name": "composer/metadata-minifier", @@ -331,28 +331,29 @@ }, { "name": "composer/pcre", - "version": "3.3.2", + "version": "3.4.0", "source": { "type": "git", "url": "https://github.com/composer/pcre.git", - "reference": "b2bed4734f0cc156ee1fe9c0da2550420d99a21e" + "reference": "d5a341b3fb61f3001970940afb1d332968a183ed" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/pcre/zipball/b2bed4734f0cc156ee1fe9c0da2550420d99a21e", - "reference": "b2bed4734f0cc156ee1fe9c0da2550420d99a21e", + "url": "https://api.github.com/repos/composer/pcre/zipball/d5a341b3fb61f3001970940afb1d332968a183ed", + "reference": "d5a341b3fb61f3001970940afb1d332968a183ed", "shasum": "" }, "require": { "php": "^7.4 || ^8.0" }, "conflict": { - "phpstan/phpstan": "<1.11.10" + "phpstan/phpstan": "<2.2.2" }, "require-dev": { - "phpstan/phpstan": "^1.12 || ^2", - "phpstan/phpstan-strict-rules": "^1 || ^2", - "phpunit/phpunit": "^8 || ^9" + "phpstan/phpstan": "^2", + "phpstan/phpstan-deprecation-rules": "^2", + "phpstan/phpstan-strict-rules": "^2", + "phpunit/phpunit": "^9" }, "type": "library", "extra": { @@ -390,7 +391,7 @@ ], "support": { "issues": "https://github.com/composer/pcre/issues", - "source": "https://github.com/composer/pcre/tree/3.3.2" + "source": "https://github.com/composer/pcre/tree/3.4.0" }, "funding": [ { @@ -400,13 +401,9 @@ { "url": "https://github.com/composer", "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/composer/composer", - "type": "tidelift" } ], - "time": "2024-11-12T16:29:46+00:00" + "time": "2026-06-07T11:47:49+00:00" }, { "name": "composer/semver", @@ -629,16 +626,16 @@ }, { "name": "justinrainbow/json-schema", - "version": "6.8.2", + "version": "6.9.0", "source": { "type": "git", "url": "https://github.com/jsonrainbow/json-schema.git", - "reference": "2c89ebb95ca9cedc9347f780333f7b25792dcb76" + "reference": "bd1bda2ebfc8bff418565941771ea8f03c557886" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/jsonrainbow/json-schema/zipball/2c89ebb95ca9cedc9347f780333f7b25792dcb76", - "reference": "2c89ebb95ca9cedc9347f780333f7b25792dcb76", + "url": "https://api.github.com/repos/jsonrainbow/json-schema/zipball/bd1bda2ebfc8bff418565941771ea8f03c557886", + "reference": "bd1bda2ebfc8bff418565941771ea8f03c557886", "shasum": "" }, "require": { @@ -648,7 +645,7 @@ }, "require-dev": { "friendsofphp/php-cs-fixer": "3.3.0", - "json-schema/json-schema-test-suite": "dev-main", + "json-schema/json-schema-test-suite": "^23.2", "marc-mabe/php-enum-phpstan": "^2.0", "phpspec/prophecy": "^1.19", "phpstan/phpstan": "^1.12", @@ -698,9 +695,9 @@ ], "support": { "issues": "https://github.com/jsonrainbow/json-schema/issues", - "source": "https://github.com/jsonrainbow/json-schema/tree/6.8.2" + "source": "https://github.com/jsonrainbow/json-schema/tree/6.9.0" }, - "time": "2026-05-05T05:39:01+00:00" + "time": "2026-06-05T14:05:24+00:00" }, { "name": "marc-mabe/php-enum", @@ -1008,16 +1005,16 @@ }, { "name": "seld/jsonlint", - "version": "1.11.0", + "version": "1.12.1", "source": { "type": "git", "url": "https://github.com/Seldaek/jsonlint.git", - "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2" + "reference": "9a90eb5d32d5a500296bf43f946d60246444d5f7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Seldaek/jsonlint/zipball/1748aaf847fc731cfad7725aec413ee46f0cc3a2", - "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2", + "url": "https://api.github.com/repos/Seldaek/jsonlint/zipball/9a90eb5d32d5a500296bf43f946d60246444d5f7", + "reference": "9a90eb5d32d5a500296bf43f946d60246444d5f7", "shasum": "" }, "require": { @@ -1056,7 +1053,7 @@ ], "support": { "issues": "https://github.com/Seldaek/jsonlint/issues", - "source": "https://github.com/Seldaek/jsonlint/tree/1.11.0" + "source": "https://github.com/Seldaek/jsonlint/tree/1.12.1" }, "funding": [ { @@ -1068,7 +1065,7 @@ "type": "tidelift" } ], - "time": "2024-07-11T14:55:45+00:00" + "time": "2026-06-12T11:32:29+00:00" }, { "name": "seld/phar-utils", @@ -1730,16 +1727,16 @@ }, { "name": "symfony/polyfill-mbstring", - "version": "v1.38.1", + "version": "v1.38.2", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "14c5439eec4ccff081ac14eca2dc57feb2a66d92" + "reference": "d3d318bad5e7a1bfbd026009c8bfb8d8f99ae6b6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/14c5439eec4ccff081ac14eca2dc57feb2a66d92", - "reference": "14c5439eec4ccff081ac14eca2dc57feb2a66d92", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/d3d318bad5e7a1bfbd026009c8bfb8d8f99ae6b6", + "reference": "d3d318bad5e7a1bfbd026009c8bfb8d8f99ae6b6", "shasum": "" }, "require": { @@ -1791,7 +1788,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.38.1" + "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.38.2" }, "funding": [ { @@ -1811,7 +1808,7 @@ "type": "tidelift" } ], - "time": "2026-05-26T12:51:13+00:00" + "time": "2026-05-27T06:59:30+00:00" }, { "name": "symfony/polyfill-php73", @@ -2906,16 +2903,16 @@ }, { "name": "amphp/process", - "version": "v2.0.3", + "version": "v2.1.0", "source": { "type": "git", "url": "https://github.com/amphp/process.git", - "reference": "52e08c09dec7511d5fbc1fb00d3e4e79fc77d58d" + "reference": "583959df17d00304ad7b0b32285373f985935643" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/amphp/process/zipball/52e08c09dec7511d5fbc1fb00d3e4e79fc77d58d", - "reference": "52e08c09dec7511d5fbc1fb00d3e4e79fc77d58d", + "url": "https://api.github.com/repos/amphp/process/zipball/583959df17d00304ad7b0b32285373f985935643", + "reference": "583959df17d00304ad7b0b32285373f985935643", "shasum": "" }, "require": { @@ -2929,7 +2926,7 @@ "amphp/php-cs-fixer-config": "^2", "amphp/phpunit-util": "^3", "phpunit/phpunit": "^9", - "psalm/phar": "^5.4" + "psalm/phar": "6.16.1" }, "type": "library", "autoload": { @@ -2962,7 +2959,7 @@ "homepage": "https://amphp.org/process", "support": { "issues": "https://github.com/amphp/process/issues", - "source": "https://github.com/amphp/process/tree/v2.0.3" + "source": "https://github.com/amphp/process/tree/v2.1.0" }, "funding": [ { @@ -2970,7 +2967,7 @@ "type": "github" } ], - "time": "2024-04-19T03:13:44+00:00" + "time": "2026-05-31T15:11:55+00:00" }, { "name": "amphp/serialization", @@ -3262,140 +3259,6 @@ ], "time": "2022-12-23T10:58:28+00:00" }, - { - "name": "crysalead/dir", - "version": "2.0.4", - "source": { - "type": "git", - "url": "https://github.com/crysalead/dir.git", - "reference": "0390ac74a8f1634b1ec1adffdd118125f1271976" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/crysalead/dir/zipball/0390ac74a8f1634b1ec1adffdd118125f1271976", - "reference": "0390ac74a8f1634b1ec1adffdd118125f1271976", - "shasum": "" - }, - "require": { - "php": ">=5.4" - }, - "require-dev": { - "kahlan/kahlan": "~5.0" - }, - "type": "library", - "autoload": { - "psr-4": { - "Lead\\Dir\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "description": "Recursive directory scanner to locate directories and/or files in a file system", - "keywords": [ - "Directory Scanner", - "directory", - "file", - "file system" - ], - "support": { - "issues": "https://github.com/crysalead/dir/issues", - "source": "https://github.com/crysalead/dir/tree/2.0.4" - }, - "time": "2022-05-17T17:12:17+00:00" - }, - { - "name": "danieljharvey/file-wrapper", - "version": "2.1.2", - "source": { - "type": "git", - "url": "https://github.com/danieljharvey/file-wrapper.git", - "reference": "8e3cc2455d180590bd59a4a2d78ecd97edeed1e8" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/danieljharvey/file-wrapper/zipball/8e3cc2455d180590bd59a4a2d78ecd97edeed1e8", - "reference": "8e3cc2455d180590bd59a4a2d78ecd97edeed1e8", - "shasum": "" - }, - "require": { - "php": ">=5.3.0" - }, - "require-dev": { - "phpunit/phpunit": "4.0.*" - }, - "type": "library", - "autoload": { - "psr-4": { - "DanielJHarvey\\FileWrapper\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Daniel Harvey", - "email": "danieljamesharvey@gmail.com" - } - ], - "description": "A simple file system function wrapper that can be easily mocked or stubbed for testing", - "keywords": [ - "file", - "testing", - "wrapper" - ], - "support": { - "issues": "https://github.com/danieljharvey/file-wrapper/issues", - "source": "https://github.com/danieljharvey/file-wrapper/tree/master" - }, - "time": "2017-09-11T10:00:31+00:00" - }, - { - "name": "danieljharvey/php-git-branch", - "version": "1.1.1", - "source": { - "type": "git", - "url": "https://github.com/danieljharvey/php-git-branch.git", - "reference": "72aeb3367a0293d893828f264cd684aa79dcee96" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/danieljharvey/php-git-branch/zipball/72aeb3367a0293d893828f264cd684aa79dcee96", - "reference": "72aeb3367a0293d893828f264cd684aa79dcee96", - "shasum": "" - }, - "require": { - "danieljharvey/file-wrapper": ">=2.1" - }, - "require-dev": { - "phpunit/phpunit": "^6.2" - }, - "type": "library", - "autoload": { - "psr-4": { - "DanielJHarvey\\PHPGitBranch\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Daniel Harvey", - "email": "danieljamesharvey@gmail.com" - } - ], - "description": "Library for working out which git branch you are on in PHP", - "support": { - "issues": "https://github.com/danieljharvey/php-git-branch/issues", - "source": "https://github.com/danieljharvey/php-git-branch/tree/master" - }, - "time": "2017-08-08T10:38:23+00:00" - }, { "name": "danog/advanced-json-rpc", "version": "v3.2.3", @@ -3812,23 +3675,23 @@ }, { "name": "friendsofphp/php-cs-fixer", - "version": "v3.95.2", + "version": "v3.95.7", "source": { "type": "git", "url": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer.git", - "reference": "a28d88a5e172b27e78d0816992b15a9df3da20f1" + "reference": "4fa4102a5617acae53f804f7c81475aaa2d6e813" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/a28d88a5e172b27e78d0816992b15a9df3da20f1", - "reference": "a28d88a5e172b27e78d0816992b15a9df3da20f1", + "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/4fa4102a5617acae53f804f7c81475aaa2d6e813", + "reference": "4fa4102a5617acae53f804f7c81475aaa2d6e813", "shasum": "" }, "require": { "clue/ndjson-react": "^1.3", "composer/semver": "^3.4", "composer/xdebug-handler": "^3.0.5", - "ergebnis/agent-detector": "^1.1.1", + "ergebnis/agent-detector": "^1.2", "ext-filter": "*", "ext-hash": "*", "ext-json": "*", @@ -3839,32 +3702,32 @@ "react/event-loop": "^1.5", "react/socket": "^1.16", "react/stream": "^1.4", - "sebastian/diff": "^4.0.6 || ^5.1.1 || ^6.0.2 || ^7.0 || ^8.0", + "sebastian/diff": "^4.0.6 || ^5.1.1 || ^6.0.2 || ^7.0 || ^8.0 || ^9.0", "symfony/console": "^5.4.47 || ^6.4.24 || ^7.0 || ^8.0", "symfony/event-dispatcher": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", "symfony/filesystem": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", "symfony/finder": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", "symfony/options-resolver": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0", - "symfony/polyfill-mbstring": "^1.33", - "symfony/polyfill-php80": "^1.33", - "symfony/polyfill-php81": "^1.33", - "symfony/polyfill-php84": "^1.33", + "symfony/polyfill-mbstring": "^1.37", + "symfony/polyfill-php80": "^1.37", + "symfony/polyfill-php81": "^1.37", + "symfony/polyfill-php84": "^1.37", "symfony/process": "^5.4.47 || ^6.4.24 || ^7.2 || ^8.0", "symfony/stopwatch": "^5.4.45 || ^6.4.24 || ^7.0 || ^8.0" }, "require-dev": { "facile-it/paraunit": "^1.3.1 || ^2.11.0", "infection/infection": "^0.32.7", - "justinrainbow/json-schema": "^6.8.0", + "justinrainbow/json-schema": "^6.9.0", "keradus/cli-executor": "^2.3", "mikey179/vfsstream": "^1.6.12", "php-coveralls/php-coveralls": "^2.9.1", "php-cs-fixer/phpunit-constraint-isidenticalstring": "^1.8", "php-cs-fixer/phpunit-constraint-xmlmatchesxsd": "^1.8", "phpunit/phpunit": "^9.6.34 || ^10.5.63 || ^11.5.55", - "symfony/polyfill-php85": "^1.33", - "symfony/var-dumper": "^5.4.48 || ^6.4.32 || ^7.4.4 || ^8.0.8", - "symfony/yaml": "^5.4.45 || ^6.4.30 || ^7.4.1 || ^8.0.8" + "symfony/polyfill-php85": "^1.38", + "symfony/var-dumper": "^5.4.48 || ^6.4.36 || ^7.4.8 || ^8.1.0", + "symfony/yaml": "^5.4.53 || ^6.4.41 || ^7.4.13 || ^8.1.0" }, "suggest": { "ext-dom": "For handling output formats in XML", @@ -3905,7 +3768,7 @@ ], "support": { "issues": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues", - "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.95.2" + "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.95.7" }, "funding": [ { @@ -3913,7 +3776,7 @@ "type": "github" } ], - "time": "2026-05-15T09:20:44+00:00" + "time": "2026-06-13T17:51:53+00:00" }, { "name": "kelunik/certificate", @@ -4813,11 +4676,11 @@ }, { "name": "phpstan/phpstan", - "version": "2.2.1", + "version": "2.2.2", "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpstan/zipball/dea9c8f2d25cc849391042b71e429c1a4bf82660", - "reference": "dea9c8f2d25cc849391042b71e429c1a4bf82660", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/e5cc34d491a90e79c216d824f60fe21fd4d93bd6", + "reference": "e5cc34d491a90e79c216d824f60fe21fd4d93bd6", "shasum": "" }, "require": { @@ -4873,7 +4736,7 @@ "type": "github" } ], - "time": "2026-05-28T14:44:12+00:00" + "time": "2026-06-05T09:00:01+00:00" }, { "name": "phpstan/phpstan-strict-rules", @@ -4928,16 +4791,16 @@ }, { "name": "phpunit/php-code-coverage", - "version": "14.1.9", + "version": "14.2.2", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "655533a65696bbc4231cd8027af150dadc40ec88" + "reference": "10d7da3628a99289cdf4c662dd7f0d73f1baec83" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/655533a65696bbc4231cd8027af150dadc40ec88", - "reference": "655533a65696bbc4231cd8027af150dadc40ec88", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/10d7da3628a99289cdf4c662dd7f0d73f1baec83", + "reference": "10d7da3628a99289cdf4c662dd7f0d73f1baec83", "shasum": "" }, "require": { @@ -4949,14 +4812,14 @@ "php": ">=8.4", "phpunit/php-text-template": "^6.0", "sebastian/complexity": "^6.0", - "sebastian/environment": "^9.2", + "sebastian/environment": "^9.3.2", "sebastian/git-state": "^1.0", - "sebastian/lines-of-code": "^5.0", + "sebastian/lines-of-code": "^5.0.1", "sebastian/version": "^7.0", "theseer/tokenizer": "^2.0.1" }, "require-dev": { - "phpunit/phpunit": "^13.1" + "phpunit/phpunit": "^13.2.0" }, "suggest": { "ext-pcov": "PHP extension that provides line coverage", @@ -4965,7 +4828,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "14.1.x-dev" + "dev-main": "14.2.x-dev" } }, "autoload": { @@ -4994,7 +4857,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/14.1.9" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/14.2.2" }, "funding": [ { @@ -5014,7 +4877,7 @@ "type": "tidelift" } ], - "time": "2026-05-16T05:16:14+00:00" + "time": "2026-06-08T11:50:38+00:00" }, { "name": "phpunit/php-file-iterator", @@ -5311,16 +5174,16 @@ }, { "name": "phpunit/phpunit", - "version": "13.1.13", + "version": "13.1.14", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "ddf7f25d9ee9652b464475d7f3bacde2613e355e" + "reference": "cdd419c33c040c6b570e51dba8ecbe81d399da53" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/ddf7f25d9ee9652b464475d7f3bacde2613e355e", - "reference": "ddf7f25d9ee9652b464475d7f3bacde2613e355e", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/cdd419c33c040c6b570e51dba8ecbe81d399da53", + "reference": "cdd419c33c040c6b570e51dba8ecbe81d399da53", "shasum": "" }, "require": { @@ -5334,7 +5197,7 @@ "phar-io/manifest": "^2.0.4", "phar-io/version": "^3.2.1", "php": ">=8.4.1", - "phpunit/php-code-coverage": "^14.1.9", + "phpunit/php-code-coverage": "^14.1.10", "phpunit/php-file-iterator": "^7.0.0", "phpunit/php-invoker": "^7.0.0", "phpunit/php-text-template": "^6.0.0", @@ -5345,7 +5208,7 @@ "sebastian/environment": "^9.3.2", "sebastian/exporter": "^8.1.0", "sebastian/git-state": "^1.0", - "sebastian/global-state": "^9.0.0", + "sebastian/global-state": "^9.0.1", "sebastian/object-enumerator": "^8.0.0", "sebastian/recursion-context": "^8.0.0", "sebastian/type": "^7.0.1", @@ -5390,7 +5253,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/13.1.13" + "source": "https://github.com/sebastianbergmann/phpunit/tree/13.1.14" }, "funding": [ { @@ -5398,7 +5261,7 @@ "type": "other" } ], - "time": "2026-05-27T14:03:08+00:00" + "time": "2026-06-04T06:16:42+00:00" }, { "name": "psalm/plugin-phpunit", @@ -6141,61 +6004,6 @@ }, "time": "2026-05-16T17:55:38+00:00" }, - { - "name": "rogervila/php-sonarqube-scanner", - "version": "1.1.0", - "source": { - "type": "git", - "url": "https://github.com/rogervila/php-sonarqube-scanner.git", - "reference": "262a79012b1fc94c2814c9e9a76c1e533577b18e" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/rogervila/php-sonarqube-scanner/zipball/262a79012b1fc94c2814c9e9a76c1e533577b18e", - "reference": "262a79012b1fc94c2814c9e9a76c1e533577b18e", - "shasum": "" - }, - "require": { - "crysalead/dir": "^2.0", - "danieljharvey/php-git-branch": "^1.1", - "ext-zip": "*", - "tivie/php-os-detector": "^1.1" - }, - "require-dev": { - "creativestyle/app-http-server-mock": "^1.0", - "phpunit/phpunit": "^7.0 || ^8.0 || ^9.0", - "symfony/process": "^4.1 || ^5.0" - }, - "bin": [ - "sonar-scanner" - ], - "type": "library", - "autoload": { - "psr-4": { - "Sonar\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Roger Vilà", - "email": "rogervila@me.com" - } - ], - "description": "Run SonarQube Scanner with composer", - "keywords": [ - "sonar scanner php", - "sonarqube scanner php" - ], - "support": { - "issues": "https://github.com/rogervila/php-sonarqube-scanner/issues", - "source": "https://github.com/rogervila/php-sonarqube-scanner/tree/1.1.0" - }, - "time": "2020-12-09T07:46:28+00:00" - }, { "name": "sebastian/cli-parser", "version": "5.0.0", @@ -6743,16 +6551,16 @@ }, { "name": "sebastian/global-state", - "version": "9.0.0", + "version": "9.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/global-state.git", - "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7" + "reference": "ba68ba79da690cf7eddefd3ce5b78b20b9ba9945" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/e52e3dc22441e6218c710afe72c3042f8fc41ea7", - "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7", + "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/ba68ba79da690cf7eddefd3ce5b78b20b9ba9945", + "reference": "ba68ba79da690cf7eddefd3ce5b78b20b9ba9945", "shasum": "" }, "require": { @@ -6762,7 +6570,7 @@ }, "require-dev": { "ext-dom": "*", - "phpunit/phpunit": "^13.0" + "phpunit/phpunit": "^13.1.13" }, "type": "library", "extra": { @@ -6793,7 +6601,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/global-state/issues", "security": "https://github.com/sebastianbergmann/global-state/security/policy", - "source": "https://github.com/sebastianbergmann/global-state/tree/9.0.0" + "source": "https://github.com/sebastianbergmann/global-state/tree/9.0.1" }, "funding": [ { @@ -6813,7 +6621,7 @@ "type": "tidelift" } ], - "time": "2026-02-06T04:45:13+00:00" + "time": "2026-06-01T15:11:33+00:00" }, { "name": "sebastian/lines-of-code", @@ -7835,16 +7643,16 @@ }, { "name": "symfony/polyfill-deepclone", - "version": "v1.37.0", + "version": "v1.40.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-deepclone.git", - "reference": "2ca9e9e75ead5174f2b44613a646bdc9338b8eb4" + "reference": "dca4ccba5f360070b574414dce4c1e7a559844fa" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-deepclone/zipball/2ca9e9e75ead5174f2b44613a646bdc9338b8eb4", - "reference": "2ca9e9e75ead5174f2b44613a646bdc9338b8eb4", + "url": "https://api.github.com/repos/symfony/polyfill-deepclone/zipball/dca4ccba5f360070b574414dce4c1e7a559844fa", + "reference": "dca4ccba5f360070b574414dce4c1e7a559844fa", "shasum": "" }, "require": { @@ -7898,7 +7706,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-deepclone/tree/v1.37.0" + "source": "https://github.com/symfony/polyfill-deepclone/tree/v1.40.0" }, "funding": [ { @@ -7918,7 +7726,7 @@ "type": "tidelift" } ], - "time": "2026-04-26T13:03:27+00:00" + "time": "2026-06-12T07:27:17+00:00" }, { "name": "symfony/stopwatch", @@ -8119,58 +7927,6 @@ ], "time": "2025-12-08T11:19:18+00:00" }, - { - "name": "tivie/php-os-detector", - "version": "1.1.0", - "source": { - "type": "git", - "url": "https://github.com/tivie/php-os-detector.git", - "reference": "9461dcd85c00e03842264f2fc8ccdc8d46867321" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/tivie/php-os-detector/zipball/9461dcd85c00e03842264f2fc8ccdc8d46867321", - "reference": "9461dcd85c00e03842264f2fc8ccdc8d46867321", - "shasum": "" - }, - "require": { - "php": ">=5.3.0" - }, - "require-dev": { - "phpunit/phpunit": "4.3.*" - }, - "type": "library", - "autoload": { - "psr-4": { - "Tivie\\OS\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "APACHE 2.0" - ], - "authors": [ - { - "name": "Estevão Soares dos Santos", - "email": "estevao@soares-dos-santos.com" - } - ], - "description": "A small utility library that detects the OS the server is running on", - "homepage": "http://tivie.github.com/php-os-detector/", - "keywords": [ - "detection", - "detector", - "identification", - "operating system", - "os", - "os detection" - ], - "support": { - "issues": "https://github.com/tivie/php-os-detector/issues", - "source": "https://github.com/tivie/php-os-detector/tree/master" - }, - "time": "2017-10-21T03:33:59+00:00" - }, { "name": "vimeo/psalm", "version": "6.16.1", @@ -8365,8 +8121,5 @@ "php": ">=8.4.1" }, "platform-dev": {}, - "platform-overrides": { - "php": "8.4.3" - }, "plugin-api-version": "2.9.0" } diff --git a/config.adoc b/config.adoc deleted file mode 100644 index 81b5ea0..0000000 --- a/config.adoc +++ /dev/null @@ -1,436 +0,0 @@ -:hide-uri-scheme: -:doctype: book - -:site_resource: . -// project settings - START -// user data -:acc_vcs_url: https://github.com -:acc_user: ollily -:acc_user_orga: The-oGlow -:acc_user_name: Oliver Glowa -:acc_user_email: coding at glowa-net dot com -:acc_user_hp: http://coding.glowa-net.com -:acc_user_url: {acc_vcs_url}/{acc_user}[{acc_user_name}] - -// organization -:orga_vcs_url: {acc_vcs_url} -:orga_user: The-oGlow -:orga_user_name: The oGlow -:orga_user_email: {acc_user_email} -:orga_user_hp: {acc_user_hp} -:orga_user_url: {orga_vcs_url}/{orga_user}[{orga_user_name}] - -// organization team -:orga_team_user: oteam -:orga_team_user_name: The oTeam -:orga_team_email: {orga_user_email} -:orga_team_hp: {orga_user_hp} -:orga_team_url: {orga_vcs_url}/orgs/{orga_user}/teams/{orga_team_user}[{orga_team_user_name}] - -// module data -// Description of this project -// Name of the author or Github user name (acc_user_name or orga_user_name) -:pj_author: {acc_user_name} -// Version or "latest version" -:pj_version: [latest version] -// Creation year -:pj_year: 2025 -// Github description -:pj_description: Simplify the usage of - Testing with PHPUnit - Reflection with PHP - Developer shortkeys for composer - -// Id of this project -// Prefix of the Github URL (acc_vcs_url or orga_vcs_url) -:pj_gh_vcs_url: {orga_vcs_url} -// Github User or Organisation (acc_user or orga_user) -:pj_gh_account: {orga_user} -// Github repo name -:pj_gh_repo: ezkoding -// Github projectid or -1 -:pj_gh_vcsid: {pj_gh_account}/{pj_gh_repo} - -// Tools for this project -// Soonar projectid or -1 -:pj_snr_projid: {pj_gh_account}_{pj_gh_repo} -// Codacy Token or -1 -:pj_cdcy_id: c029d57bf66e4574b403c91604a08669 -// Coveralls projectid or -1 -:pj_cvrlls_id: {pj_gh_account}/{pj_gh_repo} -// OpenSSF projectid or -1 -:pj_opnssf_id: -1 -// Coverty projectid or -1 -:pj_cvrty_id: -1 -// project settings - END -// common settings - START -:site_resource: . - -// common settings - START -:brnch1: master -:brnch2: develop - -// project settings (generated) -// module data generated -:pj_cright_author: (c) {pj_year} by {acc_user_url} -:pj_cright_orga: (c) {pj_year} by {orga_user_url} - -// Shields - START -:cm_shlds_url: https://img.shields.io -:cm_shlds_badge_url: {cm_shlds_url}/badge -:cm_shlds_img_style: &style=plastic -:cm_shlds_notsupp_url: {cm_shlds_badge_url}/info-not%20supported-lightgrey?{cm_shlds_img_style} -:cm_shlds_notneed_url: {cm_shlds_badge_url}/info-not%20needed-lightgrey?{cm_shlds_img_style} - -:cm_shlds_tool_style: -orange?{cm_shlds_img_style} -:cm_shlds_tool_phpcsfixer_url: {cm_shlds_badge_url}/php_cs_fixer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpunit_url: {cm_shlds_badge_url}/phpunit-UNIT_Tests{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpstan_url: {cm_shlds_badge_url}/phpstan-Level_8_Strict{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_psalm_url: {cm_shlds_badge_url}/psalm-Level_2{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpmd_url: {cm_shlds_badge_url}/php_mess_detector-codesize_&_cleancode_&_controversial_&_design_&_naming_&_unusedcode{cm_shlds_tool_style}&logo=php - -:cm_shlds_tool_phpunit_img: image:{cm_shlds_tool_phpunit_url}[title="PHPUnit Tests"] -// Shields - END -// github - START -ifeval::["{pj_gh_vcsid}" != "-1"] -:cm_gh_wrkflw_link: actions/workflows - -// shields for github -:cm_shlds_gh_url: {cm_shlds_url}/github -:cm_shlds_gh_logo: logo=github -:cm_shlds_gh_style: &{cm_shlds_gh_logo}{cm_shlds_img_style} -:cm_shlds_gh_status_url: {cm_shlds_gh_url}/actions/workflow/status -:cm_shlds_gh_issues_url: {cm_shlds_gh_url}/issues -// :cm_shlds_gh_pulls_url: {cm_shlds_gh_url}/pulls -:cm_shlds_gh_license_url: {cm_shlds_gh_url}/license -:cm_shlds_gh_release_url: {cm_shlds_gh_url}/v/release -:cm_shlds_gh_langtop_url: {cm_shlds_gh_url}/languages/count -:cm_shlds_gh_langcount_url: {cm_shlds_gh_url}/languages/top -:cm_shlds_gh_checkruns_url: {cm_shlds_gh_url}/check-runs - -// project settings (generated) -// module data generated -:pj_gh_vcsid_url: {pj_gh_vcs_url}/{pj_gh_vcsid} -:pj_gh_wflow_url: {pj_gh_vcsid_url}/{cm_gh_wrkflw_link} - -// project status -// ps github -:pj_ps_release_url: {cm_shlds_gh_release_url}/{pj_gh_vcsid}?{cm_shlds_gh_style}&sort=semver -:pj_ps_license_url: {cm_shlds_gh_license_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langtop_url: {cm_shlds_gh_langtop_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langcount_url: {cm_shlds_gh_langcount_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_issues_url: {cm_shlds_gh_issues_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_release_img: image:{pj_ps_license_url}[title="License"] -:pj_ps_license_img: image:{pj_ps_release_url}[title="Latest Release"] -:pj_ps_langtop_img: image:{pj_ps_langtop_url}[title="Main Language"] -:pj_ps_langcount_img: image:{pj_ps_langcount_url}[title="No of Languages"] -:pj_ps_issues_img: image:{pj_ps_issues_url}[title="Open Issues"] - -// build status -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch1}&label={brnch1} -:pj_bs_brnch2_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch2}&label={brnch2} -:pj_bs_brnch1_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch1}?{cm_shlds_snr_style} -:pj_bs_brnch2_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_gh_vcsid}" == "-1"] -// module data generated -:pj_gh_vcsid_url: -:pj_gh_wflow_url: -// ps github -:pj_ps_release_url: -:pj_ps_license_url: -:pj_ps_langtop_url: -:pj_ps_langcount_url: -:pj_ps_issues_url: -:pj_ps_release_img: -:pj_ps_license_img: -:pj_ps_langtop_img: -:pj_ps_langcount_img: -:pj_ps_issues_img: -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch1_checkruns_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_checkruns_url: {cm_shlds_notsupp_url} -endif::[] -// github - END -// sonar - START -ifeval::["{pj_snr_projid}" != "-1"] -:cm_snr_url: https://sonarcloud.io -:cm_snr_badge_url: {cm_snr_url}/images/project_badges -:cm_snr_dash_url: {cm_snr_url}/dashboard?id= -:cm_snr_api_url: {cm_snr_url}/api -:cm_snr_qgate_url: {cm_snr_api_url}/project_badges/quality_gate?project= -:cm_snr_brnch_url: {cm_snr_url}/summary/new_code?id= -:cm_snr_mes_tsd: component_measures?metric=test_success_density&view=list -:cm_snr_mes_test: component_measures?metric=tests&view=list -:cm_snr_mes_cov: component_measures?metric=coverage&view=list -:cm_snr_logo_url: {cm_snr_badge_url}/sonarcloud-black.svg -:cm_snr_logo_url2: {cm_snr_badge_url}/sonarcloud-light.svg -:cm_snr_tool_sonarcloud_url: {cm_snr_logo_url2} - -// shields for sonar -:cm_shlds_snr_url: {cm_shlds_url}/sonar -:cm_shlds_snr_logo: logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io -:cm_shlds_snr_style: &{cm_shlds_snr_logo}{cm_shlds_img_style} -:cm_shlds_snr_qgate_url: {cm_shlds_snr_url}/quality_gate -:cm_shlds_snr_tsd_url: {cm_shlds_snr_url}/test_success_density -:cm_shlds_snr_tests_url: {cm_shlds_snr_url}/tests -:cm_shlds_snr_coverage_url: {cm_shlds_snr_url}/coverage -:cm_shlds_snr_violations_url: {cm_shlds_snr_url}/violations -:cm_shlds_tool_sonarcloud_url: {cm_shlds_badge_url}/sonarcloud-oGlow_way{cm_shlds_tool_style}&logo=sonar -:cm_shlds_tool_sonarcloud_img: image:{cm_shlds_tool_sonarcloud_url}[title="Sonarcloud Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_snr_component: {pj_gh_account}:{pj_gh_repo} -:pj_snr_dash_url: {cm_snr_dash_url}{pj_snr_projid} -:pj_snr_brnch_main_url: {cm_snr_brnch_url}{pj_snr_projid} -:pj_snr_brnch1_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch1} -:pj_snr_brnch2_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch2} - -// quality information -// qi shields -:pj_qi_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tsd_url: {cm_shlds_snr_tsd_url_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}?{cm_shlds_snr_style} - -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_qi_snr_qgate_url: {cm_snr_qgate_url}{pj_snr_projid} -:pj_qi_snr_logo_url: {cm_snr_logo_url} - -// test information -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_snr_projid}" == "-1"] -// shields for sonar -:cm_shlds_tool_sonarcloud_url: -:cm_shlds_tool_sonarcloud_img: -// module data generated -:pj_snr_dash_url: -:pj_snr_brnch_main_url: -// qi shields -:pj_qi_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_tsd_url: {cm_shlds_notsupp_url} -:pj_qi_tests_url: {cm_shlds_notsupp_url} -:pj_qi_coverage_url: {cm_shlds_notsupp_url} -:pj_qi_violations_url: {cm_shlds_notsupp_url} -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_logo_url: {cm_shlds_notsupp_url} -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_notsupp_url} -endif::[] -// sonar - END -// codacy - START -ifeval::["{pj_cdcy_id}" != "-1"] -:cm_cdcy_url: https://www.codacy.com -:cm_cdcy_app: https://app.codacy.com -:cm_cdcy_badge_grade_url: {cm_cdcy_app}/project/badge/Grade -:cm_cdcy_badge_coverage_url: {cm_cdcy_app}/project/badge/Coverage -:cm_cdcy_dash_gh_url: {cm_cdcy_app}/gh - -// shields for codacy -:cm_shlds_cdcy_url: {cm_shlds_url}/codacy -:cm_shlds_cdcy_logo: logo=codacy -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_cdcy_grade_url: {cm_shlds_cdcy_url}/grade -:cm_shlds_cdcy_coverage_url: {cm_shlds_cdcy_url}/coverage -:cm_shlds_tool_cdcy_url: {cm_shlds_badge_url}/codacy-oGlow_Rulset{cm_shlds_tool_style}&logo=codacy -:cm_shlds_tool_cdcy_img: image:{cm_shlds_tool_cdcy_url}[title="Codacy Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_cdcy_vcsid: {pj_gh_vcsid} - -// quality information -// qi codacy -:pj_cdcy_vcsid_url: {cm_cdcy_dash_gh_url}/{pj_cdcy_vcsid}/dashboard -:pj_cdcy_branch1_url: {pj_cdcy_vcsid_url}?branch={brnch1} -:pj_cdcy_branch2_url: {pj_cdcy_vcsid_url}?branch={brnch2} -:pj_qi_cdcy_badge_grade_url: {cm_cdcy_badge_grade_url}/{pj_cdcy_id} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_badge_coverage_url: {cm_cdcy_badge_coverage_url}/{pj_cdcy_id} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -endif::[] -ifeval::["{pj_cdcy_id}" == "-1"] -// shields for codacy -:cm_shlds_tool_cdcy_url: -:cm_shlds_tool_cdcy_img: -// qi codacy -:pj_cdcy_vcsid_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch1_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch2_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_badge_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_badge_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_notsupp_url} -endif::[] -// codacy - END -//coveralls - START -ifeval::["{pj_cvrlls_id}" != "-1"] -:cm_cvrlls_url: https://coveralls.io -:cm_cvrlls_dash_gh_url: {cm_cvrlls_url}/github -:cm_cvrlls_repos_gh_url: {cm_cvrlls_url}/repos/github - -// shields for coveralls -:cm_shlds_cvrlls_url: {cm_shlds_url}/coveralls/github -:cm_shlds_cvrlls_logo: logo=coveralls -:cm_shlds_cvrlls_style: &{cm_shlds_cvrlls_logo}{cm_shlds_img_style} -:cm_shlds_tool_cvrlls_url: {cm_shlds_badge_url}/coveralls-Coverage{cm_shlds_tool_style}&logo=coveralls -:cm_shlds_tool_cvrlls_img: image:{cm_shlds_tool_cvrlls_url}[title="Coveralls Coverage"] -// project settings (generated) -// module data generated -:pj_cvrlls_vcsid: {pj_cvrlls_id} - -// test information -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid} -:pj_cvrlls_brnch1_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch1} -:pj_cvrlls_brnch2_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch2} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch1} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch2} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch1}?{cm_shlds_cvrlls_style} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch2}?{cm_shlds_cvrlls_style} -endif::[] -ifeval::["{pj_cvrlls_id}" == "-1"] -// shields for coveralls -:cm_shlds_tool_cvrlls_url: -:cm_shlds_tool_cvrlls_img: -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch1_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch2_dash_gh_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_notsupp_url} -endif::[] -//coveralls - END -// phpcodesniffer - START -:cm_phpcs_url: https://github.com/PHPCSStandards/PHP_CodeSniffer - -// shields for phpcodesniffer -:cm_shlds_phpcs_url: {cm_shlds_url}/phpcodesniffer -:cm_shlds_cdcy_logo: logo=php -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_tool_phpcs_url: {cm_shlds_badge_url}/php_codesniffer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -// phpcodesniffer - END -// openssf - START -ifeval::["{pj_opnssf_id}" != "-1"] -:cm_opnssf_url: https://www.bestpractices.dev -:cm_opnssf_badge_url: {cm_opnssf_url}/projects -:cm_opnssf_dash_url: {cm_opnssf_url}/projects - -// project settings (generated) -// module data generated -:pj_opnssf_vcsid: {pj_opnssf_id} - -// quality information -// qi openssf -:pj_opnssf_dash_url: {cm_opnssf_dash_url}/{pj_opnssf_vcsid} -:pj_qi_opnssf_status_url: {cm_opnssf_badge_url}/{pj_opnssf_vcsid}/badge -endif::[] -ifeval::["{pj_opnssf_id}" == "-1"] -:pj_opnssf_dash_url: {cm_shlds_notsupp_url} -:pj_qi_opnssf_status_url: {cm_shlds_notsupp_url} -endif::[] -// openssf - END -// common settings - END - -:source-highlighter: highlight.js - -= {pj_gh_repo} - Configuration -:toc: -:toclevels: 2 - -== Requirements - -* link:https://www.php.net[PHP] -* link:https://getcomposer.org/[Composer] -* Commandline / Shell (opt.) -** Linux / Unix Shell or -** Windows Shell - -== Configuration - -=== Unix / Linux - -There is nothing to configure. You can use this library ootb. - -=== Windows - -There is nothing to configure. You can use this library ootb. - -== Development - -Some infos, in case you want to fork and extend this library, - -=== Build & Test - -Start the whole build (run composer with c-fix, c-phpstan, c-psalm, c-test) - - composer c-all - -=== UNIT Tests - -Starting the unit tests with PHPUnit - - composer c-test - -or - - composer c-test tests/Monolog/ConsoleLoggerTest.php - -=== Structure - -Relevant files and folders - - - |--src - | |-- PHPUnit - | |-- Tools - | - |--tests - | |-- PHPUnit - | |-- Tools - | - |--vendor - | |- * - | - |-.php-cs-fixer.dist.php - |-.phpcs.xml.dist - |-.phpmd.xml.dist - |-composer.json - |-composer.lock - |-LICENSE - |-phpstan.neon.dist - |-phpunit.xml.dist - |-psalm.xml.dist - |-README.md - |-sonar-project.properties - -_{pj_cright_author}_ diff --git a/examples.adoc b/examples.adoc deleted file mode 100644 index cbbc5a3..0000000 --- a/examples.adoc +++ /dev/null @@ -1,817 +0,0 @@ -:hide-uri-scheme: -:doctype: book - -:site_resource: . -// project settings - START -// user data -:acc_vcs_url: https://github.com -:acc_user: ollily -:acc_user_orga: The-oGlow -:acc_user_name: Oliver Glowa -:acc_user_email: coding at glowa-net dot com -:acc_user_hp: http://coding.glowa-net.com -:acc_user_url: {acc_vcs_url}/{acc_user}[{acc_user_name}] - -// organization -:orga_vcs_url: {acc_vcs_url} -:orga_user: The-oGlow -:orga_user_name: The oGlow -:orga_user_email: {acc_user_email} -:orga_user_hp: {acc_user_hp} -:orga_user_url: {orga_vcs_url}/{orga_user}[{orga_user_name}] - -// organization team -:orga_team_user: oteam -:orga_team_user_name: The oTeam -:orga_team_email: {orga_user_email} -:orga_team_hp: {orga_user_hp} -:orga_team_url: {orga_vcs_url}/orgs/{orga_user}/teams/{orga_team_user}[{orga_team_user_name}] - -// module data -// Description of this project -// Name of the author or Github user name (acc_user_name or orga_user_name) -:pj_author: {acc_user_name} -// Version or "latest version" -:pj_version: [latest version] -// Creation year -:pj_year: 2025 -// Github description -:pj_description: Simplify the usage of - Testing with PHPUnit - Reflection with PHP - Developer shortkeys for composer - -// Id of this project -// Prefix of the Github URL (acc_vcs_url or orga_vcs_url) -:pj_gh_vcs_url: {orga_vcs_url} -// Github User or Organisation (acc_user or orga_user) -:pj_gh_account: {orga_user} -// Github repo name -:pj_gh_repo: ezkoding -// Github projectid or -1 -:pj_gh_vcsid: {pj_gh_account}/{pj_gh_repo} - -// Tools for this project -// Soonar projectid or -1 -:pj_snr_projid: {pj_gh_account}_{pj_gh_repo} -// Codacy Token or -1 -:pj_cdcy_id: c029d57bf66e4574b403c91604a08669 -// Coveralls projectid or -1 -:pj_cvrlls_id: {pj_gh_account}/{pj_gh_repo} -// OpenSSF projectid or -1 -:pj_opnssf_id: -1 -// Coverty projectid or -1 -:pj_cvrty_id: -1 -// project settings - END -// common settings - START -:site_resource: . - -// common settings - START -:brnch1: master -:brnch2: develop - -// project settings (generated) -// module data generated -:pj_cright_author: (c) {pj_year} by {acc_user_url} -:pj_cright_orga: (c) {pj_year} by {orga_user_url} - -// Shields - START -:cm_shlds_url: https://img.shields.io -:cm_shlds_badge_url: {cm_shlds_url}/badge -:cm_shlds_img_style: &style=plastic -:cm_shlds_notsupp_url: {cm_shlds_badge_url}/info-not%20supported-lightgrey?{cm_shlds_img_style} -:cm_shlds_notneed_url: {cm_shlds_badge_url}/info-not%20needed-lightgrey?{cm_shlds_img_style} - -:cm_shlds_tool_style: -orange?{cm_shlds_img_style} -:cm_shlds_tool_phpcsfixer_url: {cm_shlds_badge_url}/php_cs_fixer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpunit_url: {cm_shlds_badge_url}/phpunit-UNIT_Tests{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpstan_url: {cm_shlds_badge_url}/phpstan-Level_8_Strict{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_psalm_url: {cm_shlds_badge_url}/psalm-Level_2{cm_shlds_tool_style}&logo=php -:cm_shlds_tool_phpmd_url: {cm_shlds_badge_url}/php_mess_detector-codesize_&_cleancode_&_controversial_&_design_&_naming_&_unusedcode{cm_shlds_tool_style}&logo=php - -:cm_shlds_tool_phpunit_img: image:{cm_shlds_tool_phpunit_url}[title="PHPUnit Tests"] -// Shields - END -// github - START -ifeval::["{pj_gh_vcsid}" != "-1"] -:cm_gh_wrkflw_link: actions/workflows - -// shields for github -:cm_shlds_gh_url: {cm_shlds_url}/github -:cm_shlds_gh_logo: logo=github -:cm_shlds_gh_style: &{cm_shlds_gh_logo}{cm_shlds_img_style} -:cm_shlds_gh_status_url: {cm_shlds_gh_url}/actions/workflow/status -:cm_shlds_gh_issues_url: {cm_shlds_gh_url}/issues -// :cm_shlds_gh_pulls_url: {cm_shlds_gh_url}/pulls -:cm_shlds_gh_license_url: {cm_shlds_gh_url}/license -:cm_shlds_gh_release_url: {cm_shlds_gh_url}/v/release -:cm_shlds_gh_langtop_url: {cm_shlds_gh_url}/languages/count -:cm_shlds_gh_langcount_url: {cm_shlds_gh_url}/languages/top -:cm_shlds_gh_checkruns_url: {cm_shlds_gh_url}/check-runs - -// project settings (generated) -// module data generated -:pj_gh_vcsid_url: {pj_gh_vcs_url}/{pj_gh_vcsid} -:pj_gh_wflow_url: {pj_gh_vcsid_url}/{cm_gh_wrkflw_link} - -// project status -// ps github -:pj_ps_release_url: {cm_shlds_gh_release_url}/{pj_gh_vcsid}?{cm_shlds_gh_style}&sort=semver -:pj_ps_license_url: {cm_shlds_gh_license_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langtop_url: {cm_shlds_gh_langtop_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_langcount_url: {cm_shlds_gh_langcount_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_issues_url: {cm_shlds_gh_issues_url}/{pj_gh_vcsid}?{cm_shlds_gh_style} -:pj_ps_release_img: image:{pj_ps_license_url}[title="License"] -:pj_ps_license_img: image:{pj_ps_release_url}[title="Latest Release"] -:pj_ps_langtop_img: image:{pj_ps_langtop_url}[title="Main Language"] -:pj_ps_langcount_img: image:{pj_ps_langcount_url}[title="No of Languages"] -:pj_ps_issues_img: image:{pj_ps_issues_url}[title="Open Issues"] - -// build status -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch1}&label={brnch1} -:pj_bs_brnch2_status_url: {cm_shlds_gh_status_url}/{pj_gh_vcsid}/build.yml?{cm_shlds_gh_style}&branch={brnch2}&label={brnch2} -:pj_bs_brnch1_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch1}?{cm_shlds_snr_style} -:pj_bs_brnch2_checkruns_url: {cm_shlds_gh_checkruns_url}/{pj_gh_vcsid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_gh_vcsid}" == "-1"] -// module data generated -:pj_gh_vcsid_url: -:pj_gh_wflow_url: -// ps github -:pj_ps_release_url: -:pj_ps_license_url: -:pj_ps_langtop_url: -:pj_ps_langcount_url: -:pj_ps_issues_url: -:pj_ps_release_img: -:pj_ps_license_img: -:pj_ps_langtop_img: -:pj_ps_langcount_img: -:pj_ps_issues_img: -// bs github -:pj_bs_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_status_url: {cm_shlds_notsupp_url} -:pj_bs_brnch1_checkruns_url: {cm_shlds_notsupp_url} -:pj_bs_brnch2_checkruns_url: {cm_shlds_notsupp_url} -endif::[] -// github - END -// sonar - START -ifeval::["{pj_snr_projid}" != "-1"] -:cm_snr_url: https://sonarcloud.io -:cm_snr_badge_url: {cm_snr_url}/images/project_badges -:cm_snr_dash_url: {cm_snr_url}/dashboard?id= -:cm_snr_api_url: {cm_snr_url}/api -:cm_snr_qgate_url: {cm_snr_api_url}/project_badges/quality_gate?project= -:cm_snr_brnch_url: {cm_snr_url}/summary/new_code?id= -:cm_snr_mes_tsd: component_measures?metric=test_success_density&view=list -:cm_snr_mes_test: component_measures?metric=tests&view=list -:cm_snr_mes_cov: component_measures?metric=coverage&view=list -:cm_snr_logo_url: {cm_snr_badge_url}/sonarcloud-black.svg -:cm_snr_logo_url2: {cm_snr_badge_url}/sonarcloud-light.svg -:cm_snr_tool_sonarcloud_url: {cm_snr_logo_url2} - -// shields for sonar -:cm_shlds_snr_url: {cm_shlds_url}/sonar -:cm_shlds_snr_logo: logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io -:cm_shlds_snr_style: &{cm_shlds_snr_logo}{cm_shlds_img_style} -:cm_shlds_snr_qgate_url: {cm_shlds_snr_url}/quality_gate -:cm_shlds_snr_tsd_url: {cm_shlds_snr_url}/test_success_density -:cm_shlds_snr_tests_url: {cm_shlds_snr_url}/tests -:cm_shlds_snr_coverage_url: {cm_shlds_snr_url}/coverage -:cm_shlds_snr_violations_url: {cm_shlds_snr_url}/violations -:cm_shlds_tool_sonarcloud_url: {cm_shlds_badge_url}/sonarcloud-oGlow_way{cm_shlds_tool_style}&logo=sonar -:cm_shlds_tool_sonarcloud_img: image:{cm_shlds_tool_sonarcloud_url}[title="Sonarcloud Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_snr_component: {pj_gh_account}:{pj_gh_repo} -:pj_snr_dash_url: {cm_snr_dash_url}{pj_snr_projid} -:pj_snr_brnch_main_url: {cm_snr_brnch_url}{pj_snr_projid} -:pj_snr_brnch1_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch1} -:pj_snr_brnch2_url: {cm_snr_brnch_url}{pj_snr_projid}&branch={brnch2} - -// quality information -// qi shields -:pj_qi_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tsd_url: {cm_shlds_snr_tsd_url_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}?{cm_shlds_snr_style} -:pj_qi_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}?{cm_shlds_snr_style} - -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_snr_qgate_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_qi_snr_qgate_url: {cm_snr_qgate_url}{pj_snr_projid} -:pj_qi_snr_logo_url: {cm_snr_logo_url} - -// test information -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_snr_tsd_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_snr_tests_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_snr_coverage_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch1}?{cm_shlds_snr_style} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_snr_violations_url}/{pj_snr_projid}/{brnch2}?{cm_shlds_snr_style} -endif::[] -ifeval::["{pj_snr_projid}" == "-1"] -// shields for sonar -:cm_shlds_tool_sonarcloud_url: -:cm_shlds_tool_sonarcloud_img: -// module data generated -:pj_snr_dash_url: -:pj_snr_brnch_main_url: -// qi shields -:pj_qi_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_tsd_url: {cm_shlds_notsupp_url} -:pj_qi_tests_url: {cm_shlds_notsupp_url} -:pj_qi_coverage_url: {cm_shlds_notsupp_url} -:pj_qi_violations_url: {cm_shlds_notsupp_url} -// qi sonar -:pj_qi_snr_brnch1_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_brnch2_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_qgate_url: {cm_shlds_notsupp_url} -:pj_qi_snr_logo_url: {cm_shlds_notsupp_url} -// ti sonar -:pj_ti_snr_brnch1_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tsd_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_tests_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch1_violations_url: {cm_shlds_notsupp_url} -:pj_ti_snr_brnch2_violations_url: {cm_shlds_notsupp_url} -endif::[] -// sonar - END -// codacy - START -ifeval::["{pj_cdcy_id}" != "-1"] -:cm_cdcy_url: https://www.codacy.com -:cm_cdcy_app: https://app.codacy.com -:cm_cdcy_badge_grade_url: {cm_cdcy_app}/project/badge/Grade -:cm_cdcy_badge_coverage_url: {cm_cdcy_app}/project/badge/Coverage -:cm_cdcy_dash_gh_url: {cm_cdcy_app}/gh - -// shields for codacy -:cm_shlds_cdcy_url: {cm_shlds_url}/codacy -:cm_shlds_cdcy_logo: logo=codacy -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_cdcy_grade_url: {cm_shlds_cdcy_url}/grade -:cm_shlds_cdcy_coverage_url: {cm_shlds_cdcy_url}/coverage -:cm_shlds_tool_cdcy_url: {cm_shlds_badge_url}/codacy-oGlow_Rulset{cm_shlds_tool_style}&logo=codacy -:cm_shlds_tool_cdcy_img: image:{cm_shlds_tool_cdcy_url}[title="Codacy Quality Gateway"] - -// project settings (generated) -// module data generated -:pj_cdcy_vcsid: {pj_gh_vcsid} - -// quality information -// qi codacy -:pj_cdcy_vcsid_url: {cm_cdcy_dash_gh_url}/{pj_cdcy_vcsid}/dashboard -:pj_cdcy_branch1_url: {pj_cdcy_vcsid_url}?branch={brnch1} -:pj_cdcy_branch2_url: {pj_cdcy_vcsid_url}?branch={brnch2} -:pj_qi_cdcy_badge_grade_url: {cm_cdcy_badge_grade_url}/{pj_cdcy_id} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_cdcy_grade_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_badge_coverage_url: {cm_cdcy_badge_coverage_url}/{pj_cdcy_id} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch1}?{cm_shlds_cdcy_style} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_cdcy_coverage_url}/{pj_cdcy_id}/{brnch2}?{cm_shlds_cdcy_style} -endif::[] -ifeval::["{pj_cdcy_id}" == "-1"] -// shields for codacy -:cm_shlds_tool_cdcy_url: -:cm_shlds_tool_cdcy_img: -// qi codacy -:pj_cdcy_vcsid_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch1_url: {cm_shlds_notsupp_url} -:pj_cdcy_branch2_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_badge_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch1_grade_url: {cm_shlds_notsupp_url} -:pj_qi_cdcy_brnch2_grade_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_badge_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cdcy_brnch2_coverage_url: {cm_shlds_notsupp_url} -endif::[] -// codacy - END -//coveralls - START -ifeval::["{pj_cvrlls_id}" != "-1"] -:cm_cvrlls_url: https://coveralls.io -:cm_cvrlls_dash_gh_url: {cm_cvrlls_url}/github -:cm_cvrlls_repos_gh_url: {cm_cvrlls_url}/repos/github - -// shields for coveralls -:cm_shlds_cvrlls_url: {cm_shlds_url}/coveralls/github -:cm_shlds_cvrlls_logo: logo=coveralls -:cm_shlds_cvrlls_style: &{cm_shlds_cvrlls_logo}{cm_shlds_img_style} -:cm_shlds_tool_cvrlls_url: {cm_shlds_badge_url}/coveralls-Coverage{cm_shlds_tool_style}&logo=coveralls -:cm_shlds_tool_cvrlls_img: image:{cm_shlds_tool_cvrlls_url}[title="Coveralls Coverage"] -// project settings (generated) -// module data generated -:pj_cvrlls_vcsid: {pj_cvrlls_id} - -// test information -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid} -:pj_cvrlls_brnch1_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch1} -:pj_cvrlls_brnch2_dash_gh_url: {cm_cvrlls_dash_gh_url}/{pj_cvrlls_vcsid}?branch={brnch2} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch1} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_cvrlls_repos_gh_url}/{pj_cvrlls_vcsid}/badge.svg?branch={brnch2} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch1}?{cm_shlds_cvrlls_style} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_cvrlls_url}/{pj_cvrlls_vcsid}/{brnch2}?{cm_shlds_cvrlls_style} -endif::[] -ifeval::["{pj_cvrlls_id}" == "-1"] -// shields for coveralls -:cm_shlds_tool_cvrlls_url: -:cm_shlds_tool_cvrlls_img: -// ti coveralls -:pj_cvrlls_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch1_dash_gh_url: {cm_shlds_notsupp_url} -:pj_cvrlls_brnch2_dash_gh_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_coverage_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch1_status_url: {cm_shlds_notsupp_url} -:pj_ti_cvrlls_brnch2_status_url: {cm_shlds_notsupp_url} -endif::[] -//coveralls - END -// phpcodesniffer - START -:cm_phpcs_url: https://github.com/PHPCSStandards/PHP_CodeSniffer - -// shields for phpcodesniffer -:cm_shlds_phpcs_url: {cm_shlds_url}/phpcodesniffer -:cm_shlds_cdcy_logo: logo=php -:cm_shlds_cdcy_style: &{cm_shlds_cdcy_logo}{cm_shlds_img_style} -:cm_shlds_tool_phpcs_url: {cm_shlds_badge_url}/php_codesniffer-PSR2_&_PSR12{cm_shlds_tool_style}&logo=php -// phpcodesniffer - END -// openssf - START -ifeval::["{pj_opnssf_id}" != "-1"] -:cm_opnssf_url: https://www.bestpractices.dev -:cm_opnssf_badge_url: {cm_opnssf_url}/projects -:cm_opnssf_dash_url: {cm_opnssf_url}/projects - -// project settings (generated) -// module data generated -:pj_opnssf_vcsid: {pj_opnssf_id} - -// quality information -// qi openssf -:pj_opnssf_dash_url: {cm_opnssf_dash_url}/{pj_opnssf_vcsid} -:pj_qi_opnssf_status_url: {cm_opnssf_badge_url}/{pj_opnssf_vcsid}/badge -endif::[] -ifeval::["{pj_opnssf_id}" == "-1"] -:pj_opnssf_dash_url: {cm_shlds_notsupp_url} -:pj_qi_opnssf_status_url: {cm_shlds_notsupp_url} -endif::[] -// openssf - END -// common settings - END - -:source-highlighter: highlight.js - -= {pj_gh_repo} - Examples -:toc: -:toclevels: 2 - -== PHPUnit - -=== ConstantCheckTestCase - -.Constants cross check -[source,php] ----- -o2t; - } - - public function testFoo(): void - { - $this->logger->debug('testFoo() - Start'); - - // test code - static::assertTrue($this->getCasto2t()->isValid()); - // or - static::assertTrue($this->o2t->isValid()); - - $this->logger->info('testFoo() - End'); - } -} ----- - -.Log output -[source,text] ----- -20250821-162846.609 [DEBUG ] PHPUnit\Framework\EasyGoingTestCase->testFoo() - testFoo() - Start -20250821-162846.611 [INFO ] PHPUnit\Framework\EasyGoingTestCase->testFoo() - testFoo() - End -.. ----- - -== Reflection - -=== ChildClazzesHelper - -.getAllChildren -[source,php] ----- - ErrorException - [1] => ClosedGeneratorException - [2] => JsonException - [3] => LogicException - [4] => BadFunctionCallException - [5] => BadMethodCallException - [6] => DomainException - [7] => InvalidArgumentException - [8] => LengthException - [9] => OutOfRangeException - [10] => RuntimeException - [11] => OutOfBoundsException - [12] => OverflowException - [13] => RangeException - [14] => UnderflowException - [15] => UnexpectedValueException - [16] => ReflectionException - [17] => DOMException - [18] => PDOException - [19] => IntlException - [20] => mysqli_sql_exception - [21] => PharException - [22] => SoapFault -) ----- - -=== UnavailableFieldsTrait / UnavailableMethodsTrait - -.Extended class example -[source,php] ----- -o2t; - } - - public function testPrivateField(): void - { - $result = $this->getFieldFromO2t('privateFoo'); - // or - $result2 = $this->getFieldByReflection(FooClazz::class, 'privateFoo', $this->o2t); - $this->logger->info("privateFoo is '${result}' or '${result2}'"); - - static::assertEquals('privateFooValue', $result); - static::assertEquals($result, $result2); - } - - public function testProtectedMethod(): void - { - $result = $this->callMethodOnO2t('protectedFoo'); - // or - $result2 = $this->callMethodByReflection(FooClazz::class, 'protectedFoo', $this->o2t); - $this->logger->info("protectedFoo returns '${result}' or '${result2}'"); - - static::assertEquals('protectedFooMethod', $result); - static::assertEquals($result, $result2); - } -} ----- - -.Log output -[source,text] ----- -20250821-162846.588 [INFO ] PHPUnit\Framework\EasyGoingTestCase->testPrivateField() - privateFoo is 'privateFooValue' or 'privateFooValue' -20250821-162846.608 [INFO ] PHPUnit\Framework\EasyGoingTestCase->testProtectedMethod() - protectedFoo returns 'protectedFooMethod' or 'protectedFooMethod' -.. ----- - -== Tasklist - -.Tasklist / Taskitem -[source,php] ----- -implode_recursive(',', $array, true, true); - print_r($actual, false); - } - - public function func_af($anyData) { - print_r($anyData, false); - $actual = $this->array_flatten($anyData, 0); - print_r($actual, false); - } - } - - $instance = new Example(); - $instance->func_ir([1, [2, ['a', 'b'], 3], 4]); - $instance->func_af([1, [2, ['a', 'b'], 3], 4]); ----- - -.Log output -[source,text] ----- -Array -( - [0] => 1 - [1] => Array - ( - [0] => 2 - [1] => Array - ( - [0] => a - [1] => b - ) - - [2] => 3 - ) - - [2] => 4 -) -0=>"1",1=>[0=>"2",1=>[0=>"a",1=>"b"],2=>"3"],2=>"4"Array -( - [0] => 1 - [1] => Array - ( - [0] => 2 - [1] => Array - ( - [0] => a - [1] => b - ) - - [2] => 3 - ) - - [2] => 4 -) -Array -( - [0] => 1 - [1] => 2 - [2] => a - [3] => b - [4] => 3 - [5] => 4 -) ----- - -=== ToStringTrait - -.__toString() -[source,php] ----- -__toString(), false); ----- - -.Log output -[source,text] ----- -ollily\Example Object -( - [value1:ollily\Example:private] => 1 - [list:ollily\Example:private] => Array - ( - ) - -) -{ollily\Example Object -( - [value1:ollily\Example:private] => 1 - [list:ollily\Example:private] => Array - ( - ) - -) -} ----- - -=== EnvironmentVariableTrait - -.Environment variables -[source,php] ----- -show(); - ----- - -.Log output -[source,text] ----- -C:\Users\**** -C:\**\ezkoding ----- - -=== PhpVersionTrait - -.PHP version -[source,php] ----- -isPhpGreater($checkVersion); - } - } - - $instance = new Example(); - var_dump($instance->isGreater('1.0.0')); - var_dump($instance->isGreater('99.99.999')); ----- - -.Log output -[source,text] ----- -ezkoding\src\Example.php:19: -bool(true) -ezkoding\src\Example.php:20: -bool(false) ----- - -=== StopNow - -.stop / stopException -[source,php] ----- -verify(true); - $instance->verify(false); - $instance->emergencyStop(); ----- - -.Log output -[source,text] ----- -Verification ok! -20260508-195933.740 [EMERGENCY] ollily\Tools\StopNow->stop() - Error Message [100] ----- diff --git a/nbproject/project.properties b/nbproject/project.properties index 9421944..fc2fb11 100644 --- a/nbproject/project.properties +++ b/nbproject/project.properties @@ -21,16 +21,17 @@ auxiliary.org-netbeans-modules-javascript2-requirejs.enabled=true auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_create_2e_tests=false auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_enabled=false auxiliary.org-netbeans-modules-php-phpunit.bootstrap_2e_path=tests/bootstrap.php -auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_enabled=true +auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_enabled=false auxiliary.org-netbeans-modules-php-phpunit.configuration_2e_path=phpunit.xml.dist auxiliary.org-netbeans-modules-php-phpunit.customSuite_2e_enabled=false auxiliary.org-netbeans-modules-php-phpunit.customSuite_2e_path= -auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_enabled=true +auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_enabled=false auxiliary.org-netbeans-modules-php-phpunit.phpUnit_2e_path=vendor/bin/phpunit.bat auxiliary.org-netbeans-modules-php-phpunit.relativePath_2e_enabled=false auxiliary.org-netbeans-modules-php-phpunit.test_2e_groups_2e_ask=false auxiliary.org-netbeans-modules-php-phpunit.test_2e_run_2e_all=false auxiliary.org-netbeans-modules-php-phpunit.test_2e_run_2e_phpunit_2e_only=false +auxiliary.org-netbeans-modules-php-smarty.smarty-framework=false auxiliary.org-netbeans-modules-web-clientproject-api.js_2e_libs_2e_folder=js/libs auxiliary.org-netbeans-modules-php-phpunit.test_2e_run_2e_phpunit_2e_only=false browser.reload.on.save=true @@ -77,51 +78,14 @@ file.reference.vendor-theseer=vendor/theseer file.reference.vendor-tivie=vendor/tivie file.reference.vendor-vimeo=vendor/vimeo file.reference.vendor-webmozart=vendor/webmozart -ignore.path= +ignore.path=\ + ${file.reference.ezkoding-vendor} include.path=\ - ${php.global.include.path}:\ - ${file.reference.vendor-amphp}:\ - ${file.reference.vendor-bin}:\ - ${file.reference.vendor-clue}:\ - ${file.reference.vendor-composer}:\ - ${file.reference.vendor-crysalead}:\ - ${file.reference.vendor-danieljharvey}:\ - ${file.reference.vendor-dnoegel}:\ - ${file.reference.vendor-doctrine}:\ - ${file.reference.vendor-ergebnis}:\ - ${file.reference.vendor-evenement}:\ - ${file.reference.vendor-felixfbecker}:\ - ${file.reference.vendor-fidry}:\ - ${file.reference.vendor-friendsofphp}:\ - ${file.reference.vendor-justinrainbow}:\ - ${file.reference.vendor-marc-mabe}:\ - ${file.reference.vendor-myclabs}:\ - ${file.reference.vendor-netresearch}:\ - ${file.reference.vendor-nikic}:\ - ${file.reference.vendor-pdepend}:\ - ${file.reference.vendor-phar-io}:\ - ${file.reference.vendor-php-ds}:\ - ${file.reference.vendor-phpdocumentor}:\ - ${file.reference.vendor-phpmd}:\ - ${file.reference.vendor-phpstan}:\ - ${file.reference.vendor-phpunit}:\ - ${file.reference.vendor-psalm}:\ - ${file.reference.vendor-psr}:\ - ${file.reference.vendor-react}:\ - ${file.reference.vendor-rogervila}:\ - ${file.reference.vendor-sebastian}:\ - ${file.reference.vendor-seld}:\ - ${file.reference.vendor-spatie}:\ - ${file.reference.vendor-squizlabs}:\ - ${file.reference.vendor-symfony}:\ - ${file.reference.vendor-theseer}:\ - ${file.reference.vendor-tivie}:\ - ${file.reference.vendor-vimeo}:\ - ${file.reference.vendor-webmozart} + ${php.global.include.path} php.version=PHP_84 project.license=apache20 source.encoding=UTF-8 -src.dir=src +src.dir=. tags.asp=false tags.short=false test.src.dir=${file.reference.ezkoding-tests} diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 0000000..15a1a0c --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,37 @@ + + + Yet Another COnfluence REST-API + + target/docs + target/build/cache + + + latest + + + src + + + ./target/docs/api + oglow + + php + + + XYZ + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Monolog/EasyGoingLogger.php b/src/Monolog/EasyGoingLogger.php index 8d51ed4..00c21ab 100644 --- a/src/Monolog/EasyGoingLogger.php +++ b/src/Monolog/EasyGoingLogger.php @@ -20,11 +20,13 @@ class EasyGoingLogger { - private const string LOGGER_DEFAULT = 'Monolog\Logger'; + public const string DEFAULT_LEVEL = LogLevel::INFO; - private const string LOGGER_CONSOLE = 'Monolog\ConsoleLogger'; + public const string LOGGER_DEFAULT = 'Monolog\Logger'; - private const string LOGGER_NULL = 'Psr\Log\NullLogger'; + public const string LOGGER_CONSOLE = 'Monolog\ConsoleLogger'; + + public const string LOGGER_NULL = 'Psr\Log\NullLogger'; private function __construct() { @@ -38,16 +40,18 @@ private function __construct() * @param array $processors * @param ?DateTimeZone $timezone * + * @return LoggerInterface + * * @psalm-suppress InvalidNullableReturnType */ public static function init( string $name, - string $level = LogLevel::INFO, + string $level = self::DEFAULT_LEVEL, array $handlers = [], array $processors = [], ?DateTimeZone $timezone = null ): LoggerInterface { - /** @psalm-var class-string */ + /** @phpstan-var class-string */ $clazzName = self::LOGGER_NULL; if (class_exists(self::LOGGER_CONSOLE)) { $clazzName = self::LOGGER_CONSOLE; @@ -66,7 +70,7 @@ public static function init( if (is_null($refClazz->getConstructor())) { $instance = $refClazz->newInstance(); } else { - $instance = $refClazz->newInstance($name, $level, $handlers, $processors, $timezone); + $instance = $refClazz->newInstance($name, $handlers, $processors, $timezone, $level); } } catch (\ReflectionException $refExp) { Emergency::exceptionStop($refExp); diff --git a/src/PHPUnit/Framework/EasyGoingTestCase.php b/src/PHPUnit/Framework/EasyGoingTestCase.php index 2b6cfa3..efa8570 100644 --- a/src/PHPUnit/Framework/EasyGoingTestCase.php +++ b/src/PHPUnit/Framework/EasyGoingTestCase.php @@ -18,15 +18,15 @@ abstract class EasyGoingTestCase extends TestCase { - /** var string Separator for static access */ + /** Separator for static access */ public const string C_STATIC_SEP = '::'; - /** @var string All primitive datatypes */ + /** All primitive datatypes */ protected const string C_PRIMITIVES = 'int|integer|bool|boolean|float'; private static LoggerInterface $logger; - /** @var mixed The object which will be tested. */ + /** The object which will be tested. */ protected mixed $o2t; /** @@ -198,10 +198,7 @@ protected function get_called_function(): string try { $debug = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2); - /** @psalm-suppress RedundantCondition - * @phpstan-ignore function.alreadyNarrowedType - */ - if (is_array($debug) && !empty($debug)) { + if (!empty($debug)) { $calledFunction = $debug[1]['function']; } } catch (\Exception $exception) { diff --git a/tests/Tools/Test/TestDataTest.php b/tests/Tools/Test/TestDataTest.php index 947dd4b..2bbc955 100644 --- a/tests/Tools/Test/TestDataTest.php +++ b/tests/Tools/Test/TestDataTest.php @@ -17,9 +17,6 @@ use PHPUnit\Framework\Attributes\Depends; use PHPUnit\Framework\TestCase; -/** - * @SuppressWarnings("PHPMD.UnusedFormalParameter") - */ class TestDataTest extends TestCase { private static string $fileName; @@ -68,6 +65,12 @@ public function testConstantsArray(): void $this->verifyResult($expectedCount, 'array'); } + /** + * @SuppressWarnings("PHPMD.UnusedFormalParameter") + * + * @param int $expectedCount + * @param string $pivot + */ public function verifyResult(int $expectedCount, string $pivot): void { $refClazz = new \ReflectionClass(TestData::class); diff --git a/usage.adoc b/usage.adoc deleted file mode 100644 index 1eeca77..0000000 --- a/usage.adoc +++ /dev/null @@ -1,29 +0,0 @@ -There are several classes which can be used for your development. - -=== PHPUnit - -* link:src/PHPUnit/Framework/EasyGoingTestCase.php[EasyGoingTestCase] - All you need is already prepared, so concentrate on unit tests -* link:src/PHPUnit/Framework/ConstantCheckTestCase.php[ConstantCheckTestCase] - Additionally there is a check, if all constants are correct defined - -=== Tasklist - -* link:src/Tools/Batch/BatchTaskHelper.php[BatchTaskHelper] - Utility class for working the tasklist -* link:src/Tools/Batch/TaskItem.php[TaskItem] - A single task -* link:src/Tools/Batch/TaskList.php[TaskList] - A complete tasklist (queue) - -=== Reflection - -* link:src/Tools/Reflection/ChildClazzesHelper.php[ChildClazzesHelper] - Utility clazz for working with children classes -* link:src/Tools/Reflection/UnavailableFieldsTrait.php[UnavailableFieldsTrait] - Get value from unaccessable class fields (aka properties) -* link:src/Tools/Reflection/UnavailableMethodsTrait.php[UnavailableMethodsTrait] - Call unaccessable class methods - -=== String - -* link:src/Tools/String/ImplodeTrait.php[ImplodeTrait] - Implode multidimensional arrays to a flat array or string -* link:src/Tools/String/ToStringTrait.php[ToStringTrait] - Provides a standard implementation for function '__toString()' - -=== Tools - -* link:src/Tools/EnvironmentVariableTrait.php[EnvironmentVariableTrait] - Provides access to environment settings -* link:src/Tools/PhpVersionTrait.php[PhpVersionTrait] - Handles the check for PHP versions -* link:src/Tools/Emergency.php[StopNow] - Stops a process immediatly, thx to K.I.T.T.