@runtime-type-inspector/plugin-parcel1 1.0.1 → 3.0.0

package/README.md

@@ -1,6 +1,6 @@
-This is the plugin for Parcel v1.
+# Plugin for Parcel v1
 
-It's a two-step process to install it:
+For integrating this plugin follow this process:
 
 1) `npm install --save-dev @runtime-type-inspector/plugin-parcel1`
 
@@ -10,3 +10,17 @@ It's a two-step process to install it:
 const bundler = new Bundler(entryFiles, options);
 bundler.addAssetType('js', require.resolve('@runtime-type-inspector/plugin-parcel1'));
 ```
+
+3) Make sure to declare RTI as globals:
+
+```html
+<script src="/node_modules/@runtime-type-inspector/runtime/index.cjs"></script>
+<script>
+  Object.assign(window, rtiRuntime);
+</script>
+<script src="./build/out.js"></script>
+```
+
+This is *kind of ugly*, but Parcel v1 simply doesn't seem to support adding import declarations inside a plugin. If I will find a possibility, I will fix this.
+
+Parcel also drops files that export nothing, but given the nature of JSDoc comments in combination of RTI, a comment is converted into `registerTypedef(...)` for example. This means that typedefs in such files will simply be unregistered, causing runtime type errors (because it's an unknown type). Make sure to process such files individually and add them into the final `out.js`.

package/index.cjs

@@ -6,7 +6,7 @@ class JSAssetRuntimeTypeInspector extends JSAsset {
    * @returns {Promise<void>}
    */
   async pretransform() {
-    this.contents = addTypeChecks(this.contents, {expandType});
+    this.contents = addTypeChecks(this.contents, {expandType, addHeader: false});
     // continue the normal flow
     return await super.pretransform();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runtime-type-inspector/plugin-parcel1",
-  "version": "1.0.1",
+  "version": "3.0.0",
   "description": "RuntimeTypeInspector.js plugin for Parcel v1",
   "main": "index.cjs",
   "publishConfig": {"access": "public"},
@@ -9,6 +9,6 @@
   "license": "MIT",
   "dependencies": {
     "parcel-bundler": "^1.12.5",
-    "@runtime-type-inspector/transpiler": "^2.2.5"
+    "@runtime-type-inspector/transpiler": "^3.0.0"
   }
 }