@jspsych/config 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @jspsych/config
+
+## 1.0.0
+### Major Changes
+
+
+
+- [`bc058590`](https://github.com/jspsych/jsPsych/commit/bc058590950285e52116f809e4ccc57bae5a67f5) Thanks [@bjoluc](https://github.com/bjoluc)! - Initial release

package/babel.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ["@babel/preset-env"],
+};

package/gulp.js

@@ -0,0 +1,51 @@
+import { sep as pathSeparator } from "path";
+
+import gulp from "gulp";
+import rename from "gulp-rename";
+import replace from "gulp-replace";
+import zip from "gulp-zip";
+import merge from "merge-stream";
+
+const { dest, src } = gulp;
+
+export const createCoreDistArchive = () =>
+  merge(
+    // index.browser.js files
+    src("packages/*/dist/index.browser.js", { root: "packages/" })
+      // Rename dist files
+      .pipe(
+        rename((path) => {
+          const packageName = path.dirname.split(pathSeparator)[0];
+
+          path.dirname = "/dist";
+          path.basename = packageName;
+        })
+      )
+      // Remove sourceMappingURL comments
+      .pipe(replace(/\/\/# sourceMappingURL=.*\n/g, "")),
+
+    // jspsych.css
+    src("packages/jspsych/css/jspsych.css").pipe(rename("/dist/jspsych.css")),
+
+    // Examples
+    src("examples/**/*", { base: "." })
+      // Rewrite script source paths
+      .pipe(
+        replace(
+          /<script src="(.*)\/packages\/(.*)\/dist\/index\.browser\.js"><\/script>/g,
+          '<script src="$1/dist/$2.js"></script>'
+        )
+      )
+      // Rewrite jspsych css source paths
+      .pipe(
+        replace(
+          /<link rel="stylesheet" href="(.*)\/packages\/jspsych\/css\/(.*)" \/>/g,
+          '<link rel="stylesheet" href="$1/dist/$2" />'
+        )
+      ),
+
+    // Other files
+    src(["*.md", "license.txt"])
+  )
+    .pipe(zip("dist.zip"))
+    .pipe(dest("."));

package/jest.cjs

@@ -0,0 +1,31 @@
+const ts = require("typescript");
+const { pathsToModuleNameMapper } = require("ts-jest/utils");
+
+module.exports.makePackageConfig = (dirname) => {
+  const packageJson = require(dirname + "/package.json");
+  const packageBaseName = packageJson.name.replace("@jspsych/", "");
+
+  // based on https://github.com/formium/tsdx/blob/462af2d002987f985695b98400e0344b8f2754b7/src/createRollupConfig.ts#L51-L57
+  const tsCompilerOptions = ts.parseJsonConfigFileContent(
+    ts.readConfigFile(dirname + "/tsconfig.json", ts.sys.readFile).config,
+    ts.sys,
+    dirname
+  ).options;
+
+  return {
+    preset: "ts-jest",
+    moduleNameMapper: pathsToModuleNameMapper(tsCompilerOptions.paths, {
+      prefix: "<rootDir>/",
+    }),
+    testEnvironment: "jsdom",
+    testEnvironmentOptions: {
+      fetchExternalResources: true,
+      pretendToBeVisual: true,
+    },
+    testURL: "http://localhost/",
+    displayName: {
+      name: packageBaseName,
+      color: packageBaseName === "jspsych" ? "white" : "cyanBright",
+    },
+  };
+};

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@jspsych/config",
+  "version": "1.0.0",
+  "description": "Shared (build) configuration for jsPsych packages",
+  "type": "module",
+  "exports": {
+    "./babel": {
+      "import": null,
+      "require": "./babel.cjs"
+    },
+    "./gulp": {
+      "import": "./gulp.js",
+      "require": null
+    },
+    "./jest": {
+      "import": null,
+      "require": "./jest.cjs"
+    },
+    "./rollup": {
+      "import": "./rollup.js",
+      "require": null
+    },
+    "./tsconfig.json": "./tsconfig.json",
+    "./tsconfig.core.json": "./tsconfig.core.json",
+    "./tsconfig.contrib.json": "./tsconfig.contrib.json"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "build": "",
+    "tsc": ""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jspsych/jsPsych.git",
+    "directory": "packages/config"
+  },
+  "author": "bjoluc <mail@bjoluc.de>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jspsych/jsPsych/issues"
+  },
+  "homepage": "https://www.jspsych.org/latest/developers/configuration",
+  "dependencies": {
+    "@babel/cli": "7.15.7",
+    "@babel/core": "7.15.5",
+    "@babel/preset-env": "7.15.6",
+    "@rollup/plugin-babel": "5.3.0",
+    "@rollup/plugin-commonjs": "19.0.0",
+    "@rollup/plugin-json": "4.1.0",
+    "@rollup/plugin-node-resolve": "13.0.5",
+    "@types/gulp": "4.0.9",
+    "@types/jest": "27.0.2",
+    "babel-preset-minify": "0.5.1",
+    "canvas": "2.8.0",
+    "gulp": "4.0.2",
+    "gulp-cli": "2.3.0",
+    "gulp-rename": "2.0.0",
+    "gulp-replace": "1.1.3",
+    "gulp-zip": "5.1.0",
+    "jest": "27.2.4",
+    "jest-environment-jsdom": "27.2.4",
+    "merge-stream": "2.0.0",
+    "rollup": "2.58.0",
+    "rollup-plugin-terser": "7.0.2",
+    "rollup-plugin-typescript2": "0.30.0",
+    "ts-jest": "27.0.5",
+    "tslib": "2.3.1",
+    "typescript": "4.4.3"
+  }
+}

