diff --git a/.ddev/config.yaml b/.ddev/config.yaml index 584d5c4..67f843d 100644 --- a/.ddev/config.yaml +++ b/.ddev/config.yaml @@ -14,6 +14,7 @@ hooks: - exec: bash .ddev/setup.sh use_dns_when_possible: true composer_version: "2" +composer_root: siteimprove-accessibility web_environment: [] corepack_enable: false diff --git a/.ddev/setup.sh b/.ddev/setup.sh index 893cda7..9e3a240 100755 --- a/.ddev/setup.sh +++ b/.ddev/setup.sh @@ -27,7 +27,6 @@ wp plugin activate siteimprove-accessibility # Install land activate additional plugins for development environment wp plugin install debug-bar wp plugin install query-monitor -wp plugin install siteimprove cd /var/www/html echo "Setup completed." \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0aa0731..8ef8f89 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,7 +19,7 @@ jobs: curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer - name: Install PHP_CodeSniffer - run: composer install --prefer-dist --no-progress --no-suggest + run: composer install --working-dir=./siteimprove-accessibility --prefer-dist --no-progress --no-suggest - name: Check PHP Code Sniff run: ./siteimprove-accessibility/vendor/bin/phpcs siteimprove-accessibility --standard=phpcs.xml.dist --report-summary diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 98cbb63..2fd252a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -21,7 +21,7 @@ jobs: curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer - name: Install Composer dependencies - run: composer install --no-dev --prefer-dist --no-progress --no-suggest + run: composer install --working-dir=./siteimprove-accessibility --no-dev --prefer-dist --no-progress --no-suggest - name: Set up Node.js uses: actions/setup-node@v4 diff --git a/composer.json b/siteimprove-accessibility/composer.json similarity index 52% rename from composer.json rename to siteimprove-accessibility/composer.json index 36c510c..8754010 100644 --- a/composer.json +++ b/siteimprove-accessibility/composer.json @@ -1,7 +1,11 @@ { + "name": "siteimprove/siteimprove-accessibility", + "description": "WordPress plugin for accessibility improvements.", + "license": "GPL-2.0-or-later", + "type": "wordpress-plugin", "autoload": { "psr-4": { - "Siteimprove\\Accessibility\\": "siteimprove-accessibility/src/" + "Siteimprove\\Accessibility\\": "src/" } }, "require": { @@ -13,13 +17,12 @@ "phpcsstandards/phpcsutils": "^1.0" }, "config": { - "vendor-dir": "./siteimprove-accessibility/vendor", "allow-plugins": { "dealerdirect/phpcodesniffer-composer-installer": true } }, "scripts": { - "lint": "./siteimprove-accessibility/vendor/bin/phpcs siteimprove-accessibility --standard=phpcs.xml.dist", - "lint-fix": "./siteimprove-accessibility/vendor/bin/phpcbf siteimprove-accessibility --standard=phpcs.xml.dist" + "lint": "./vendor/bin/phpcs . --standard=../phpcs.xml.dist", + "lint-fix": "./vendor/bin/phpcbf . --standard=../phpcs.xml.dist" } } diff --git a/composer.lock b/siteimprove-accessibility/composer.lock similarity index 94% rename from composer.lock rename to siteimprove-accessibility/composer.lock index 6bdd003..75e0f31 100644 --- a/composer.lock +++ b/siteimprove-accessibility/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": "ade89283ff8ce0aced0609473e51047f", + "content-hash": "df1bd088ca4d3d83afea67d873be18c4", "packages": [], "packages-dev": [ { @@ -87,22 +87,22 @@ }, { "name": "phpcsstandards/phpcsextra", - "version": "1.2.1", + "version": "1.3.0", "source": { "type": "git", "url": "https://github.com/PHPCSStandards/PHPCSExtra.git", - "reference": "11d387c6642b6e4acaf0bd9bf5203b8cca1ec489" + "reference": "46d08eb86eec622b96c466adec3063adfed280dd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHPCSStandards/PHPCSExtra/zipball/11d387c6642b6e4acaf0bd9bf5203b8cca1ec489", - "reference": "11d387c6642b6e4acaf0bd9bf5203b8cca1ec489", + "url": "https://api.github.com/repos/PHPCSStandards/PHPCSExtra/zipball/46d08eb86eec622b96c466adec3063adfed280dd", + "reference": "46d08eb86eec622b96c466adec3063adfed280dd", "shasum": "" }, "require": { "php": ">=5.4", "phpcsstandards/phpcsutils": "^1.0.9", - "squizlabs/php_codesniffer": "^3.8.0" + "squizlabs/php_codesniffer": "^3.12.1" }, "require-dev": { "php-parallel-lint/php-console-highlighter": "^1.0", @@ -159,9 +159,13 @@ { "url": "https://opencollective.com/php_codesniffer", "type": "open_collective" + }, + { + "url": "https://thanks.dev/u/gh/phpcsstandards", + "type": "thanks_dev" } ], - "time": "2023-12-08T16:49:07+00:00" + "time": "2025-04-20T23:35:32+00:00" }, { "name": "phpcsstandards/phpcsutils", @@ -253,16 +257,16 @@ }, { "name": "squizlabs/php_codesniffer", - "version": "3.11.3", + "version": "3.12.2", "source": { "type": "git", "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git", - "reference": "ba05f990e79cbe69b9f35c8c1ac8dca7eecc3a10" + "reference": "6d4cf6032d4b718f168c90a96e36c7d0eaacb2aa" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/ba05f990e79cbe69b9f35c8c1ac8dca7eecc3a10", - "reference": "ba05f990e79cbe69b9f35c8c1ac8dca7eecc3a10", + "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/6d4cf6032d4b718f168c90a96e36c7d0eaacb2aa", + "reference": "6d4cf6032d4b718f168c90a96e36c7d0eaacb2aa", "shasum": "" }, "require": { @@ -329,11 +333,11 @@ "type": "open_collective" }, { - "url": "https://thanks.dev/phpcsstandards", + "url": "https://thanks.dev/u/gh/phpcsstandards", "type": "thanks_dev" } ], - "time": "2025-01-23T17:04:15+00:00" + "time": "2025-04-13T04:10:18+00:00" }, { "name": "wp-coding-standards/wpcs", diff --git a/siteimprove-accessibility/readme.txt b/siteimprove-accessibility/readme.txt index 78f0757..7e3939b 100644 --- a/siteimprove-accessibility/readme.txt +++ b/siteimprove-accessibility/readme.txt @@ -59,12 +59,19 @@ Accessibility checks are local and data is stored locally in your own WordPress = What third-party/external services this plugin use? = -The plugin uses SiteimproveAccessibilityCmsComponents library, loaded via CDN. It provides reusable React-based UI components for displaying issue details, issue lists, reports and more. -These components are designed to be integrated across different CMS platforms, including WordPress, to ensure consistency and reduce the need for custom UI development. +This plugin uses the following third-party/external services: -This plugin uses Pendo, to collect anonymous usage data such as which features of the plugin you are interacting with, but only with your explicit consent (e.g. when usage tracking is enabled in the plugin settings page). -This data helps us improve the plugin by understanding how users interact with its features. No personal or sensitive information is ever collected or stored. -More about Pendo: [privacy policy](https://www.pendo.io/legal/privacy-policy/). +1. **Siteimprove** + The plugin uses the [SiteimproveAccessibilityCmsComponents](https://cdn.siteimprove.net/cms/siteimprove-accessibility-cms-components-latest.js) javascript library, loaded via CDN. + It provides reusable React-based UI components for displaying issue details, issue lists, reports and more. + These components are designed to be integrated across different CMS platforms, including WordPress, to ensure consistency and reduce the need for custom UI development. + + The plugin also uses Siteimprove's open source accessibility conformance testing engine called [Alfa](https://alfa.siteimprove.com/). Some of its features that requires to connect to [Siteimprove API](https://api.siteimprove.com/) are currently not used in this plugin. + +3. **Pendo** + Pendo is used to collect anonymous usage data, such as which features of the plugin users are interacting with. Usage data collection is active only with the explicit consent of the administrator (e.g. when usage tracking is enabled in the plugin settings page). + This data helps us improve the plugin by understanding how users interact with its features. No personal or sensitive information is ever collected or stored. + More about Pendo: [privacy policy](https://www.pendo.io/legal/privacy-policy/). = Where can I find the development repository for this plugin? =