Merge pull request #92 from eea/develop

Release
eea · Aug 28, 2023 · 0a72a32 · 0a72a32
2 parents 3dc9248 + 749b6b6
commit 0a72a32
Show file tree

Hide file tree

Showing 21 changed files with 1,779 additions and 175 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [10.2.0](https://github.com/eea/volto-accordion-block/compare/10.1.1...10.2.0) - 28 August 2023
+
+#### :rocket: New Features
+
+- feat(accordion): improve a11n by providing aria-expanded and open close using spacebar on header [David Ichim - [`26951d9`](https://github.com/eea/volto-accordion-block/commit/26951d9f729b868658feba0971cd3c68fdb228be)]
+
+#### :hammer_and_wrench: Others
+
+- Release 10.2.0 [Alin Voinea - [`357dce5`](https://github.com/eea/volto-accordion-block/commit/357dce5d45f87b42f705f2a5d35d6e601168bb12)]
+- update test snapshot after latest a11n changes [David Ichim - [`12cc58f`](https://github.com/eea/volto-accordion-block/commit/12cc58fd5f8831f8daba4cf9b3d8bb0392a3c129)]
 ### [10.1.1](https://github.com/eea/volto-accordion-block/compare/10.1.0...10.1.1) - 23 August 2023
 
 #### :bug: Bug Fixes
@@ -137,16 +147,13 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :house: Internal changes
 
-- chore: [JENKINS] Remove alpha testing version [valentinab25 - [`83cfef7`](https://github.com/eea/volto-accordion-block/commit/83cfef72305789fe95c4d463956d446e934e37bd)]
-- chore: [JENKINS] Deprecate circularity website [valentinab25 - [`e8d2ff3`](https://github.com/eea/volto-accordion-block/commit/e8d2ff341ff2db8baec52b9e839e2ace6eee7c1a)]
 
 #### :hammer_and_wrench: Others
 
 - Release 8.1.0 [Alin Voinea - [`ae29f46`](https://github.com/eea/volto-accordion-block/commit/ae29f469e449d993f8a67a529acf61d1657b40a0)]
 - test: jest should look for addons in node_modules Refs #253277 [valentinab25 - [`d077684`](https://github.com/eea/volto-accordion-block/commit/d07768431760471c1d33352e097874dee37edd41)]
 - test: Add unit tests for util - refs #253277 [ana-oprea - [`9385394`](https://github.com/eea/volto-accordion-block/commit/9385394cf834dd944d98ab9fdc10e65abdad636d)]
 - test: Fix test config, coverage Refs #253277 [valentinab25 - [`67a0667`](https://github.com/eea/volto-accordion-block/commit/67a0667ee563e8ee01c5e660cd2b127eaa1da4fc)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`9c06bd0`](https://github.com/eea/volto-accordion-block/commit/9c06bd0f3d262bb553541ec884c659d31fea70d5)]
 ## [8.0.0](https://github.com/eea/volto-accordion-block/compare/7.1.0...8.0.0) - 24 March 2023
 
 #### :rocket: New Features
@@ -159,7 +166,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - test(cypress): Use latest stable Volto for tests [Alin Voinea - [`161325b`](https://github.com/eea/volto-accordion-block/commit/161325bfb990e1ef8bd66a7c26aacf17b5e3989c)]
 - Release 7.1.0 [Alin Voinea - [`207318f`](https://github.com/eea/volto-accordion-block/commit/207318f45321d9caf2e9e88a36786d6a6dfbfce6)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`a1279b2`](https://github.com/eea/volto-accordion-block/commit/a1279b20f134b8da44ca45e1e3eecf50401372f8)]
 ## [7.0.0](https://github.com/eea/volto-accordion-block/compare/6.0.0...7.0.0) - 7 February 2023
 
 #### :nail_care: Enhancements
@@ -171,12 +177,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Release 7.0.0 [Alin Voinea - [`661c6fd`](https://github.com/eea/volto-accordion-block/commit/661c6fd04aa704ba09172737f9e00e7de8b17673)]
 - theme-picker version [Andrei Grigore - [`2d7d7fb`](https://github.com/eea/volto-accordion-block/commit/2d7d7fb64b6f51fb02410140ae4b69eda26dea06)]
 - Add theme picker widget [dana-cfc4 - [`b567515`](https://github.com/eea/volto-accordion-block/commit/b5675150e1b5a811e1686404cbefcd9e6b92d515)]
-- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`dd14109`](https://github.com/eea/volto-accordion-block/commit/dd14109b3df7aee49ab1fdb57b8ac749193723c7)]
-- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`6169240`](https://github.com/eea/volto-accordion-block/commit/6169240953e8b81fbf1200bfa7b77c1be3be318f)]
 - test(Jenkins): Run tests and cypress with latest canary @plone/volto [Alin Voinea - [`bbf12a0`](https://github.com/eea/volto-accordion-block/commit/bbf12a07558ea1f2c9d6e62fa4bf897d1c27ad71)]
-- Add Sonarqube tag using cca-frontend addons list [EEA Jenkins - [`cb18b3c`](https://github.com/eea/volto-accordion-block/commit/cb18b3c7d12318a671e6031054cb6cb98c5e4766)]
-- yarn 3 [Alin Voinea - [`26994da`](https://github.com/eea/volto-accordion-block/commit/26994dab66bce3873911fee6fb46fc51dfce44d7)]
-- Add Sonarqube tag using demo-kitkat-frontend addons list [EEA Jenkins - [`5803993`](https://github.com/eea/volto-accordion-block/commit/5803993b263352f7d3a5e4c14f5ac5b1607a1dc2)]
 ## [6.0.0](https://github.com/eea/volto-accordion-block/compare/5.0.0...6.0.0) - 16 November 2022
 
 #### :nail_care: Enhancements
@@ -206,7 +207,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using marine-frontend addons list [EEA Jenkins - [`3c0236e`](https://github.com/eea/volto-accordion-block/commit/3c0236ef0e055bbbac852b66139767cee8631aad)]
 - test(cypress): Add missing md5 dependency [Alin Voinea - [`1afae5d`](https://github.com/eea/volto-accordion-block/commit/1afae5d677de53778d5727334f9a6add8120d046)]
 ## [4.0.0](https://github.com/eea/volto-accordion-block/compare/3.5.0...4.0.0) - 27 September 2022
 
@@ -224,14 +224,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Release 3.6.0 [Alin Voinea - [`2c84012`](https://github.com/eea/volto-accordion-block/commit/2c840125496e23e1f1587e9e1ba2713ef538491e)]
 - test(prettier): Fix stylelint [Alin Voinea - [`e3fd717`](https://github.com/eea/volto-accordion-block/commit/e3fd717b60d67a09b500282837470707f57747a1)]
 - Use [email protected] in cypress tests [Miu Razvan - [`f4dd7a1`](https://github.com/eea/volto-accordion-block/commit/f4dd7a1221ef2437b813d45b232efbf8c04bb8c5)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`20652bc`](https://github.com/eea/volto-accordion-block/commit/20652bcea7bd1f4f7271cf0b2fe8223401401a4f)]
 - update(jest): add @plone/volto-slate resolver refs- #153447 [nileshgulia1 - [`7a1af55`](https://github.com/eea/volto-accordion-block/commit/7a1af55061b0c75ecb77fdbae9e2e6586df3b50c)]
 ### [3.5.0](https://github.com/eea/volto-accordion-block/compare/3.4.16...3.5.0) - 30 June 2022
 
 #### :hammer_and_wrench: Others
 
 - Release 3.5.0 [Alin Voinea - [`c237343`](https://github.com/eea/volto-accordion-block/commit/c237343daa82eb0fb0ddb49e04ee6c49578b8fd2)]
-- Add Sonarqube tag using circularity-frontend addons list [EEA Jenkins - [`5de2964`](https://github.com/eea/volto-accordion-block/commit/5de296427472925998273bf9c164ba5b65895a14)]
 ### [3.4.16](https://github.com/eea/volto-accordion-block/compare/3.4.15...3.4.16) - 17 May 2022
 
 #### :hammer_and_wrench: Others
@@ -241,8 +239,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using clms-frontend addons list [EEA Jenkins - [`66fada5`](https://github.com/eea/volto-accordion-block/commit/66fada5a7084e1adb36ef5ff950d498391729eab)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`9d96b9d`](https://github.com/eea/volto-accordion-block/commit/9d96b9d392004dd8791c061c5fa39deee253c16a)]
 ### [3.4.14](https://github.com/eea/volto-accordion-block/compare/3.4.13...3.4.14) - 3 March 2022
 
 #### :rocket: New Features
@@ -266,7 +262,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using freshwater-frontend addons list [EEA Jenkins - [`197c242`](https://github.com/eea/volto-accordion-block/commit/197c2426f18e3b74296c18ef86781e63596bcd4b)]
 ### [3.4.10](https://github.com/eea/volto-accordion-block/compare/3.4.9...3.4.10) - 10 December 2021
 
 #### :hammer_and_wrench: Others
@@ -285,14 +280,11 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - cy: make tests run with both slate and draftjs [nileshgulia1 - [`e51f7a5`](https://github.com/eea/volto-accordion-block/commit/e51f7a5c36804240d90e19baa9c7b321e41a7c23)]
-- Add Sonarqube tag using industry-frontend addons list [EEA Jenkins - [`9f515c3`](https://github.com/eea/volto-accordion-block/commit/9f515c3e1055b07ea5ea7ac8dbf72eb2e4b79c74)]
 ### [3.4.7](https://github.com/eea/volto-accordion-block/compare/3.4.6...3.4.7) - 25 October 2021
 
 #### :hammer_and_wrench: Others
 
 - Refs #34 ensure floated images from content area don't spill over next accordion title [David Ichim - [`79abc8c`](https://github.com/eea/volto-accordion-block/commit/79abc8c1b13eb26fb78b9dbe53fc2711c02a1ed1)]
-- Add Sonarqube tag using clms-frontend addons list [EEA Jenkins - [`f5c2cf9`](https://github.com/eea/volto-accordion-block/commit/f5c2cf969763a5400e4d9fb66bafad761cd17f2f)]
-- Add Sonarqube tag using bise-frontend addons list [EEA Jenkins - [`92cd189`](https://github.com/eea/volto-accordion-block/commit/92cd1891291a33e92c1f4488ff2afb90642d2706)]
 ### [3.4.6](https://github.com/eea/volto-accordion-block/compare/3.4.5...3.4.6) - 6 October 2021
 
 #### :house: Internal changes
@@ -301,7 +293,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using sustainability-frontend addons list [EEA Jenkins - [`c0bc59d`](https://github.com/eea/volto-accordion-block/commit/c0bc59d897ece309834ffef8ddea516aceef1e5f)]
 ### [3.4.5](https://github.com/eea/volto-accordion-block/compare/3.4.4...3.4.5) - 29 September 2021
 
 #### :hammer_and_wrench: Others
@@ -313,7 +304,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using climate-energy-frontend addons list [EEA Jenkins - [`046f3aa`](https://github.com/eea/volto-accordion-block/commit/046f3aae09e1725d44bcdc371d07ed32e8309423)]
 ### [3.4.3](https://github.com/eea/volto-accordion-block/compare/3.4.2...3.4.3) - 17 September 2021
 
 ### [3.4.2](https://github.com/eea/volto-accordion-block/compare/3.4.1...3.4.2) - 16 September 2021
@@ -323,7 +313,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - Add missing onChangeField to make it work with Metadata section block - refs #137434 [Alin Voinea - [`5253b74`](https://github.com/eea/volto-accordion-block/commit/5253b74a52043a3ad7e2e813abaf2d27f0e83a7a)]
-- Add Sonarqube tag using ims-frontend addons list [EEA Jenkins - [`1e4d3dc`](https://github.com/eea/volto-accordion-block/commit/1e4d3dc937bc63825bd1fc6156eca9b6d073a40b)]
 ### [3.4.0](https://github.com/eea/volto-accordion-block/compare/3.3.1...3.4.0) - 7 September 2021
 
 #### :hammer_and_wrench: Others
@@ -336,7 +325,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - Release 3.3.0 [Alin Voinea - [`2cbb1d5`](https://github.com/eea/volto-accordion-block/commit/2cbb1d53ce62b9cb42751c4c4997577ba4165649)]
-- Add Sonarqube tag using forests-frontend addons list [EEA Jenkins - [`ab257ac`](https://github.com/eea/volto-accordion-block/commit/ab257acb0c2c8e38b906fcce8f6e148e4690d473)]
 ### [3.2.4](https://github.com/eea/volto-accordion-block/compare/3.2.3...3.2.4) - 21 July 2021
 
 ### [3.2.3](https://github.com/eea/volto-accordion-block/compare/3.2.2...3.2.3) - 27 May 2021
@@ -463,7 +451,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - remove unused vars [nileshgulia1 - [`5e2c1e9`](https://github.com/eea/volto-accordion-block/commit/5e2c1e990f5ccf9b81f123ff18cacc7769ac696c)]
 - accordion title, via Input (semantic ui) [nileshgulia1 - [`0b2aef7`](https://github.com/eea/volto-accordion-block/commit/0b2aef76dd828ef2e0fc5061023a259d6279c11c)]
 - add accordion title as a slate editor [nileshgulia1 - [`38e841d`](https://github.com/eea/volto-accordion-block/commit/38e841d9a1a2d1d6a9d657ed6d611220615cbd40)]
-- yarn prettier [Alin Voinea - [`afc2d37`](https://github.com/eea/volto-accordion-block/commit/afc2d379490cc4bdd4e2c2296229fac5d549d6a1)]
 - make title editable [nileshgulia1 - [`e3233b0`](https://github.com/eea/volto-accordion-block/commit/e3233b00f3e0e1b0ef240a035d4aca7384a23b3c)]
 ### 0.1.0 - 9 November 2020
 

diff --git a/DEVELOP.md b/DEVELOP.md
@@ -6,37 +6,37 @@
 
 1. Make sure you have `docker` and `docker compose` installed and running on your machine:
 
-    ```Bash
+    ```bash
     git clone https://github.com/eea/volto-accordion-block.git
     cd volto-accordion-block
     git checkout -b bugfix-123456 develop
     make
     make start
     ```
 
-1. Wait for `Volto started at 0.0.0.0:3000` meesage
+1. Wait for `Volto started at 0.0.0.0:3000` message
 
 1. Go to http://localhost:3000
 
 1.  Happy hacking!
 
-    ```Bash
+    ```bash
     cd src/addons/volto-accordion-block/
     ```
 
 ### Or add volto-accordion-block to your Volto project
 
-Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
+Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://6.docs.plone.org/volto/getting-started/install.html)
 
 1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
 
-    ```Bash
+    ```bash
     npm install -g yo @plone/generator-volto mrs-developer
     ```
 
 1.  Create new volto app
 
-    ```Bash
+    ```bash
     yo @plone/volto my-volto-project --addon @eeacms/volto-accordion-block --skip-install
     cd my-volto-project
     ```
@@ -56,51 +56,52 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-    ```Bash
-    make develop
+    ```bash
     yarn
     ```
 
 1.  Start backend
 
-    ```Bash
+    ```bash
     docker compose up backend
     ```
 
-    ...wait for backend to setup and start - `Ready to handle requests`:
+    ...wait for backend to set up and start - `Ready to handle requests`:
 
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend
 
-    ```BASH
+    ```bash
     yarn start
     ```
 
 1.  Go to http://localhost:3000
 
 1.  Happy hacking!
 
-    ```BASH
+    ```bash
     cd src/addons/volto-accordion-block/
     ```
 
+---
+
 ## Cypress
 
 To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
 
-You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend 
+You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
 project where you added `volto-accordion-block` to `mrs.developer.json`
 
 Go to:
 
-  ```BASH
+  ```bash
   cd src/addons/volto-accordion-block/
   ```
 
 Start:
 
-  ```Bash
+  ```bash
   make
   make start
   ```
@@ -109,12 +110,95 @@ This will build and start with Docker a clean `Plone backend` and `Volto Fronten
 
 Open Cypress Interface:
 
-  ```Bash
+  ```bash
   make cypress-open
   ```
 
 Or run it:
 
-  ```Bash
+  ```bash
   make cypress-run
   ```
+---
+
+## Prettier
+
+[Prettier](https://www.npmjs.com/package/prettier) is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it
+with its own rules that take the maximum line length into account, wrapping code when necessary.
+
+Run ``prettier`` linter, executing the following command:
+
+  ```bash
+  make prettier
+  ```
+
+To fix the ``prettier`` warnings, execute the following command:
+
+  ```bash
+  make prettier-fix
+  ```
+
+---
+
+## Eslint
+
+[ESLint](https://www.npmjs.com/package/eslint) is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
+
+Eslint should run just fine using the setup config from any Volto projects generated by `volto project generator`.
+
+If for some reason that doesn't work, and you need to manually install eslint,
+you can also use the following steps to install eslint.
+
+For installing ``eslint``, execute the following command:
+
+  ```bash
+  yarn add --dev eslint eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react-hooks eslint-plugin-import eslint-plugin-flowtype
+  ```
+
+For setting up ``eslint``, execute the following command:
+
+  ```bash
+  cp .project.eslintrc.js .eslintrc.js
+  ```
+
+Run ``eslint``, executing the following command:
+
+  ```bash
+  make lint
+  ```
+
+To fix the problems found by ``eslint``, execute the following command:
+
+  ```bash
+  make lint-fix
+  ```
+
+---
+
+## Stylelint
+
+[Stylelint](https://www.npmjs.com/package/stylelint) is a mighty CSS linter that helps you avoid errors and enforce conventions.
+
+For installing ``stylelint``, execute the following command:
+
+  ```bash
+  yarn add --dev stylelint
+  ```
+
+To run ``stylelint``, execute the following command:
+
+  ```bash
+  make stylelint
+  ```
+
+If you need to run ``stylelint`` on styles found in .overrides files, execute the following command:
+
+  ```bash
+  make stylelint-overrides
+  ```
+
+To auto fix the found issues by ``stylelint``, execute the following command:
+
+  ```bash
+  make stylelint-fix
+  ```