@eeacms/volto-slate-footnote 6.1.4 → 6.1.6

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+[ -n "$CI" ] && exit 0
+yarn lint-staged

package/CHANGELOG.md

@@ -4,6 +4,25 @@ 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).
 
+### [6.1.6](https://github.com/eea/volto-slate-footnote/compare/6.1.5...6.1.6) - 29 September 2023
+
+#### :house: Documentation changes
+
+- docs: Update README and DEVELOP [Alin Voinea - [`982fcbc`](https://github.com/eea/volto-slate-footnote/commit/982fcbc29cf82b428532138f948d9038b021b149)]
+
+### [6.1.5](https://github.com/eea/volto-slate-footnote/compare/6.1.4...6.1.5) - 19 September 2023
+
+#### :bug: Bug Fixes
+
+- fix: index not showing on diff - refs #257191 [dobri1408 - [`bd6eb19`](https://github.com/eea/volto-slate-footnote/commit/bd6eb197213e23420fdd2f185447cb92a8156fc9)]
+
+#### :house: Internal changes
+
+- style: lint-staged reorder in package.json [Alin Voinea - [`c618c3c`](https://github.com/eea/volto-slate-footnote/commit/c618c3c12a878cc87fb9c3fd658eeb5d1241e871)]
+
+#### :hammer_and_wrench: Others
+
+- test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`6886cf7`](https://github.com/eea/volto-slate-footnote/commit/6886cf796c58d38fcce7c515bda1d3586420a58a)]
 ### [6.1.4](https://github.com/eea/volto-slate-footnote/compare/6.1.3...6.1.4) - 1 September 2023
 
 #### :bug: Bug Fixes

package/DEVELOP.md

@@ -16,12 +16,14 @@
 
 1. Go to http://localhost:3000
 
-1.  Happy hacking!
+1. Initialize git hooks
 
     ```Bash
-    cd src/addons/volto-slate-footnote/
+    yarn prepare
     ```
 
+1. Happy hacking!
+
 ### Or add @eeacms/volto-slate-footnote 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/)
@@ -32,10 +34,7 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Create new volto app
 
-        yo @plone/volto my-volto-project \
-                          --workspace src/addons/volto-slate-footnote \
-                          --addon @eeacms/volto-slate-footnote \
-                          --skip-install
+        yo @plone/volto my-volto-project --addon @eeacms/volto-slate-footnote --skip-install
         cd my-volto-project
 
 1.  Add the following to `mrs.developer.json`:
@@ -51,17 +50,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        yarn develop
+        make develop
         yarn
 
 1.  Start backend
 
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone plone
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
 
     ...wait for backend to setup and start - `Ready to handle requests`:
 
-        docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend

package/Jenkinsfile

@@ -62,11 +62,17 @@ pipeline {
 
     stage('Tests') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-           not { changelog '.*^Automated release [0-9\\.]+$' }
-           branch 'master'
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              not { changelog '.*^Automated release [0-9\\.]+$' }
+              branch 'master'
+            }
           }
         }
       }
@@ -110,11 +116,17 @@ pipeline {
 
     stage('Integration tests') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-           not { changelog '.*^Automated release [0-9\\.]+$' }
-           branch 'master'
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              not { changelog '.*^Automated release [0-9\\.]+$' }
+              branch 'master'
+            }
           }
         }
       }
@@ -167,13 +179,19 @@ pipeline {
 
     stage('Report to SonarQube') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-            branch 'master'
-            allOf {
-              branch 'develop'
-              not { changelog '.*^Automated release [0-9\\.]+$' }
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              allOf {
+                branch 'develop'
+                not { changelog '.*^Automated release [0-9\\.]+$' }
+              }
+              branch 'master'
             }
           }
         }
