Merge remote-tracking branch 'upstream/main'

.eslintrc.json

@@ -5,6 +5,9 @@
     "node": true
   },
   "extends": [
+    "airbnb-base",
+    "airbnb/rules/react",
+    "plugin:react/recommended",
     "eslint:recommended",
     "plugin:import/typescript",
     "plugin:@typescript-eslint/recommended"
@@ -14,15 +17,61 @@
     "ecmaVersion": 2022,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "react-hooks"],
+  "plugins": ["@typescript-eslint", "react"],
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".jsx", ".ts", ".tsx", ".d.ts"]
+      }
+    }
+  },
   "ignorePatterns": ["/public/*"],
   "rules": {
-    "linebreak-style": ["error", "unix"],
-    "quotes": ["error", "single"],
-    "semi": ["error", "always"],
-    "import/extensions": "off",
-    "arrow-parens": ["error", "always"],
-    "react-hooks/rules-of-hooks": "error", // Checks rules of Hooks
-    "react-hooks/exhaustive-deps": "warn" // Checks effect dependencies
+    "class-methods-use-this": "off",
+    "linebreak-style": "off",
+    "no-restricted-exports": "off",
+    "no-restricted-syntax": "off",
+    "no-underscore-dangle": "off",
+    "no-console": ["error", { "allow": ["warn", "error"] }],
+    "@typescript-eslint/no-unused-expressions": [
+      "error",
+      {
+        "allowShortCircuit": true,
+        "allowTernary": true,
+        "allowTaggedTemplates": true
+      }
+    ],
+    "react/no-array-index-key": "off",
+    "jsx-a11y/click-events-have-key-events": "off",
+    "no-return-await": "off",
+    "@typescript-eslint/no-unused-vars": "warn",
+    "max-classes-per-file": "off",
+    "no-param-reassign": ["error", { "props": false }],
+    "cypress/unsafe-to-chain-command": "off",
+    "import/no-extraneous-dependencies": "off",
+    "import/prefer-default-export": "off",
+    "import/order": "error",
+    "prefer-destructuring": ["warn", { "object": true, "array": false }],
+    "prefer-promise-reject-errors": "warn",
+    "prefer-spread": "warn",
+    "react/react-in-jsx-scope": 0,
+    "max-len": 0,
+    "react/jsx-filename-extension": 0,
+    "import/extensions": ["error", "never"],
+    "@typescript-eslint/ban-ts-comment": "warn",
+    "react/destructuring-assignment": "off",
+    "react/jsx-props-no-spreading": "off",
+    "react/no-unused-class-component-methods": "warn",
+    "react/require-default-props": "off",
+    "react/static-property-placement": [
+      "warn",
+      "property assignment",
+      {
+        "childContextTypes": "static getter",
+        "contextTypes": "static public field",
+        "contextType": "static public field",
+        "displayName": "static public field"
+      }
+    ]
   }
 }

package.json

@@ -34,6 +34,7 @@
     "ajv": "^8.12.0",
     "arquero": "^5.2.0",
     "d3": "^7.8.2",
+    "eslint-config-airbnb": "^19.0.4",
     "firebase": "^10.7.0",
     "hjson": "^3.2.2",
     "localforage": "^1.10.0",
@@ -62,11 +63,12 @@
     "@vitejs/plugin-react-swc": "^3.5.0",
     "eslint": "^8.54.0",
     "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.1",
     "typescript": "^5.3.2",
-    "vite": "^5.0.5"
+    "vite": "^5.0.12"
   }
 }

public/configs/global.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://raw.githubusercontent.com/reVISit-studies/study/main/src/parser/GlobalConfigSchema.json",
+    "configsList": [
+        "viz-guardrails"
+    ],
+    "configs": {
+        "viz-guardrails": {
+            "path": "viz-guardrails/config-viz-guardrails.json"
+        }
+    }
+}

public/viz-guardrails/config-viz-guardrails.hjson

@@ -1,7 +1,7 @@
 {
     "$schema": https://raw.githubusercontent.com/reVISit-studies/study/main/src/parser/StudyConfigSchema.json
     "studyMetadata": {
-        "title": "Visualization Guardrails",
+        "title": "Communicating With Interactive Data Visualizations",
         "version": "pilot",
         "authors": ["VDL"],
         "date": "2024-01-11",
@@ -177,42 +177,56 @@
                     ]
                 },
                 {
-                    "id": "understand",
-                    "type": "radio",
+                    "id": "clear",
+                    "type": "likert",
                     "location": "belowStimulus",
-                    "prompt": "Did you understand what exactly the guardrail was showing?",
+                    "prompt": "How clear was it what the guardrail was showing?",
                     "required": true,
-                    "options": [
-                        {
-                            "label": "No",
-                            "value": "no"
-                        },
-                        {
-                            "label": "Somewhat",
-                            "value": "somewhat"
-                        },
-                        {
-                            "label": "Yes",
-                            "value": "yes"
-                        }
-                    ]
+                    "leftLabel": "Not clear",
+                    "rightLabel": "Very clear",
+                    "preset": 5,
                 },
                 {
                     "id": "difficulty",
                     "type": "likert",
                     "location": "belowStimulus",
-                    "prompt": "How did the guardrail affect the difficulty of performing the task, compared to no guardrail?",
+                    "prompt": "Did the guardrail make it easier or more difficult to convincingly support the prompts?",
                     "required": true,
-                    "leftLabel": "More difficult",
-                    "rightLabel": "Easier",
+                    "leftLabel": "Easier",
+                    "rightLabel": "More difficult",
                     "preset": 5,
                 },
                 {
                     "id": "experience",
-                    "type": "shortText",
+                    "type": "longText",
                     "location": "belowStimulus",
-                    "prompt": "Describe how, if at all, the guardrail impacted your experience performing the task:",
+                    "prompt": "Describe how the guardrail impacted your experience performing the task:",
                     "required": true,
+                    "placeholder": "Enter your answer here."
+                },
+                {
+                    "id": "surveyExperience",
+                    "prompt": "Did you experience any problems with our tool?",
+                    "required": true,
+                    "location": "belowStimulus",
+                    "type": "longText",
+                    "placeholder": "Enter your answer here."
+                },
+                {
+                    "id": "surveyRenderIssues",
+                    "prompt": "Did anything not render or display properly?",
+                    "required": true,
+                    "location": "belowStimulus",
+                    "type": "longText",
+                    "placeholder": "Enter your answer here"
+                },
+                {
+                    "id": "surveyOtherIssues",
+                    "prompt": "Any other issues or anything you would like to tell us?",
+                    "required": true,
+                    "location": "belowStimulus",
+                    "type": "longText",
+                    "placeholder": "Enter your answer here"
                 }
             ]
         }
@@ -251,17 +265,9 @@
         },
         "consent": {
             "type": "markdown",
-            "path": "viz-guardrails/consent.md",
+            "path": "viz-guardrails/consent_stage1.md",
             "nextButtonText": "Agree",
             "response": [
-                {
-                    "id": "signature",
-                    "prompt": "Your signature",
-                    "required": true,
-                    "location": "belowStimulus",
-                    "type": "shortText",
-                    "placeholder": "Please provide your signature"
-                },
                 {
                     "id": "accept",
                     "prompt": "Do you consent to the study and wish to continue?",