Merge remote-tracking branch 'origin/main' into 2021-11-08-bvl-feedback-summary

Author: lorisadmin

.eslintignore

@@ -5,7 +5,6 @@ babel.config.js
 
 # compiled js ignored since it is run on the jsx directory
 modules/*/js/*
-modules/*/js/*/*
 modules/electrophysiology_browser/jsx/react-series-data-viewer/src/protocol-buffers/chunk_pb.js
 htdocs/js/components/*
 
@@ -23,3 +22,6 @@ htdocs/js/FileSaver.min.js
 htdocs/vendor/
 htdocs/fontawesome/
 htdocs/bootstrap/
+
+# ignore until eslint errors are fixed
+modules/electrophysiology_browser/jsx/react-series-data-viewer/src/series/components/**

.eslintrc.json

@@ -1,18 +1,33 @@
 {
-  "parser": "babel-eslint",
+  "parser": "@babel/eslint-parser",
   "plugins": [
     "react",
-    "no-jquery"
+    "no-jquery",
+    "jsdoc"
+
   ],
   "settings": {
     "react": {
       "version": "detect"
+    },
+    "jsdoc": {
+      "tagNamePreference": {
+        "return": "return",
+        "tag constructor": "constructor"
+      },
+      "preferredTypes": {
+        "Function": "function",
+        "function": "Function",
+        "Array": "array",
+        "array": "Array"
+      }
     }
   },
   "env": {
     "browser": true,
     "jquery": true,
-    "node": true
+    "node": true,
+    "es6": true
   },
   "parserOptions": {
     "sourceType": "module",
@@ -21,7 +36,12 @@
       "globalReturn": false
     }
   },
-  "extends": ["eslint:recommended", "plugin:react/recommended", "google"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:jsdoc/recommended",
+    "google"
+  ],
   "rules": {
     "max-len": ["error", {
         "code": 80,
@@ -44,15 +64,16 @@
     "no-fallthrough": "off",
     "react/jsx-no-undef": "off",
     "react/prop-types": "off",
-    "no-undef": "off",
+    "no-undef": "error",
     "react/jsx-key": "off",
     "no-extra-semi": "off",
     "no-prototype-builtins": "off",
     "react/jsx-uses-react": "error",
     "react/jsx-uses-vars": "error",
     "prefer-rest-params": "error",
     "array-callback-return": "off",
-    "require-jsdoc": "error",
+    "require-jsdoc": "off",
+    "valid-jsdoc": "off",
     "no-implicit-globals": "off",
     "no-invalid-this": "off",
     "no-alert": "off",
@@ -61,9 +82,36 @@
     }],
     "no-console": ["warn", {
       "allow": ["info", "warn", "error"]
-    }]
+    }],
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/require-returns-description": "off"
   },
   "overrides": [
+    {
+      "files": "**/*.+(ts|tsx)",
+      "plugins": ["@typescript-eslint"],
+      "extends": [
+        "plugin:@typescript-eslint/recommended"
+      ],
+      "rules": {
+        "jsdoc/require-jsdoc": [
+          "error",
+          {"require": {
+            "ArrowFunctionExpression": true,
+            "FunctionExpression": true,
+            "ClassDeclaration": true,
+            "MethodDefinition": true
+          }}
+        ],
+        "jsdoc/require-param-description": "error",
+        "jsdoc/require-returns": "error",
+        "jsdoc/require-returns-description": "error",
+        "no-undef": "off",
+        "@typescript-eslint/ban-ts-comment": "off",
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+    },
     {
       "files": [
         "modules/**"
@@ -234,6 +282,8 @@
     "ReactDOM": true,
     "loris": true,
     "QueryString": true,
-    "swal": true
+    "swal": true,
+    "schema_urls": true,
+    "JSX": true
   }
 }

.githooks/pre-push

@@ -4,19 +4,32 @@ on:
   - push
   - pull_request
 
+env:
+  EEG_VIS_ENABLED: 'true'
+
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+        fail-fast: false
         matrix:
-            testsuite:
-            - static
-            - unit
-            - integration
-            php:
-            - 7.4
-            - 8.0
+            testsuite: ['integration']
+            php: ['8.1','8.2']
+            ci_node_index: [0,1,2,3]
+
+            include:
+            # add a variable but do not display it in the job's name 
+            - ci_node_total: 4
 
+            - testsuite: 'static'
+              php: '8.1'
+            - testsuite: 'static'
+              php: '8.2'
+            - testsuite: 'unit'
+              php: '8.1'
+            - testsuite: 'unit'
+              php: '8.2'
+            
     steps:
     - uses: actions/checkout@v2
 
@@ -31,15 +44,16 @@ jobs:
 
     - name: Cache Composer packages
       id: composer-cache
+      run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+    - name: Composer cache
       uses: actions/cache@v2
       with:
-        path: vendor
-        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-php-
+        path: ${{ steps.composer-cache.outputs.dir }}
+        key: ${{ runner.os }}-composer-${{ hashFiles('composer.lock') }}
+        restore-keys: ${{ runner.os }}-composer-
 
     - name: Change PHP Version in Dockerfile
-      run: sed -i "s/7.4/${{ matrix.php }}/g" Dockerfile.test.php7
+      run: sed -i "s/8.0/${{ matrix.php }}/g" Dockerfile.test.php8
 
     - name: Install package dependencies
       run: sudo apt-get install -y protobuf-compiler 
@@ -55,3 +69,8 @@ jobs:
 
     - name: Run Test Suite
       run: npm run tests:${{ matrix.testsuite }}
+      env:
+          # Specifies how many jobs you would like to run in parallel,
+          CI_NODE_TOTAL: ${{ matrix.ci_node_total }}
+          # Use the index from matrix as an environment variable
+          CI_NODE_INDEX: ${{ matrix.ci_node_index }}

.github/workflows/loristest.yml

@@ -1,4 +1,5 @@
 project
+p_*/
 smarty/templates_c
 .gitmodules
 project-*
@@ -32,5 +33,4 @@ SQL/Archive/autogenerated/single_use/*.sql
 SQL/Archive/autogenerated/*.sql
 VERSION
 .DS_Store
-package-lock.json
 .eslintcache

.gitignore

@@ -30,7 +30,6 @@
     "unused_variable_detection" => true,
     "suppress_issue_types" => [
         "PhanUnusedPublicNoOverrideMethodParameter",
-        "PhanTypePossiblyInvalidDimOffset",
     ],
     "analyzed_file_extensions" => ["php", "inc"],
     "directory_list" => [
@@ -41,6 +40,9 @@
         "vendor",
         "test"
     ],
+    'exclude_file_list' => [
+        'vendor/squizlabs/php_codesniffer/tests/Core/Tokenizer/DoubleQuotedStringTest.inc'
+    ],
     "exclude_analysis_directory_list" => [
         "vendor"
     ],