@runtime-type-inspector/plugin-rollup 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+Rollup plugin for `runtime-type-inspector`.
+
+Installation:
+
+```sh
+npm install @runtime-type-inspector/plugin-rollup
+```
+
+Integration into your build script:
+
+- todo link to PlayCanvas example repo rollup.config.mjs

package/index.mjs

@@ -0,0 +1,77 @@
+import {createFilter} from '@rollup/pluginutils';
+import {parse       } from '@babel/parser';
+import {
+  addTypeChecks, expandType,ast2jsonForComparison, code2ast2code
+} from '@runtime-type-inspector/transpiler';
+/**
+ * Alternatively "import * as rti from ..." would also prevent "Unused external imports" warning...
+ * or keeping log of every single call during RTI parsing.
+ * @param {boolean} validateDivision
+ */
+function getHeader(validateDivision) {
+  let header = "import { assertType, youCanAddABreakpointHere";
+  if (validateDivision) {
+    header += ", validateDivision";
+  }
+  header += ", registerTypedef, registerClass } from '@runtime-type-inspector/runtime';\n";
+  // Prevent tree-shaking in UMD build so we can always "add a breakpoint here".
+  header += "export * from '@runtime-type-inspector/runtime';\n";
+  return header;
+}
+/**
+ * @param {string} left
+ * @param {string} right
+ */
+function compareAST(left, right) {
+  const l = parse(left , {sourceType: 'module'});
+  const r = parse(right, {sourceType: 'module'});
+  const ljson = ast2jsonForComparison(l);
+  const rjson = ast2jsonForComparison(r);
+  const test = ljson == rjson;
+  if (!test) {
+    console.warn(`AST is NOT equal`);
+  }
+}
+/**
+ * @param {object} [options] - Optional options.
+ * @param {boolean} [options.enable] - Enable or disable entire plugin. Defaults to true.
+ * @param {boolean} [options.selftest] - Every once in a while Babel changes the AST, so we
+ * self-test Stringifier class to ensure its functionanlity.
+ * @param {string[]} [options.ignoredFiles] - Ignore certain files which operate in a different
+ * context, for example framework/parsers/draco-worker.js operates as WebWorker (without RTI).
+ * @returns {import('rollup').Plugin}
+ */
+function runtimeTypeInspector({enable = true, selftest = false, ignoredFiles} = {}) {
+  const filter = createFilter([
+    '**/*.js'
+  ], []);
+  return {
+    name: 'runtime-type-inspector',
+    transform(code, id) {
+      if (!enable || !filter(id)) {
+        return;
+      }
+      // Ignore files which are supposed to run in e.g. a Worker context without RTI
+      if (ignoredFiles?.some(_ => id.includes(_))) {
+        return;
+      }
+      if (selftest) {
+        compareAST(code, code2ast2code(code));
+      }
+      const validateDivision = true;
+      code = getHeader(validateDivision) + code;
+      // todo expose options to rollup plugin
+      code = addTypeChecks(code, {
+        validateDivision,
+        // ignoreLocations: ['Tensor#constructor'], // todo
+        expandType,
+        filename: id,
+      });
+      return {
+        code,
+        map: null
+      };
+    }
+  };
+}
+export {runtimeTypeInspector};

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@runtime-type-inspector/plugin-rollup",
+  "version": "1.0.0",
+  "description": "",
+  "module": "index.mjs",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Hermann Rolfes (kungfooman)",
+  "license": "MIT",
+  "dependencies": {
+    "@runtime-type-inspector/runtime": "^2.0.5",
+    "@runtime-type-inspector/transpiler": "^2.0.4",
+    "rollup": "^3.29.4"
+  }
+}