Improved linter rules and husky pre-commit hooks

.github/workflows/lint.yml

@@ -0,0 +1,52 @@
+name: Run linter on pull request
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  run-linter:
+    runs-on: ubuntu-latest
+
+    environment: development
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .nvmrc
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v44
+        with:
+          files: src/**/*.{js,jsx}
+          files_ignore: src/__tests__/
+
+      - name: Run lint test
+        shell: bash
+        run: |
+          ROOT_DIR=$(git rev-parse --show-toplevel)
+          ESLINT="${ROOT_DIR}//node_modules/eslint/bin/eslint.js --no-ignore'"
+          JSFILES=""
+          for file in ${{ steps.changed-parser.outputs.all_modified_files }}; do
+            JSFILES="$JSFILES $file"
+          done
+          if [ -n "$JSFILES" ]; then
+            echo "$JSFILES" | xargs $ESLINT || {
+              echo "Linting failed."
+              exit 1
+            }
+          fi

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# Include husky
+. "$(dirname "$0")/_/husky.sh" || {
+  echo "Cannot find husky.sh. Make sure Husky is installed or adjust the path." >&2
+  exit 1
+}
+
+# Defaults to .git
+unset GIT_DIR
+
+ROOT_DIR=$(git rev-parse --show-toplevel)
+
+cd "$ROOT_DIR" || {
+  echo "Cannot change directory to $ROOT_DIR." >&2
+  exit 1
+}
+
+JSFILES=$(git diff --name-only --cached --relative --diff-filter=ACM | grep -E '\.jsx?$' || :)
+ESLINT="${ROOT_DIR}//node_modules/eslint/bin/eslint.js --no-ignore'"
+
+if [ -n "$JSFILES" ]; then
+  echo "$JSFILES" | xargs $ESLINT || {
+    echo "Linting failed."
+    exit 1
+  }
+fi

.lintstagedrc

@@ -0,0 +1,4 @@
+{
+  "*.js": "yarn lint",
+  "*.jsx": "yarn lint"
+}

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']};

eslint.config.mjs

@@ -0,0 +1,22 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+// import pluginReactConfig from 'eslint-plugin-react/configs/recommended.js';
+
+export default [
+  {
+    files: ['**/*.js', '**/*.jsx'],
+    languageOptions: {
+      globals: { ...globals.browser, ...globals.node },
+    },
+    rules: {
+      // 'react/jsx-filename-extension': ['warn', { 'extensions': ['.js', '.jsx'] }],
+      // 'react/no-array-index-key': 'off',
+      // 'react/jsx-props-no-spreading': 'off',
+      'no-use-before-define': 'warn',
+      'consistent-return': 'off',
+      'prefer-const': 'error',
+    },
+  },
+  pluginJs.configs.recommended,
+  // pluginReactConfig,
+];

package.json

@@ -2,6 +2,11 @@
   "name": "dmp_opidor_react",
   "version": "0.1.0",
   "private": true,
+  "scripts": {
+    "lint": "eslint . --ignore-pattern '**/__tests__/**'",
+    "commitlint": "commitlint --edit $1",
+    "prepare": "husky"
+  },
   "dependencies": {
     "@directus/sdk": "^15.0.3",
     "@tinymce/tinymce-react": "^5.0.0",
@@ -54,10 +59,18 @@
   },
   "devDependencies": {
     "@cfaester/enzyme-adapter-react-18": "^0.7.0",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
     "@testing-library/jest-dom": "^6.1.0",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.0.0",
+    "commitlint": "^19.3.0",
     "enzyme": "^3.11.0",
+    "eslint": "^9.1.1",
+    "eslint-plugin-react": "^7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "globals": "^15.1.0",
+    "husky": "^9.0.11",
     "react-test-renderer": "^18.2.0"
   }
 }

public/locales/fr/translation.json

@@ -193,5 +193,13 @@
   "Tools": "Outils",
   "There seems to be no question for this category.": "Il semble ne pas y avoir de question pour cette catégorie",
   "Oh, it seems that this help page is still under development and does not yet contain any content.": "Oh, il semble que cette page d'aide soit encore en cours de développement et ne contienne pas encore de contenu.",
-  "This record already exists.": "Cet élément est déjà présent."
+  "This record already exists.": "Cet élément est déjà présent.",
+  "Search by <DOI> or <Title>": "Recherche par <DOI> ou <Titre>",
+  "Glossary": "Glossaire",
+  "Oh, it seems that this glossary page is still under development and does not yet contain any content.": "Oh, il semble que cette page de glossaire soit encore en cours de développement et ne contienne pas encore de contenu.",
+  "There don't seem to be any terms for this letter.": "Il ne semble pas y avoir de termes pour cette lettre",
+  "Search...": "Rechercher...",
+  "Your plan does not yet include any research output": "Votre plan ne comporte encore aucun produit de recherche",
+  "Create a research output": "Créer un produit de recherche",
+  "A ‘type’ is required to create a search product.": "Un \"type\" est nécessaire pour créer un produit de recherche."
 }