Implement ignore locations option (#92)

* Implement ignore locations option

* Fix types for plugin-rollup

* Fix Webpack types

* Cleanup root rollup.config.mjs (keep comments aswell for easier debugging)

* Release new transpiler

* publish transpiler/rollup/webpack

Author: kungfooman

@runtime-type-inspector/transpiler/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@runtime-type-inspector/transpiler",
-  "version": "2.2.2",
+  "version": "2.2.5",
   "description": "Validating JSDoc types at runtime for high-quality types - Trust is good, control is better.",
   "main": "index.cjs",
   "module": "index.mjs",
-  "types": "types.d.ts",
+  "types": "index.mjs",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kungfooman/RuntimeTypeInspector.js.git"
@@ -17,7 +17,7 @@
   "type": "module",
   "homepage": "https://github.com/kungfooman/RuntimeTypeInspector.js#readme",
   "dependencies": {
-    "@babel/core": "^7.2.0",
+    "@babel/parser": "^7.23.0",
     "@runtime-type-inspector/runtime": "^2.1.0",
     "typescript": "^5.1.6"
   },

plugin-rollup/index.mjs

@@ -3,19 +3,22 @@ import {
   addTypeChecks, expandType, compareAST, code2ast2code
 } from '@runtime-type-inspector/transpiler';
 /**
- * @typedef Options
+ * @typedef OptionsProps
  * @property {boolean} [enable] - Enable or disable entire plugin. Defaults to true.
  * @property {boolean} [selftest] - Every once in a while Babel changes the AST, so we
  * self-test Stringifier class to ensure its functionanlity.
  * @property {string[]} [ignoredFiles] - Ignore certain files which operate in a different
  * context, for example framework/parsers/draco-worker.js operates as WebWorker (without RTI).
  * @property {boolean} [validateDivision] - Whether divisions are validated. Defaults to true.
  */
+/**
+ * @typedef {OptionsProps & import('@runtime-type-inspector/transpiler').Options} Options
+ */
 /**
  * @param {Options} [options] - Optional options.
  * @returns {import('rollup').Plugin} The rollup plugin.
  */
-function runtimeTypeInspector({enable = true, selftest = false, ignoredFiles, validateDivision = true} = {}) {
+function runtimeTypeInspector({enable = true, selftest = false, ignoredFiles, ...options} = {}) {
   const filter = createFilter([
     '**/*.js'
   ], []);
@@ -37,10 +40,9 @@ function runtimeTypeInspector({enable = true, selftest = false, ignoredFiles, va
       }
       // todo expose options to rollup plugin
       code = addTypeChecks(code, {
-        validateDivision,
-        // ignoreLocations: ['Tensor#constructor'], // todo
         expandType,
         filename: id,
+        ...options
       });
       return {
         code,

plugin-rollup/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@runtime-type-inspector/plugin-rollup",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Rollup plugin for https://runtimetypeinspector.org/",
   "main": "index.mjs",
   "type": "module",
-  "types": "types.d.ts",
+  "types": "index.mjs",
   "author": "Hermann Rolfes (kungfooman)",
   "license": "MIT",
   "dependencies": {
-    "@runtime-type-inspector/transpiler": "^2.2.2",
+    "@runtime-type-inspector/transpiler": "^2.2.5",
     "rollup": "^3.29.4"
   }
 }

plugin-rollup/types.d.ts

@@ -1,9 +1,12 @@
 const {Compilation, Compiler} = require('webpack');
 /**
- * @typedef RuntimeTypeInspectorPluginOptions
+ * @typedef OptionsProps
  * @property {RegExp} [test] - Test for file extensions.
  * @property {RegExp} [exclude] - Test for exclusion.
  */
+/**
+ * @typedef {OptionsProps & import('@runtime-type-inspector/transpiler').Options} Options
+ */
 class RuntimeTypeInspectorPlugin {
   static pluginName = 'RuntimeTypeInspectorPlugin';
   // Default options
@@ -14,7 +17,7 @@ class RuntimeTypeInspectorPlugin {
     exclude: /node_modules/
   };
   /**
-   * @param {RuntimeTypeInspectorPluginOptions} options - The options.
+   * @param {Options} options - The options.
    */
   constructor(options) {
     Object.assign(this.options, options);

plugin-webpack4/index.cjs

@@ -1,12 +1,12 @@
 {
   "name": "@runtime-type-inspector/plugin-webpack4",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Webpack 4 plugin for https://runtimetypeinspector.org/",
   "main": "index.cjs",
   "author": "Hermann Rolfes (kungfooman)",
   "license": "MIT",
   "dependencies": {
-    "@runtime-type-inspector/transpiler": "^2.2.2",
+    "@runtime-type-inspector/transpiler": "^2.2.5",
     "loader-utils": "^2.0.4",
     "webpack": "^4.47.0"
   }

plugin-webpack4/package.json

@@ -1,9 +1,12 @@
 const {Compilation, Compiler} = require('webpack');
 /**
- * @typedef RuntimeTypeInspectorPluginOptions
+ * @typedef OptionsProps
  * @property {RegExp} [test] - Test for file extensions.
  * @property {RegExp} [exclude] - Test for exclusion.
  */
+/**
+ * @typedef {OptionsProps & import('@runtime-type-inspector/transpiler').Options} Options
+ */
 class RuntimeTypeInspectorPlugin {
   static pluginName = 'RuntimeTypeInspectorPlugin';
   // Default options
@@ -14,7 +17,7 @@ class RuntimeTypeInspectorPlugin {
     exclude: /node_modules/
   };
   /**
-   * @param {RuntimeTypeInspectorPluginOptions} options - The options.
+   * @param {Options} options - The options.
    */
   constructor(options) {
     Object.assign(this.options, options);

plugin-webpack5/index.cjs

@@ -1,12 +1,12 @@
 {
   "name": "@runtime-type-inspector/plugin-webpack5",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Webpack 5 plugin for https://runtimetypeinspector.org/",
   "main": "index.cjs",
   "author": "Hermann Rolfes (kungfooman)",
   "license": "MIT",
   "dependencies": {
-    "@runtime-type-inspector/transpiler": "^2.2.2",
+    "@runtime-type-inspector/transpiler": "^2.2.5",
     "loader-utils": "^2.0.4",
     "webpack": "^5.89.0"
   }

plugin-webpack5/package.json

@@ -13,21 +13,18 @@ import json from '@rollup/plugin-json';
 //import {addTypeChecks} from "./src-transpiler/typeInserter.mjs";
 //const {addTypeChecks} = await import("runtime-type-inspector/src-transpiler/typeInserter.mjs");
 import commonjs from '@rollup/plugin-commonjs';
-//import {runtimeTypeInspector} from './plugin-rollup/index.mjs';
 /** @typedef {import('rollup').RollupOptions} RollupOptions */
 /** @typedef {import('rollup').Plugin} Plugin */
 /** @typedef {import('rollup').OutputOptions} OutputOptions */
 /** @typedef {import('@rollup/plugin-babel').RollupBabelInputPluginOptions} RollupBabelInputPluginOptions */
 /**
  * The ES5 options for babel(...) plugin.
- *
- * @param {string} buildType - Only 'debug' requires special handling so far.
  * @returns {RollupBabelInputPluginOptions} The babel options.
  */
-const es5Options = buildType => ({
+const es5Options = () => ({
   babelHelpers: 'bundled',
   babelrc: false,
-  comments: buildType === 'debug' || buildType === 'rti',
+  comments: true,
   compact: false,
   minified: false,
   presets: [
@@ -44,14 +41,12 @@ const es5Options = buildType => ({
 });
 /**
  * The ES6 options for babel(...) plugin.
- *
- * @param {string} buildType - Only 'debug' requires special handling so far.
  * @returns {RollupBabelInputPluginOptions} The babel options.
  */
-const moduleOptions = buildType => ({
+const moduleOptions = () => ({
   babelHelpers: 'bundled',
   babelrc: false,
-  comments: buildType === 'debug',
+  comments: true,
   compact: false,
   minified: false,
   presets: [
@@ -134,7 +129,7 @@ function buildTarget(name, rootFile, path, buildType, moduleFormat) {
   };
   const babelOptions = {
     es5: es5Options(buildType),
-    es6: moduleOptions(buildType)
+    es6: moduleOptions()
   };
   return {
     input: rootFile,

rollup.config.mjs

@@ -16,6 +16,7 @@ import {Stringifier      } from './Stringifier.mjs';
  * @property {Function} [expandType] - A function that expands shorthand types into full descriptions.
  * @property {string} [filename] - The name of a file to which the instance pertains.
  * @property {boolean} [addHeader] - Whether to add import declarations headers. Defaults to true.
+ * @property {string[]} [ignoreLocations] - Ignore these locations because they are known false-positives.
  */
 class Asserter extends Stringifier {
   /**
@@ -27,6 +28,7 @@ class Asserter extends Stringifier {
     expandType = expandTypeDepFree,
     filename,
     addHeader = true,
+    ignoreLocations = [],
   } = {}) {
     super();
     this.forceCurly = forceCurly;
@@ -36,6 +38,7 @@ class Asserter extends Stringifier {
     this.expandType = expandType;
     this.filename = filename;
     this.addHeader = addHeader;
+    this.ignoreLocations = ignoreLocations;
   }
   /** @type {Record<string, Stat>} */
   stats = {
@@ -389,6 +392,10 @@ class Asserter extends Stringifier {
     const {spaces} = this;
     let out = '';
     let first = true;
+    const loc = this.getName(node);
+    if (this.ignoreLocations.includes(loc)) {
+      return '// IGNORE RTI TYPE VALIDATIONS, KNOWN ISSUES\n';
+    }
     //out += `${spaces}/*${spaces}  node.type=${node.type}\n${spaces}
     //  ${JSON.stringify(jsdoc)}\n${parent}\n${spaces}*/\n`;
     for (let name in jsdoc) {