@@ -199,10 +217,16 @@ pipeline {
 
     stage('SonarQube compare to master') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          branch 'develop'
-          not { changelog '.*^Automated release [0-9\\.]+$' }
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            branch 'develop'
+            not { changelog '.*^Automated release [0-9\\.]+$' }
+          }
         }
       }
       steps {

package/README.md

@@ -44,25 +44,25 @@ Go to http://localhost:3000
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
-    ```Bash
-    docker compose up backend
-    ```
+   ```Bash
+   docker compose up backend
+   ```
 
 1. Start Volto frontend
 
-- If you already have a volto project, just update `package.json`:
+* If you already have a volto project, just update `package.json`:
 
    ```JSON
    "addons": [
-      "@eeacms/volto-slate-footnote"
+       "@eeacms/volto-slate-footnote"
    ],
 
    "dependencies": {
-      "@eeacms/volto-slate-footnote": "*"
+       "@eeacms/volto-slate-footnote": "*"
    }
    ```
 
-1. If not, create one:
+* If not, create one:
 
    ```
    npm install -g yo @plone/generator-volto
@@ -70,7 +70,6 @@ Go to http://localhost:3000
    cd my-volto-project
    ```
 
-
 1. Install new add-ons and restart Volto:
 
    ```

package/cypress.config.js

@@ -2,12 +2,12 @@ const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
   viewportWidth: 1280,
-  defaultCommandTimeout: 8888,
+  defaultCommandTimeout: 5000,
   chromeWebSecurity: false,
   reporter: 'junit',
   video: true,
   retries: {
-    runMode: 8,
+    runMode: 1,
     openMode: 0,
   },
   reporterOptions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "6.1.4",
+  "version": "6.1.6",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -23,8 +23,31 @@
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "husky": "*",
+    "lint-staged": "*",
     "md5": "^2.3.0"
   },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx,json}": [
+      "make lint-fix",
+      "make prettier-fix"
+    ],
+    "src/**/*.{jsx}": [
+      "make i18n"
+    ],
+    "theme/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "theme/**/*.overrides": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.overrides": [
+      "make stylelint-fix"
+    ]
+  },
   "scripts": {
     "release": "release-it",
     "release-major-beta": "release-it major --preRelease=beta",
@@ -42,6 +65,7 @@
     "lint:fix": "make lint-fix",
     "i18n": "make i18n",
     "cypress:run": "make cypress-run",
-    "cypress:open": "make cypress-open"
+    "cypress:open": "make cypress-open",
+    "prepare": "husky install"
   }
 }

package/src/editor/SearchWidget.test.jsx

@@ -0,0 +1,10 @@
+import React from 'react';
+import renderer from 'react-test-renderer';
+import SearchWidget from './SearchWidget';
+describe('Test SearchWidget', () => {
+  it('check html content', () => {
+    const component = renderer.create(<SearchWidget />);
+    const json = component.toJSON();
+    expect(json).toMatchSnapshot();
+  });
+});

package/src/editor/__snapshots__/SearchWidget.test.jsx.snap

@@ -0,0 +1,72 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test SearchWidget check html content 1`] = `
+<div
+  id="blockform-fieldset-default"
+>
+  <div
+    className="ui segment attached"
+    fluid={true}
+  >
+    <div
+      className="ui fluid card"
+      onClick={[Function]}
+    >
+      <div
+        className="content"
+        fluid={true}
+      >
+        <div
+          className="header"
+        >
+          Citation
+        </div>
+        <div
+          className="description"
+          fluid={true}
+        >
+          <div
+            className="ui fluid search"
+            onBlur={[Function]}
+            onFocus={[Function]}
+            onMouseDown={[Function]}
+          >
+            <div
+              className="ui fluid right icon input"
+            >
+              <input
+                autoComplete="off"
+                className="prompt"
+                id="field-footnote"
+                onChange={[Function]}
+                onClick={[Function]}
+                tabIndex="0"
+                type="text"
+                value=""
+              />
+              <i
+                aria-hidden="true"
+                className="search icon"
+                onClick={[Function]}
+              />
+            </div>
+            <div
+              className="results transition"
+            >
+              <div
+                className="message empty"
+              >
+                <div
+                  className="header"
+                >
+                  No results found.
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

package/src/editor/render.jsx

@@ -1,4 +1,4 @@
-import React, { useEffect, useState } from 'react';
+import React from 'react';
 import { Popup, List } from 'semantic-ui-react';
 import { useEditorContext } from '@plone/volto-slate/hooks';
 import { getAllBlocksAndSlateFields } from '@eeacms/volto-slate-footnote/editor/utils';
@@ -24,71 +24,61 @@ export const FootnoteElement = (props) => {
   const { data = {} } = element;
   const { uid, zoteroId } = data;
   const editor = useEditorContext();
-  const [citationIndice, setCitationIndice] = useState(null); // list of indices to reference
-  const [citationRefId, setCitationRefId] = useState(null); // indice of element to be referenced
-  const initialFormData = useSelector((state) => state?.content?.data || {});
-
-  useEffect(() => {
-    const blockProps = editor?.getBlockProps ? editor.getBlockProps() : null;
-    const metadata = blockProps
-      ? blockProps.metadata || blockProps.properties
-      : extras?.metadata || {};
-    const blocks = getAllBlocksAndSlateFields(metadata);
-    const storeBlocks = getAllBlocksAndSlateFields(initialFormData);
 
-    const notesObjResult = isEmpty(metadata)
-      ? makeFootnoteListOfUniqueItems(storeBlocks)
-      : makeFootnoteListOfUniqueItems(blocks);
+  const initialFormData = useSelector((state) => state?.content?.data || {});
+  const blockProps = editor?.getBlockProps ? editor.getBlockProps() : null;
+  const metadata = blockProps
+    ? blockProps.metadata || blockProps.properties
+    : extras?.metadata || {};
+  const blocks = getAllBlocksAndSlateFields(metadata);
+  const storeBlocks = getAllBlocksAndSlateFields(initialFormData);
 
-    // will cosider zotero citations and footnote
-    // notesObjResult contains all zotero/footnote as unique, and contain refs for other zotero/footnote
-    const indiceIfZoteroId = data.extra
-      ? [
-          `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`, // parent footnote
-          ...data.extra.map(
-            // citations from extra
-            (zoteroObj, _index) =>
-              // all zotero citation are indexed by zoteroId in notesObjResult
-              `[${
-                Object.keys(notesObjResult).indexOf(zoteroObj.zoteroId) + 1
-              }]`,
-          ),
-        ].join('')
-      : // no extra citations (no multiples)
-        `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`;
+  const notesObjResult = isEmpty(metadata)
+    ? makeFootnoteListOfUniqueItems(storeBlocks)
+    : makeFootnoteListOfUniqueItems(blocks);
 
-    const indice = zoteroId // ZOTERO
-      ? indiceIfZoteroId
-      : // FOOTNOTES
-        // parent footnote
-        [data, ...(data.extra || [])]
-          .map((footnoteObj, _index) => {
-            return `[${
-              Object.keys(notesObjResult).indexOf(
-                Object.keys(notesObjResult).find(
-                  (key) =>
-                    notesObjResult[key].footnote === footnoteObj.footnote,
-                ),
-              ) + 1
-            }]`;
-          })
-          .join('');
+  // will cosider zotero citations and footnote
+  // notesObjResult contains all zotero/footnote as unique, and contain refs for other zotero/footnote
+  const indiceIfZoteroId = data.extra
+    ? [
+        `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`, // parent footnote
+        ...data.extra.map(
+          // citations from extra
+          (zoteroObj, _index) =>
+            // all zotero citation are indexed by zoteroId in notesObjResult
+            `[${Object.keys(notesObjResult).indexOf(zoteroObj.zoteroId) + 1}]`,
+        ),
+      ].join('')
+    : // no extra citations (no multiples)
+      `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`;
 
-    const findReferenceId =
-      // search within parent citations first, otherwise the uid might be inside a refs obj that comes before
-      Object.keys(notesObjResult).find(
-        (noteKey) => notesObjResult[noteKey].uid === uid,
-      ) ||
-      // if not found in parent, search in refs, it might be a footnote references multiple times
-      Object.keys(notesObjResult).find(
-        (noteKey) =>
-          notesObjResult[noteKey].uid === uid ||
-          (notesObjResult[noteKey].refs && notesObjResult[noteKey].refs[uid]),
-      );
+  const citationIndice = zoteroId // ZOTERO
+    ? indiceIfZoteroId
+    : // FOOTNOTES
+      // parent footnote
+      [data, ...(data.extra || [])]
+        .map((footnoteObj, _index) => {
+          return `[${
+            Object.keys(notesObjResult).indexOf(
+              Object.keys(notesObjResult).find(
+                (key) => notesObjResult[key].footnote === footnoteObj.footnote,
+              ),
+            ) + 1
+          }]`;
+        })
+        .join('');
 
-    setCitationIndice(indice);
-    setCitationRefId(findReferenceId);
-  }, [editor, element, children]); // eslint-disable-line
+  const citationRefId =
+    // search within parent citations first, otherwise the uid might be inside a refs obj that comes before
+    Object.keys(notesObjResult).find(
+      (noteKey) => notesObjResult[noteKey].uid === uid,
+    ) ||
+    // if not found in parent, search in refs, it might be a footnote references multiple times
+    Object.keys(notesObjResult).find(
+      (noteKey) =>
+        notesObjResult[noteKey].uid === uid ||
+        (notesObjResult[noteKey].refs && notesObjResult[noteKey].refs[uid]),
+    );
 
   return (
     <>