Enable lint jsdoc/require-hyphen-before-param-description for readability

pheyvaer · pheyvaer · commit 47420d75a4dc · 2023-08-31T16:52:40.000+02:00
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -55,7 +55,7 @@ module.exports = {
     // 'jsdoc/require-description-complete-sentence': 1,
     // 'jsdoc/require-example': 1,
     // 'jsdoc/require-file-overview': 1,
-    // 'jsdoc/require-hyphen-before-param-description': 1,
+    'jsdoc/require-hyphen-before-param-description': 1,
     'jsdoc/require-jsdoc': 1, // Recommended
     'jsdoc/require-param': 1, // Recommended
     'jsdoc/require-param-description': 1, // Recommended
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,5 @@ dist-ssr
 pods*
 
 lintPush.sh
+
+cypress/screenshots
diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
     "dev": "vite",
     "build": "vite build",
     "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
+    "lint:fix": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0 --fix",
     "preview": "vite preview",
     "test": "cypress run",
     "prepare:pods": "npm run prepare:pods:accounts && npm run prepare:pods:data",
diff --git a/src/authenticationProvider/authenticationProvider.js b/src/authenticationProvider/authenticationProvider.js
@@ -87,7 +87,7 @@ export default {
 
 /**
  * Looks up the IDP of a WebID by querying the WebID .
- * @param {URL} webId the WebID to query the IDP from
+ * @param {URL} webId - the WebID to query the IDP from
  * @returns {?Promise<URL>} the first IDP of the WebID or undefined if no IDP is found in the WebID document
  */
 async function queryIDPfromWebId(webId) {
@@ -111,7 +111,7 @@ async function queryIDPfromWebId(webId) {
 
 /**
  *
- * @param {object} webIdThing the webId (actually of type ProfileAll, but importing this throws an error https://github.com/SolidLabResearch/generic-data-viewer-react-admin/issues/15) document to get the name from
+ * @param {object} webIdThing - the webId (actually of type ProfileAll, but importing this throws an error https://github.com/SolidLabResearch/generic-data-viewer-react-admin/issues/15) document to get the name from
  * @returns {?string} either the name or undefined if no foaf:name is found
  */
 function getName(webIdThing) {
@@ -125,7 +125,7 @@ function getName(webIdThing) {
 
 /**
  *
- * @param {object} webIdThing the webId (actually of type ProfileAll, but importing this throws an error https://github.com/SolidLabResearch/generic-data-viewer-react-admin/issues/15) document to get the profile picture from
+ * @param {object} webIdThing - the webId (actually of type ProfileAll, but importing this throws an error https://github.com/SolidLabResearch/generic-data-viewer-react-admin/issues/15) document to get the profile picture from
  * @returns {?string} either a url to the profile picture or undefined if no foaf:img is found
  */
 function getProfilePicture(webIdThing) {
diff --git a/src/components/ActionBar/SourceAuthenticationIcon/SourceAuthenticationIcon.jsx b/src/components/ActionBar/SourceAuthenticationIcon/SourceAuthenticationIcon.jsx
@@ -8,8 +8,8 @@ import { Component } from "react";
 
 /**
  * 
- * @param {object} props the props passed to the component
- * @param {string} props.source the source to check 
+ * @param {object} props - the props passed to the component
+ * @param {string} props.source - the source to check 
  * @returns {Component} an icon indicating whether the source requires authentication or not (or if it is uncertain due to an error fetching the source)
  */
 function SourceAuthenticationIcon({ source }) {
@@ -54,7 +54,7 @@ SourceAuthenticationIcon.propTypes = {
 
 /**
  * Given a source, check if it requires authentication or not
- * @param {string} source the source to check
+ * @param {string} source - the source to check
  * @returns {?boolean} whether the source requires authentication or not, or undefined if it is uncertain
  */
 async function authenticationRequired(source) {
diff --git a/src/components/ActionBar/SourceFetchStatusIcon/SourceFetchStatusIcon.jsx b/src/components/ActionBar/SourceFetchStatusIcon/SourceFetchStatusIcon.jsx
@@ -5,10 +5,10 @@ import PropTypes from "prop-types";
 import { Component } from "react";
 
 /**
- * @param {object} props the props passed to the component
- * @param {object} props.context the query context
- * @param {string} props.source the source to check
- * @param {string} props.proxyUrl the proxy url to use if querying is used for sources
+ * @param {object} props - the props passed to the component
+ * @param {object} props.context - the query context
+ * @param {string} props.source - the source to check
+ * @param {string} props.proxyUrl - the proxy url to use if querying is used for sources
  * @returns {Component} an icon indicating whether the query was executed succesfully or not
  */
 function SourceFetchStatusIcon({ context, source, proxyUrl }) {
diff --git a/src/components/ActionBar/Time.jsx b/src/components/ActionBar/Time.jsx
@@ -2,7 +2,7 @@ import PropTypes from "prop-types";
 import { Component } from "react";
 
 /**
- * @param {object} props the props passed down to the component  
+ * @param {object} props - the props passed down to the component  
  * @returns {Component} a component that displays the time in seconds and milliseconds (if configured to do so)
  */
 function Time(props) {
diff --git a/src/components/InteractionLayout/AuthenticationMenu/LogoutButton.jsx b/src/components/InteractionLayout/AuthenticationMenu/LogoutButton.jsx
@@ -8,8 +8,8 @@ import { Ref } from "react";
 
 /**
  * A component that renders a logout button in the UserMenu in case the user is logged in or a login button in case the user isn't logged in.
- * @param {object} props The props passed into the component.
- * @param {Ref} ref The ref passed into the component.
+ * @param {object} props - The props passed into the component.
+ * @param {Ref} ref - The ref passed into the component.
  */
 const LogoutButton = forwardRef((props, ref) => {
   const logout = useLogout();
@@ -18,7 +18,7 @@ const LogoutButton = forwardRef((props, ref) => {
 
   /**
    * An EventListener that handles what should happen when the user is trying to log out by pressing the log out button.
-   * @param {MouseEvent} event the event that triggered the EventListener
+   * @param {MouseEvent} event - the event that triggered the EventListener
    */
   function handleLogout(event) {
     event.preventDefault();
diff --git a/src/components/InteractionLayout/InteractionLayout.jsx b/src/components/InteractionLayout/InteractionLayout.jsx
@@ -5,7 +5,7 @@ import SelectionMenu from "./SelectionMenu/SelectionMenu";
 
 /**
  *
- * @param {object} props the props passed down to the component
+ * @param {object} props - the props passed down to the component
  * @returns {Component} custom Layout as defined by react-admin
  */
 function InteractionLayout(props) {
diff --git a/src/components/InteractionLayout/NavigationBar/NavigationBar.jsx b/src/components/InteractionLayout/NavigationBar/NavigationBar.jsx
@@ -6,7 +6,7 @@ import { Component } from "react";
 
 /**
  * 
- * @param {object} props the props passed down to the component 
+ * @param {object} props - the props passed down to the component 
  * @returns {Component} custom AppBar as defined by react-admin
  */
 function NavigationBar(props) {
diff --git a/src/components/ListResultTable/ListResultTable.jsx b/src/components/ListResultTable/ListResultTable.jsx
@@ -8,7 +8,7 @@ import { Component } from "react";
 import QueryResultList from "./QueryResultList/QueryResultList";
 
 /** 
- * @param {object} props the props passed down to the component
+ * @param {object} props - the props passed down to the component
  * @returns {Component} custom List as defined by react-admin which either shows a loading indicator or the query results
  */
 function ListResultTable(props) {
diff --git a/src/components/ListResultTable/QueryResultList/QueryResultList.jsx b/src/components/ListResultTable/QueryResultList/QueryResultList.jsx
@@ -6,7 +6,7 @@ import { Term } from "sparqljs";
 import config from "../../../config";
 
 /**
- * @param {object} props the props passed down to the component
+ * @param {object} props - the props passed down to the component
  * @returns {Component} custom ListViewer as defined by react-admin containing the results of the query with each variable its generic field. 
  */
 function QueryResultList(props) {
@@ -44,7 +44,7 @@ function QueryResultList(props) {
 
 /**
  *
- * @param {Array<Term>} data a list of data objects
+ * @param {Array<Term>} data - a list of data objects
  * @returns {Term} an object with the keys of the data and the values as an array of the values of the data
  */
 function reduceDataToObject(data) {
diff --git a/src/components/LoginPage/LoginPage.jsx b/src/components/LoginPage/LoginPage.jsx
@@ -13,7 +13,7 @@ function SolidLoginForm() {
 
   /**
    * Handling what should happen when the user is trying to log in by pressing the log in button.
-   * @param {Event} event the event calling the EventListener
+   * @param {Event} event - the event calling the EventListener
    */
   async function handleLogin(event) {
     event.preventDefault();
diff --git a/src/dataProvider/SparqlDataProvider.js b/src/dataProvider/SparqlDataProvider.js
@@ -75,7 +75,7 @@ export default {
 
 /**
  *
- * @param {number} id identifier of a query
+ * @param {number} id - identifier of a query
  * @returns {object} the query with the given id from the config file and additional information about it, if it exists.
  */
 function findQueryWithId(id) {
@@ -84,7 +84,7 @@ function findQueryWithId(id) {
 
 /**
  * Fetches the the query file from the given query and returns its text.
- * @param {object} query the query which is to be executed and additional information about the query.
+ * @param {object} query - the query which is to be executed and additional information about the query.
  * @returns {string} the text from the file location provided by the query relative to query location defined in the config file.
  */
 async function fetchQuery(query) {
@@ -118,7 +118,7 @@ async function fetchQuery(query) {
 
 /**
  * A function that executes a given query and processes every result.
- * @param {object} query the query which is to be executed and additional information about the query.
+ * @param {object} query - the query which is to be executed and additional information about the query.
  * @returns {Array<Term>} the results of the query
  */
 async function executeQuery(query) {
@@ -145,7 +145,7 @@ async function executeQuery(query) {
 
 /**
  * Generates the context for a query execution to be passed to Comunica engine when querying.
- * @param {object} context the context for the query given in the config file.
+ * @param {object} context - the context for the query given in the config file.
  * @returns {object} the context for a query execution to be passed to Comunica engine when querying.
  */
 function generateContext(context) {
@@ -176,8 +176,8 @@ function generateContext(context) {
 
 /**
  * Given a fetch function, returns a function that wraps the fetch function and sets the fetchSuccess flag in the context.
- * @param {Function} customFetch a fetch function to be wrapped 
- * @param {*} context the context for the query given in the config file.
+ * @param {Function} customFetch - a fetch function to be wrapped 
+ * @param {*} context - the context for the query given in the config file.
  * @returns {Function} a function that wraps the fetch function and sets the fetchSuccess flag in the context.
  */
 function statusFetch(customFetch, context) {
@@ -197,8 +197,8 @@ function statusFetch(customFetch, context) {
 
 /**
  * A function that given a QueryType processes every result.
- * @param {object} execution a query execution
- * @param {object} query the query which is to be executed and additional information about the query.
+ * @param {object} execution - a query execution
+ * @param {object} query - the query which is to be executed and additional information about the query.
  * @returns {Array<Term>} the results of the query
  */
 async function handleQueryExecution(execution, query) {
@@ -225,7 +225,7 @@ async function handleQueryExecution(execution, query) {
 
 /**
  *
- * @param {object} query the query which is to be executed and additional information about the query.
+ * @param {object} query - the query which is to be executed and additional information about the query.
  * @returns {Array<Term>} the results of the query
  */
 async function countQueryResults(query) {
@@ -260,7 +260,7 @@ const queryTypeHandlers = {
 
 /**
  * Configures how a query resulting in a stream of quads should be processed.
- * @param {object} quadStream a stream of Quads
+ * @param {object} quadStream - a stream of Quads
  * @returns {Array<Term>} the results of the query
  */
 async function configureQuadStream(quadStream) {
@@ -283,8 +283,8 @@ async function configureQuadStream(quadStream) {
 
 /**
  * Configures how a query resulting in a stream of bindings should be processed.
- * @param {object} bindingStream a stream of Bindings
- * @param {Array<string>} variables all the variables of the query behind the binding stream.
+ * @param {object} bindingStream - a stream of Bindings
+ * @param {Array<string>} variables - all the variables of the query behind the binding stream.
  * @returns {Array<Term>} the results of the query
  */
 async function configureBindingStream(bindingStream, variables) {
diff --git a/src/representationProvider/GenericField.jsx b/src/representationProvider/GenericField.jsx
@@ -5,7 +5,7 @@ import PropTypes from "prop-types";
 import { Component } from "react";
 
 /**
- * @param {object} props the props passed down to the component
+ * @param {object} props - the props passed down to the component
  * @returns {Component} a component function that returns a Field based on the type of the source or a custom text field if there is no typeMapper defined for the type of the source
  */
 function GenericField(props) {
diff --git a/src/representationProvider/components/CustomImageField.jsx b/src/representationProvider/components/CustomImageField.jsx
@@ -5,9 +5,9 @@ import { Component } from "react";
 import { Term } from "sparqljs";
 
 /**
- * @param {object} props the props passed down to the component
- * @param {Term} props.record the object containing the data
- * @param {string} props.source the key of the data to be displayed in this field
+ * @param {object} props - the props passed down to the component
+ * @param {Term} props.record - the object containing the data
+ * @param {string} props.source - the key of the data to be displayed in this field
  * @returns {Component} a component that displays the image behind the url of the given RDF/JS term
  */
 function CustomImageField({ source, record }) {
diff --git a/src/representationProvider/components/CustomTextField.jsx b/src/representationProvider/components/CustomTextField.jsx
@@ -2,9 +2,9 @@ import PropTypes from "prop-types";
 import { Component } from "react";
 
 /**
- * @param {object} props the props passed down to the component
- * @param {object} props.record the object containing the data
- * @param {string} props.source the key of the data to be displayed in this field
+ * @param {object} props - the props passed down to the component
+ * @param {object} props.record - the object containing the data
+ * @param {string} props.source - the key of the data to be displayed in this field
  * @returns {Component} a custom text field that displays the value of the data in case there is no typeMapper defined for the type of the source
  */
 function CustomTextField({ record, source }) {
diff --git a/src/representationProvider/components/CustomUrlField.jsx b/src/representationProvider/components/CustomUrlField.jsx
@@ -5,9 +5,9 @@ import { Component } from "react";
 import { Term } from "sparqljs";
 
 /**
- * @param {object} props the props passed down to the component
- * @param {Term} props.record an object of RDF/JS Term
- * @param {string} props.source the key of the object to be processed
+ * @param {object} props - the props passed down to the component
+ * @param {Term} props.record - an object of RDF/JS Term
+ * @param {string} props.source - the key of the object to be processed
  * @returns {Component} a component that displays the url of the given RDF/JS Term
  */
 function CustomURLField({ source, record }) {
diff --git a/src/representationProvider/components/processFunction.js b/src/representationProvider/components/processFunction.js
@@ -3,8 +3,8 @@ import { Term } from "sparqljs";
 
 /**
  *
- * @param {Term|string} record an object of RDF/JS terms
- * @param {string} source the key of record which is to be processed
+ * @param {Term|string} record - an object of RDF/JS terms
+ * @param {string} source - the key of record which is to be processed
  * @returns {string} the id or value of the record at the given source key
  */
 export function getRawData(record, source) {

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import SelectionMenu from "./SelectionMenu/SelectionMenu";`
`5`	`5`
`6`	`6`	`/**`
`7`	`7`	`*`
`8`		`- * @param {object} props the props passed down to the component`
	`8`	`+ * @param {object} props - the props passed down to the component`
`9`	`9`	`* @returns {Component} custom Layout as defined by react-admin`
`10`	`10`	`*/`
`11`	`11`	`function InteractionLayout(props) {`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import { Component } from "react";`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`*`
`9`		`- * @param {object} props the props passed down to the component`
	`9`	`+ * @param {object} props - the props passed down to the component`
`10`	`10`	`* @returns {Component} custom AppBar as defined by react-admin`
`11`	`11`	`*/`
`12`	`12`	`function NavigationBar(props) {`