Lookit's jsPsych Video Extensions and Plugins

.gitignore

@@ -1,4 +1,6 @@
 node_modules
 dist
 coverage
-Procfile
+Procfile
+.env
+site

.prettierrc

@@ -3,6 +3,7 @@
   "plugins": [
     "prettier-plugin-packagejson",
     "prettier-plugin-sort-json",
-    "prettier-plugin-organize-imports"
+    "prettier-plugin-organize-imports",
+    "prettier-plugin-jsdoc"
   ]
 }

README.md

@@ -57,7 +57,7 @@ Edit `tsconfig.json`:
     "baseUrl": ".",
     "strict": true
   },
-  "extends": "@jspsych/config/tsconfig.core.json",
+  "extends": "@jspsych/config/tsconfig.json",
   "include": ["src"]
 }
 ```
@@ -82,9 +82,7 @@ export default makeDevConfig(rollupConfig, port);
 Edit `jest.config.cjs`
 
 ```cjs
-const config = require("@jspsych/config/jest").makePackageConfig(__dirname);
-config.moduleNameMapper = {};
-module.exports = config;
+module.exports = require("../../jest.cjs").makePackageConfig();
 ```
 
 You will need `@jspsych/config` to build your new package:

eslint.config.mjs

@@ -0,0 +1,44 @@
+import pluginJs from "@eslint/js";
+import prettierConfig from "eslint-config-prettier";
+import jsdoc from "eslint-plugin-jsdoc";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default [
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  jsdoc.configs["flat/recommended-typescript-error"],
+  {
+    rules: {
+      "require-await": "error",
+      "@typescript-eslint/explicit-member-accessibility": "error",
+      "prefer-arrow-callback": ["error", { allowNamedFunctions: true }],
+      "func-style": ["error", "expression", { allowArrowFunctions: true }],
+    },
+  },
+  {
+    plugins: {
+      jsdoc,
+    },
+    rules: {
+      "jsdoc/tag-lines": "off",
+      "jsdoc/require-description-complete-sentence": "error",
+      "jsdoc/require-description": "error",
+      "jsdoc/require-hyphen-before-param-description": "error",
+      "jsdoc/require-jsdoc": [
+        "error",
+        {
+          require: {
+            FunctionDeclaration: true,
+            MethodDefinition: true,
+            ClassDeclaration: true,
+            ArrowFunctionExpression: true,
+            FunctionExpression: true,
+          },
+        },
+      ],
+    },
+  },
+  prettierConfig,
+];

jest.cjs

@@ -0,0 +1,12 @@
+module.exports.makePackageConfig = () => {
+  return {
+    ...require("@jspsych/config/jest").makePackageConfig(__dirname),
+    moduleNameMapper: { "@lookit/data": "<rootDir>/../../packages/data/src" },
+    coverageThreshold: {
+      global: {
+        lines: 100,
+        statements: 0,
+      },
+    },
+  };
+};

makefile

@@ -0,0 +1,12 @@
+serve: poetry
+	poetry run mkdocs serve
+
+build: poetry
+	poetry run mkdocs build --strict
+
+poetry:
+	poetry install --no-root --sync
+
+clean:
+	rm -rf ./site $(shell poetry env info -p)
+

mkdocs.yml

@@ -0,0 +1,27 @@
+site_name: CHS jsPsych
+docs_dir: ./packages
+repo_url: https://github.com/lookit/lookit-jspsych
+
+nav:
+  - Home: index.md
+  - CHS's initJsPsych: lookit-initjspsych/README.md
+  - Data: data/README.md
+  - Record: record/README.md
+  - Surveys: surveys/README.md
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn
+exclude_docs: |
+  node_modules
+  lookit-initjspsych/CHANGELOG.md
+theme:
+  name: mkdocs
+  color_mode: auto
+  user_color_mode_toggle: auto
+plugins:
+  - search
+  - macros
+extra:
+  jsPsych: https://www.jspsych.org/7.3/