runtime-type-inspector 2.0.2 → 3.2.2

package/README.md

@@ -34,8 +34,10 @@ https://www.youtube.com/watch?v=xOp3YWU6M1g
 
 # Installation
 
+Please take my two Pull Requests for [Transformers.js](https://github.com/xenova/transformers.js/pull/409) (using Webpack) and [PlayCanvas](https://github.com/playcanvas/engine/pull/5817) (using Rollup) as example.
+
 ```
-npm install runtime-type-inspector
+npm install @runtime-type-inspector/transpiler
 ```
 
 Live demo: https://runtimetypeinspector.org/
@@ -44,4 +46,30 @@ Thank you for reading and testing! You can also open DevTools and run:
 
 ```js
 console.log(rtiTranspiler)
-```
+```
+
+# Available NPM packages
+
+- https://www.npmjs.com/package/@runtime-type-inspector/runtime
+- https://www.npmjs.com/package/@runtime-type-inspector/transpiler
+- https://www.npmjs.com/package/@runtime-type-inspector/plugin-parcel1
+- https://www.npmjs.com/package/@runtime-type-inspector/parcel-transformer (Parcel v2)
+- https://www.npmjs.com/package/@runtime-type-inspector/plugin-rollup
+- https://www.npmjs.com/package/@runtime-type-inspector/plugin-webpack (version independent)
+- https://www.npmjs.com/package/@runtime-type-inspector/plugin-webpack4
+- https://www.npmjs.com/package/@runtime-type-inspector/plugin-webpack5
+
+# Acknowledgements
+
+We are incredibly grateful for the support and contribution of our funders, [Sovereign Tech Fund](https://www.sovereigntechfund.de/). We would like to thank them for their support and contribution towards making this project possible. Their partnership and generous funding have been instrumental in the success and realization of [RuntimeTypeInspector.js](https://github.com/kungfooman/RuntimeTypeInspector.js).
+
+![STF-Logo-Wide-Dark-RGB](https://github.com/kungfooman/RuntimeTypeInspector.js/assets/5236548/a5e5870c-2f93-4047-877f-21f823473a68)
+![STF-Logo-Wide-White-RGB](https://github.com/kungfooman/RuntimeTypeInspector.js/assets/5236548/94e790d9-9fda-4c17-a811-0af370d708b8)
+
+> Open source, a treasure trove for all to embrace,
+> 
+> But its potential is limited, without financial grace.
+> 
+> Let's urge our governments, to invest in its light,
+> 
+> For a resilient digital infrastructure, shining bright.

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "runtime-type-inspector",
-  "version": "2.0.2",
+  "version": "3.2.2",
   "description": "Validating JSDoc types at runtime for high-quality types - Trust is good, control is better.",
-  "main": "src-transpiler/index.mjs",
   "scripts": {
     "build": "rollup -c",
+    "watch": "rollup -c -w",
     "build:atBabelCore": "rollup -c --environment target:atBabelCore",
-    "lint": "eslint --ext .js,.mjs,.cjs src test"
+    "build:dts": "tsc src-transpiler/index.js --outDir types/transpiler --allowJs --declaration --emitDeclarationOnly --target esnext",
+    "build:types": "npm run build:dts && rollup -c --environment target:types",
+    "test": "npm run test:update && node test.js && node test_runtime.js",
+    "test:update": "node gen_tests.js > test/typechecking.json",
+    "lint": "eslint --ext .js,.mjs,.cjs src-transpiler src-runtime",
+    "docs": "jsdoc -c jsdoc.json"
   },
   "repository": {
     "type": "git",
@@ -17,9 +22,11 @@
   "bugs": {
     "url": "https://github.com/kungfooman/RuntimeTypeInspector.js/issues"
   },
+  "type": "module",
   "homepage": "https://github.com/kungfooman/RuntimeTypeInspector.js#readme",
+  "files": [],
   "devDependencies": {
-    "@babel/preset-env": "^7.22.20",
+    "@playcanvas/jsdoc-template": "^1.1.2",
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^25.0.4",
     "@rollup/plugin-json": "^6.0.0",
@@ -27,21 +34,25 @@
     "@rollup/plugin-strip": "^3.0.2",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/pluginutils": "^5.0.4",
-    "ace-builds": "^1.28.0",
+    "catharsis": "github:xenova/catharsis",
     "eslint": "^8.44.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jsdoc": "^46.6.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-tsimport-plugin": "^1.0.5",
     "rollup": "^3.29.0",
     "rollup-plugin-dts": "^6.0.1",
     "rollup-plugin-jscc": "^2.0.0",
     "rollup-plugin-visualizer": "^5.9.2",
     "to-fast-properties": "^4.0.0",
-    "@babel/helper-plugin-utils": "^7.22.5",
-    "@babel/parser": "^7.23.0",
-    "@babel/plugin-syntax-typescript": "^7.22.5"
-  },
-  "dependencies": {
-    "@babel/core": "^7.2.0",
-    "typescript": "^5.1.6"
+    "@runtime-type-inspector/runtime": "^3.2.2",
+    "@runtime-type-inspector/transpiler": "^3.2.2",
+    "@runtime-type-inspector/plugin-parcel1": "^3.2.2",
+    "@runtime-type-inspector/parcel-transformer": "^3.2.2",
+    "@runtime-type-inspector/plugin-rollup": "^3.2.2",
+    "@runtime-type-inspector/plugin-webpack": "^3.2.2",
+    "@runtime-type-inspector/plugin-webpack4": "^3.2.2",
+    "@runtime-type-inspector/plugin-webpack5": "^3.2.2",
+    "@runtime-type-inspector/repl": "^3.2.2"
   }
 }

package/.eslintrc.js

@@ -1,480 +0,0 @@
-module.exports = {
-
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "module",
-    "ecmaFeatures": {}
-  },
-
-  // Rules reference: https://eslint.org/docs/rules/
-  "rules": {
-    // Possible Problems
-    "array-callback-return": "error",
-    "constructor-super": "error",
-    "for-direction": "error",
-    "getter-return": "error",
-    "no-async-promise-executor": "error",
-    "no-await-in-loop": "error",
-    "no-class-assign": "error",
-    "no-compare-neg-zero": "error",
-    "no-cond-assign": "error",
-    "no-const-assign": "error",
-    "no-constant-binary-expression": "error",
-    "no-constant-condition": [
-      "error", {
-        "checkLoops": false
-      }
-    ],
-    "no-constructor-return": "error",
-    "no-control-regex": "error",
-    "no-debugger": "error",
-    "no-dupe-args": "error",
-    "no-dupe-class-members": "error",
-    "no-dupe-else-if": "error",
-    "no-dupe-keys": "error",
-    "no-duplicate-case": "error",
-    "no-duplicate-imports": "error",
-    "no-empty-character-class": "error",
-    "no-empty-pattern": "error",
-    "no-ex-assign": "error",
-    "no-fallthrough": "error",
-    "no-func-assign": "error",
-    "no-import-assign": "error",
-    "no-inner-declarations": "error",
-    "no-invalid-regexp": "error",
-    "no-irregular-whitespace": "error",
-    "no-loss-of-precision": "error",
-    "no-misleading-character-class": "error",
-    "no-new-native-nonconstructor": "error",
-    "no-new-symbol": "error",
-    "no-obj-calls": "error",
-    "no-promise-executor-return": "error",
-    "no-prototype-builtins": "off",
-    "no-self-assign": "error",
-    "no-self-compare": "error",
-    "no-setter-return": "error",
-    "no-sparse-arrays": "error",
-    "no-template-curly-in-string": "error",
-    "no-this-before-super": "error",
-    "no-undef": "error",
-    "no-unexpected-multiline": "error",
-    "no-unmodified-loop-condition": "error",
-    "no-unreachable": "error",
-    "no-unreachable-loop": "error",
-    "no-unsafe-finally": "error",
-    "no-unsafe-negation": "error",
-    "no-unsafe-optional-chaining": "error",
-    "no-unused-private-class-members": "error",
-    "no-unused-vars": [
-      "error", {
-        "args": "none"
-      }
-    ],
-    "no-use-before-define": [
-      "error", {
-        "functions": false
-      }
-    ],
-    "no-useless-backreference": "error",
-    "require-atomic-updates": "error",
-    "use-isnan": "error",
-    "valid-typeof": "error",
-
-    // Suggestions
-    "accessor-pairs": "error",
-    "arrow-body-style": "off",
-    "block-scoped-var": "error",
-    "camelcase": "off",
-    "capitalized-comments": "off",
-    "class-methods-use-this": "off",
-    "complexity": "off",
-    "consistent-return": "off",
-    "consistent-this": "off",
-    "curly": "off",
-    "default-case": "off",
-    "default-case-last": "off",
-    "default-param-last": "off",
-    "dot-notation": "error",
-    "eqeqeq": ["error", "smart"],
-    "func-name-matching": "error",
-    "func-names": "off",
-    "func-style": "off",
-    "grouped-accessor-pairs": ["error", "setBeforeGet"],
-    "guard-for-in": "off",
-    "id-denylist": "off",
-    "id-length": "off",
-    "id-match": "off",
-    "init-declarations": "off",
-    "logical-assignment-operators": "off",
-    "max-classes-per-file": "off",
-    "max-depth": "off",
-    "max-lines": "off",
-    "max-lines-per-function": "off",
-    "max-nested-callbacks": "off",
-    "max-params": "off",
-    "max-statements": "off",
-    "multiline-comment-style": ["warn", "separate-lines"],
-    "new-cap": "off",
-    "no-alert": "error",
-    "no-array-constructor": "error",
-    "no-bitwise": "off",
-    "no-caller": "error",
-    "no-case-declarations": "error",
-    "no-confusing-arrow": "error",
-    "no-console": "off",
-    "no-continue": "off",
-    "no-delete-var": "error",
-    "no-div-regex": "error",
-    "no-else-return": "error",
-    "no-empty": [
-      "error", {
-        "allowEmptyCatch": true
-      }
-    ],
-    "no-empty-function": "off",
-    "no-empty-static-block": "error",
-    "no-eq-null": "off",
-    "no-eval": "error",
-    "no-extend-native": "error",
-    "no-extra-bind": "error",
-    "no-extra-boolean-cast": "off",
-    "no-extra-label": "error",
-    "no-extra-semi": "error",
-    "no-floating-decimal": "error",
-    "no-global-assign": "error",
-    "no-implicit-coercion": "off",
-    "no-implicit-globals": "error",
-    "no-implied-eval": "error",
-    "no-inline-comments": "off",
-    "no-invalid-this": "off",
-    "no-iterator": "error",
-    "no-label-var": "error",
-    "no-labels": "error",
-    "no-lone-blocks": "error",
-    "no-lonely-if": "off",
-    "no-loop-func": "error",
-    "no-magic-numbers": "off",
-    "no-mixed-operators": "off",
-    "no-multi-assign": "off",
-    "no-multi-str": "error",
-    "no-negated-condition": "off",
-    "no-nested-ternary": "off",
-    "no-new": "warn",
-    "no-new-func": "error",
-    "no-new-object": "error",
-    "no-new-wrappers": "error",
-    "no-nonoctal-decimal-escape": "error",
-    "no-octal": "error",
-    "no-octal-escape": "error",
-    "no-param-reassign": "off",
-    "no-plusplus": "off",
-    "no-proto": "error",
-    "no-redeclare": "error",
-    "no-regex-spaces": "error",
-    "no-restricted-exports": "error",
-    "no-restricted-globals": "off",
-    "no-restricted-imports": "error",
-    "no-restricted-properties": "off",
-    "no-restricted-syntax": "error",
-    "no-return-assign": "error",
-    "no-script-url": "error",
-    "no-sequences": "error",
-    "no-shadow": "off",
-    "no-shadow-restricted-names": "error",
-    "no-ternary": "off",
-    "no-throw-literal": "error",
-    "no-undef-init": "error",
-    "no-undefined": "off",
-    "no-underscore-dangle": "off",
-    "no-unneeded-ternary": "error",
-    "no-unused-expressions": "error",
-    "no-unused-labels": "error",
-    "no-useless-call": "error",
-    "no-useless-catch": "error",
-    "no-useless-computed-key": "error",
-    "no-useless-concat": "error",
-    "no-useless-constructor": "error",
-    "no-useless-escape": "off",
-    "no-useless-rename": "error",
-    "no-useless-return": "error",
-    "no-var": "off", // update to error
-    "no-void": "error",
-    "no-warning-comments": "off",
-    "no-with": "error",
-    "object-shorthand": "off",
-    "one-var": "off",
-    "one-var-declaration-per-line": "off",
-    "operator-assignment": ["error", "always"],
-    "prefer-arrow-callback": "off",
-    "prefer-const": "error",
-    "prefer-destructuring": "off",
-    "prefer-exponentiation-operator": "off",
-    "prefer-named-capture-group": "off",
-    "prefer-numeric-literals": "error",
-    "prefer-object-has-own": "off",
-    "prefer-object-spread": "off",
-    "prefer-promise-reject-errors": "error",
-    "prefer-regex-literals": "off",
-    "prefer-rest-params": "off",
-    "prefer-spread": "warn",
-    "prefer-template": "off",
-    "quote-props": "off",
-    "radix": "error",
-    "require-await": "error",
-    "require-unicode-regexp": "off",
-    "require-yield": "error",
-    "sort-imports": "off",
-    "sort-keys": "off",
-    "sort-vars": "off",
-    "spaced-comment": [
-      "error", "always", {
-        "exceptions": ["/"]
-      }
-    ],
-    "strict": "error",
-    "symbol-description": "error",
-    "vars-on-top": "off",
-    "yoda": "error",
-
-    // Layout & Formatting
-    "array-bracket-newline": ["error", "consistent"],
-    "array-bracket-spacing": ["error", "never"],
-    "array-element-newline": "off",
-    "arrow-parens": [
-      "error", "as-needed", {
-        "requireForBlockBody": true
-      }
-    ],
-    "arrow-spacing": "error",
-    "block-spacing": "error",
-    "brace-style": "error",
-    "comma-dangle": ["error", "never"],
-    "comma-spacing": [
-      "error", {
-        "before": false,
-        "after": true
-      }
-    ],
-    "comma-style": ["error", "last"],
-    "computed-property-spacing": ["error", "never"],
-    "dot-location": ["error", "property"],
-    "eol-last": ["error", "always"],
-    "func-call-spacing": ["error", "never"],
-    "function-call-argument-newline": "off",
-    "function-paren-newline": "off",
-    "generator-star-spacing": "error",
-    "implicit-arrow-linebreak": "error",
-    "indent": [
-      "error", 2, {
-        "SwitchCase": 1,
-        "CallExpression": {
-          "arguments": "first"
-        },
-        "ignoreComments": true
-      }
-    ],
-    "jsx-quotes": "off",
-    "key-spacing": [
-      "error", {
-        "beforeColon": false,
-        "afterColon": true
-      }
-    ],
-    "keyword-spacing": [
-      "error", {
-        "before": true,
-        "after": true
-      }
-    ],
-    "line-comment-position": "off",
-    "linebreak-style": "off",
-    "lines-around-comment": "off",
-    "lines-between-class-members": ["error", "always"],
-    "max-len": "off",
-    "max-statements-per-line": "off",
-    "multiline-ternary": "off",
-    "new-parens": "error",
-    "newline-per-chained-call": "off",
-    "no-extra-parens": ["error", "functions"],
-    "no-mixed-spaces-and-tabs": "error",
-    "no-multi-spaces": [
-      "error", {
-        "ignoreEOLComments": true,
-        "exceptions": {
-          "ArrayExpression": true,
-          "AssignmentExpression": true,
-          "BinaryExpression": true,
-          "IfStatement": true,
-          "LogicalExpression": true,
-          "SwitchCase": true,
-          "VariableDeclarator": true
-        }
-      }
-    ],
-    "no-multiple-empty-lines": [
-      "error", {
-        "max": 2,
-        "maxBOF": 0,
-        "maxEOF": 0
-      }
-    ],
-    "no-tabs": "error",
-    "no-trailing-spaces": "error",
-    "no-whitespace-before-property": "error",
-    "nonblock-statement-body-position": "off",
-    "object-curly-newline": [
-      "error", {
-        "consistent": true
-      }
-    ],
-    "object-curly-spacing": ["error", "always"],
-    "object-property-newline": [
-      "error", {
-        "allowAllPropertiesOnSameLine": true
-      }
-    ],
-    "operator-linebreak": ["error", "after"],
-    "padded-blocks": [
-      "error", {
-        "classes": "never"
-      }
-    ],
-    "padding-line-between-statements": "off",
-    "quotes": ["off", "single"],
-    "rest-spread-spacing": "error",
-    "semi": ["error", "always"],
-    "semi-spacing": [
-      "error", {
-        "before": false,
-        "after": true
-      }
-    ],
-    "semi-style": ["error", "last"],
-    "space-before-blocks": "error",
-    "space-before-function-paren": [
-      "error", {
-        "anonymous": "always",
-        "named": "never"
-      }
-    ],
-    "space-in-parens": ["error", "never"],
-    "space-infix-ops": [
-      "error", {
-        "int32Hint": false
-      }
-    ],
-    "space-unary-ops": [
-      "error", {
-        "words": true,
-        "nonwords": false,
-        "overrides": {
-        }
-    }],
-    "switch-colon-spacing": [
-      "error", {
-        "after": true,
-        "before": false
-      }
-    ],
-    "template-curly-spacing": "error",
-    "template-tag-spacing": "error",
-    "unicode-bom": ["error", "never"],
-    "wrap-iife": "off",
-    "wrap-regex": "off",
-    "yield-star-spacing": "error",
-
-    // Import rules
-
-    // Static analysis
-    "import/default": "error",
-    "import/named": "error",
-    "import/namespace": "error",
-    "import/no-unresolved": "error",
-
-    // Helpful warnings
-    "import/export": "error",
-    "import/no-named-as-default": "warn",
-    "import/no-named-as-default-member": "warn",
-
-    // Style guide
-    "import/extensions": ["error", "always", { "ts": "never", "tsx": "never" }],
-    "import/no-duplicates": "warn",
-
-    // JSDoc rules
-    "jsdoc/check-access": "error",
-    "jsdoc/check-alignment": "error",
-    "jsdoc/check-examples": "off",
-    "jsdoc/check-indentation": "off",
-    "jsdoc/check-line-alignment": "error",
-    "jsdoc/check-param-names": "off",
-    "jsdoc/check-property-names": "error",
-    "jsdoc/check-syntax": "error",
-    "jsdoc/check-tag-names": "error",
-    "jsdoc/check-types": "off",
-    "jsdoc/check-values": "error",
-    "jsdoc/empty-tags": "error",
-    "jsdoc/implements-on-classes": "error",
-    "jsdoc/informative-docs": "off",
-    "jsdoc/match-description": "off",
-    "jsdoc/match-name": "off",
-    "jsdoc/multiline-blocks": "error",
-    "jsdoc/no-bad-blocks": "error",
-    "jsdoc/no-blank-block-descriptions": "error",
-    "jsdoc/no-blank-blocks": "error",
-    "jsdoc/no-defaults": "error",
-    "jsdoc/no-missing-syntax": "off",
-    "jsdoc/no-multi-asterisks": "error",
-    "jsdoc/no-restricted-syntax": "off",
-    "jsdoc/no-types": "off",
-    "jsdoc/no-undefined-types": "off",
-    "jsdoc/require-asterisk-prefix": "error",
-    "jsdoc/require-description": "off",
-    "jsdoc/require-description-complete-sentence": [
-      "off", {
-        "abbreviations": ["e.g."]
-      }
-    ],
-    "jsdoc/require-example": "off",
-    "jsdoc/require-file-overview": "off",
-    "jsdoc/require-hyphen-before-param-description": ["error", "always"],
-    "jsdoc/require-jsdoc": "off",
-    "jsdoc/require-param": "error",
-    "jsdoc/require-param-description": "error",
-    "jsdoc/require-param-name": "error",
-    "jsdoc/require-param-type": "error",
-    "jsdoc/require-property": "error",
-    "jsdoc/require-property-description": "error",
-    "jsdoc/require-property-name": "error",
-    "jsdoc/require-property-type": "error",
-    "jsdoc/require-returns": "error",
-    "jsdoc/require-returns-check": "error",
-    "jsdoc/require-returns-description": "error",
-    "jsdoc/require-returns-type": "error",
-    "jsdoc/require-throws": "off",
-    "jsdoc/require-yields": "error",
-    "jsdoc/require-yields-check": "error",
-    "jsdoc/sort-tags": "off",
-    "jsdoc/tag-lines": "off",
-    "jsdoc/text-escaping": "off",
-    "jsdoc/valid-types": "off"
-  },
-
-  "plugins": [
-    "import",
-    "jsdoc"
-  ],
-
-  "settings": {
-    "jsdoc": {
-      "mode": "typescript"
-    }
-  },
-
-  "env": {
-    "browser": true,
-    "es2022": true,
-    "node": true,
-    "worker": true
-  }
-
-};

package/jsconfig.json

@@ -1,10 +0,0 @@
-{
-    "compilerOptions": {
-        "checkJs": true,
-        "target": "ES2022",
-        "strict": true,
-        "moduleResolution": "nodenext",
-        "noImplicitOverride": true,
-        "module": "es2022"
-    }
-}

package/plugin-parcel/index.mjs

@@ -1,4 +0,0 @@
-function runtimeTypeInspector({enable = true, selftest = false, ignoredFiles} = {}) {
-    throw "unimplemented";
-}
-export {runtimeTypeInspector};