package/rollup.js

@@ -0,0 +1,138 @@
+import { babel } from "@rollup/plugin-babel";
+import commonjs from "@rollup/plugin-commonjs";
+import json from "@rollup/plugin-json";
+import resolve from "@rollup/plugin-node-resolve";
+import { defineConfig } from "rollup";
+import { terser } from "rollup-plugin-terser";
+import typescript from "rollup-plugin-typescript2";
+import ts from "typescript";
+
+const makeConfig = ({
+  outputOptions = {},
+  globalOptions = {},
+  iifeOutputOptions = {},
+  nodeOnly = false,
+}) => {
+  const source = "src/index";
+  const destination = "dist/index";
+
+  outputOptions = {
+    sourcemap: true,
+    ...outputOptions,
+  };
+
+  const commonConfig = defineConfig({
+    input: `${source}.ts`,
+    plugins: [
+      resolve(),
+      typescript({
+        typescript: ts,
+        tsconfigDefaults: {
+          exclude: ["./tests", "**/*.spec.ts", "**/*.test.ts", "./dist"],
+        },
+        tsconfigOverride: {
+          compilerOptions: {
+            rootDir: "./src",
+            outDir: "./dist",
+            paths: {}, // Do not include files referenced via `paths`
+          },
+        },
+      }),
+      json(),
+      commonjs(),
+    ],
+    ...globalOptions,
+  });
+
+  /** @type {import("rollup").OutputOptions} */
+  const output = [
+    {
+      // Build file to be used as an ES import
+      file: `${destination}.js`,
+      format: "esm",
+      ...outputOptions,
+    },
+    {
+      // Build commonjs module (for tools that do not fully support ES6 modules)
+      file: `${destination}.cjs`,
+      format: "cjs",
+      ...outputOptions,
+    },
+  ];
+
+  if (!nodeOnly) {
+    output.push({
+      // Build file to be used for tinkering in modern browsers
+      file: `${destination}.browser.js`,
+      format: "iife",
+      ...outputOptions,
+      ...iifeOutputOptions,
+    });
+  }
+
+  // Non-babel builds
+  const config = defineConfig([{ ...commonConfig, output }]);
+
+  if (!nodeOnly) {
+    // Babel build
+    config.push({
+      ...commonConfig,
+      plugins: commonConfig.plugins.concat(
+        babel({
+          babelHelpers: "bundled",
+          extends: "@jspsych/config/babel",
+        })
+      ),
+      output: [
+        {
+          // Minified production build file
+          file: `${destination}.browser.min.js`,
+          format: "iife",
+          plugins: [terser()],
+          ...outputOptions,
+          ...iifeOutputOptions,
+        },
+      ],
+    });
+  }
+
+  return config;
+};
+
+/**
+ * Returns a Rollup configuration object for a JsPsych plugin or extension that is written in
+ * TypeScript
+ *
+ * @param {string} iifeName The variable name that will identify the plugin or extension in the
+ * global scope in browser builds
+ */
+export const makeRollupConfig = (iifeName) =>
+  makeConfig({
+    outputOptions: {
+      exports: "default",
+      globals: { jspsych: "jsPsychModule" },
+    },
+    globalOptions: { external: ["jspsych"] },
+    iifeOutputOptions: { name: iifeName },
+  });
+
+/**
+ * Returns the rollup configuration for the core `jspsych` package.
+ */
+export const makeCoreRollupConfig = () =>
+  makeConfig({
+    outputOptions: {
+      exports: "named",
+      name: "jsPsychModule",
+    },
+    iifeOutputOptions: { footer: "var initJsPsych = jsPsychModule.initJsPsych;" },
+  });
+
+/**
+ * Returns the rollup configuration for Node.js-only packages
+ */
+export const makeNodeRollupConfig = () =>
+  makeConfig({
+    globalOptions: { external: ["jspsych"] },
+    nodeOnly: true,
+  });

