Merge pull request #1194 from EcrituresNumeriques/feat/eslint-jsdoc

front/.eslintrc.cjs

@@ -8,6 +8,7 @@ module.exports = {
     'eslint:recommended',
     'plugin:react/recommended',
     'plugin:jsonc/recommended-with-json',
+    'plugin:jsdoc/recommended-typescript-flavor',
   ],
   parserOptions: {
     ecmaFeatures: {
@@ -22,7 +23,7 @@ module.exports = {
       parser: 'jsonc-eslint-parser',
     },
   ],
-  plugins: ['react', 'vitest'],
+  plugins: ['react', 'vitest', 'jsdoc'],
   settings: {
     react: {
       version: '16.13',
@@ -39,6 +40,12 @@ module.exports = {
     __HUMANID_REGISTER_ENDPOINT__: true,
   },
   rules: {
+    'jsdoc/require-description': ['off'],
+    'jsdoc/require-example': ['off'],
+    'jsdoc/require-jsdoc': ['off'],
+    'jsdoc/require-param-description': ['off'],
+    'jsdoc/require-returns-description': ['off'],
+    'jsdoc/require-property-description': ['off'],
     'react/prop-types': ['warn'],
     'no-unused-vars': ['warn'],
     'jsonc/indent': ['error', 2],

front/package.json

@@ -77,8 +77,8 @@
     "yjs": "^13.6.6"
   },
   "optionalDependencies": {
-    "@rollup/rollup-linux-x64-gnu": "^4.31.0",
-    "@esbuild/linux-x64": "^0.24.2"
+    "@esbuild/linux-x64": "^0.24.2",
+    "@rollup/rollup-linux-x64-gnu": "^4.31.0"
   },
   "overrides": {
     "@geist-ui/core": {
@@ -100,6 +100,7 @@
     "@vitest/coverage-v8": "^3.0.3",
     "@welldone-software/why-did-you-render": "~8.0",
     "eslint": "^8.2.0",
+    "eslint-plugin-jsdoc": "^50.6.2",
     "eslint-plugin-jsonc": "^2.5.0",
     "eslint-plugin-react": "^7.27.0",
     "eslint-plugin-vitest": "^0.5.4",

front/src/components/SelectCombobox.js

@@ -4,7 +4,7 @@
 
 /**
  * @param {ComboboxItem[]} items
- * @returns {Record<String, ComboboxItem[]>}
+ * @returns {Record<string, ComboboxItem[]>}
  */
 export function groupItems(items) {
   return Array.from(

front/src/helpers/bibtex.js

@@ -19,7 +19,6 @@ export function toBibtex(entries) {
 /**
  * We tolerate `unexpected_field` warnings as it's user provided, it does not have any side effect
  * @see https://github.com/EcrituresNumeriques/stylo/issues/187
- *
  * @param {string} bibtex
  * @returns {Promise<{success: number,empty: boolean,warnings: Array.<string>,error: Array.<string>}>}
  */
@@ -88,6 +87,7 @@ export function deriveAuthorNameAndDate(entry) {
 
 /**
  * @param {string} Bibtex bibliography
+ * @param input
  * @returns {Array.<{ title: string, key: string, type: string }}
  */
 export function toEntries(input) {

front/src/helpers/forms.js

@@ -2,8 +2,8 @@
  * Transforms a form into a plain object
  *
  * formData.entries() does not handle multiple values (sic) and formData.getAll() only works at a field level
- *
  * @param {React.ReactHTMLElement|FormData} formElement
+ * @param input
  * @returns {Record<string, string|number|string[]|number[]>}
  */
 export function fromFormData(input) {

front/src/helpers/graphQL.js

@@ -69,7 +69,7 @@ export function useGraphQL() {
  * @param {string} sessionToken
  * @param {DocumentNode|string} queryOrAST
  * @param {{[string: key]: value}} variables
- * @return {Promise<string|object>}
+ * @returns {Promise<string|object>}
  */
 export function runQuery({ sessionToken }, { query: queryOrAST, variables }) {
   const query = typeof queryOrAST === 'string' ? queryOrAST : print(queryOrAST)

front/src/helpers/isidore.js

@@ -4,7 +4,7 @@
  * Search a vocabulary from the Isidore API.
  * Eg: https://api.isidore.science/vocabulary/suggest?q=quebe&output=json
  * @param {string} searchValue
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 export async function searchKeyword(searchValue) {
   if (searchValue && searchValue.length > 0) {
@@ -51,7 +51,7 @@ export async function searchKeyword(searchValue) {
  * Search an author from the Isidore API.
  * Eg: https://api.isidore.science/resource/suggest?q=marcell&feed=feed-creator&output=json
  * @param {string} searchValue
- * @returns {Promise<Object>}
+ * @returns {Promise<object>}
  */
 export async function searchAuthor(searchValue) {
   if (searchValue && searchValue.length > 0) {