package/tsconfig.contrib.json

@@ -0,0 +1,10 @@
+{
+  // tsconfig for the jspsych-contrib monorepo
+  "extends": "@jspsych/config/tsconfig.json",
+  "compilerOptions": {
+    "paths": {
+      // map jspsych-contrib package imports directly to their source files
+      "@jspsych-contrib/*": ["../*/src"]
+    }
+  }
+}

package/tsconfig.core.json

@@ -0,0 +1,14 @@
+{
+  // tsconfig for the jsPsych monorepo
+  "extends": "@jspsych/config/tsconfig.json",
+  "compilerOptions": {
+    // map package imports directly to their source files
+    "paths": {
+      "jspsych": ["../jspsych/src"],
+      "@jspsych/*": ["../*/src"]
+    },
+    // allow resolving json modules in tests (needed for transitive imports of jspsych in tests;
+    // the jspsych package itself uses https://stackoverflow.com/a/61426303 instead)
+    "resolveJsonModule": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  // shared base tsconfig for all jsPsych packages
+  // based on https://github.com/formium/tsdx/blob/462af2d002987f985695b98400e0344b8f2754b7/templates/basic/tsconfig.json
+  // see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "ESNext",
+    "lib": ["dom", "esnext"],
+    "importHelpers": true,
+    // output .d.ts declaration files for consumers
+    "declaration": true,
+    // output .js.map sourcemap files for consumers
+    "sourceMap": true,
+    // stricter type-checking for stronger correctness. Recommended by TS
+    "strict": false, // should be enabled one lucky day
+    // linter checks for common issues
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
+    "noUnusedLocals": false, // should be enabled one lucky day
+    "noUnusedParameters": false, // should be enabled one lucky day
+    // use Node's module resolution algorithm, instead of the legacy TS one
+    "moduleResolution": "node",
+    // interop between ESM and CJS modules. Recommended by TS
+    "esModuleInterop": true,
+    // significant perf increase by skipping checking .d.ts files, particularly those in node_modules. Recommended by TS
+    "skipLibCheck": true,
+    // error out if import and file system have a casing mismatch. Recommended by TS
+    "forceConsistentCasingInFileNames": true,
+    // do not emit build output when running `tsc`
+    "noEmit": true
+  }
+}