Enable checkJs (#648)

* Add more ts-checks

* cover extattrs

* cover more

* Enable checkJs

* Add .js to import()

* TODO:

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/*
 !dist/package.json
+.vscode/

jsconfig.json

@@ -2,7 +2,8 @@
   "compilerOptions": {
     "target": "es2020",
     "module": "es2020",
-    "moduleResolution": "node"
+    "moduleResolution": "node",
+    "checkJs": true
   },
   "include": [
     "lib/"

lib/error.js

@@ -28,12 +28,16 @@ function contextAsText(node) {
  * @typedef {object} WebIDL2ErrorOptions
  * @property {"error" | "warning"} [level]
  * @property {Function} [autofix]
+ * @property {string} [ruleName]
  *
  * @typedef {ReturnType<typeof error>} WebIDLErrorData
  *
  * @param {string} message error message
+ * @param {*} position
+ * @param {*} current
+ * @param {*} message
  * @param {"Syntax" | "Validation"} kind error type
- * @param {WebIDL2ErrorOptions} [options]
+ * @param {WebIDL2ErrorOptions=} options
  */
 function error(
   source,
@@ -52,6 +56,12 @@ function error(
       : source.slice(Math.max(position + count, 0), position);
   }
 
+  /**
+   * @param {import("./tokeniser.js").Token[]} inputs
+   * @param {object} [options]
+   * @param {boolean} [options.precedes]
+   * @returns
+   */
   function tokensToText(inputs, { precedes } = {}) {
     const text = inputs.map((t) => t.trivia + t.value).join("");
     const nextToken = source[position];

lib/productions/argument.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { Base } from "./base.js";
 import { Default } from "./default.js";
 import { ExtendedAttributes } from "./extended-attributes.js";
@@ -18,7 +16,7 @@ import {
 
 export class Argument extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const start_position = tokeniser.position;

lib/productions/array-base.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 export class ArrayBase extends Array {
   constructor({ source, tokens }) {
     super();

lib/productions/attribute.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import { validationError } from "../error.js";
 import { idlTypeIncludesDictionary } from "../validators/helpers.js";
 import { Base } from "./base.js";

lib/productions/base.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 export class Base {
   /**
    * @param {object} initializer

lib/productions/callback-interface.js

@@ -1,12 +1,10 @@
-// @ts-check
-
 import { Container } from "./container.js";
 import { Operation } from "./operation.js";
 import { Constant } from "./constant.js";
 
 export class CallbackInterface extends Container {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser, callback, { partial = null } = {}) {
     const tokens = { callback };

lib/productions/constructor.js

@@ -3,7 +3,7 @@ import { argument_list, autoParenter } from "./helpers.js";
 
 export class Constructor extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const base = tokeniser.consume("constructor");
@@ -31,9 +31,6 @@ export class Constructor extends Base {
   }
 
   *validate(defs) {
-    if (this.idlType) {
-      yield* this.idlType.validate(defs);
-    }
     for (const argument of this.arguments) {
       yield* argument.validate(defs);
     }

lib/productions/container.js

@@ -18,9 +18,8 @@ function inheritance(tokeniser) {
 
 export class Container extends Base {
   /**
-   * @template T
    * @param {import("../tokeniser.js").Tokeniser} tokeniser
-   * @param {T} instance
+   * @param {*} instance TODO: This should be {T extends Container}, but see https://github.com/microsoft/TypeScript/issues/4628
    * @param {*} args
    */
   static parse(tokeniser, instance, { inheritable, allowedMembers }) {

lib/productions/default.js

@@ -3,7 +3,7 @@ import { const_data, const_value } from "./helpers.js";
 
 export class Default extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const assign = tokeniser.consume("=");
@@ -50,7 +50,7 @@ export class Default extends Base {
     return const_data(this.expression[0]).negative;
   }
 
-  /** @param {import("../writer.js").Writer)} w */
+  /** @param {import("../writer.js").Writer} w */
   write(w) {
     return w.ts.wrap([
       w.token(this.tokens.assign),

lib/productions/dictionary.js

@@ -1,11 +1,9 @@
-// @ts-check
-
 import { Container } from "./container.js";
 import { Field } from "./field.js";
 
 export class Dictionary extends Container {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    * @param {object} [options]
    * @param {import("../tokeniser.js").Token} [options.partial]
    */

lib/productions/enum.js

@@ -2,9 +2,9 @@ import { list, unescape, autoParenter } from "./helpers.js";
 import { WrappedToken } from "./token.js";
 import { Base } from "./base.js";
 
-class EnumValue extends WrappedToken {
+export class EnumValue extends WrappedToken {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const value = tokeniser.consumeKind("string");
@@ -36,7 +36,7 @@ class EnumValue extends WrappedToken {
 
 export class Enum extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     /** @type {Base["tokens"]} */

lib/productions/extended-attributes.js

@@ -5,7 +5,7 @@ import { list, argument_list, autoParenter, unescape } from "./helpers.js";
 import { validationError } from "../error.js";
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  * @param {string} tokenName
  */
 function tokens(tokeniser, tokenName) {
@@ -26,15 +26,17 @@ const shouldBeLegacyPrefixed = [
 ];
 
 const renamedLegacies = new Map([
-  ...shouldBeLegacyPrefixed.map((name) => [name, `Legacy${name}`]),
+  .../** @type {[string, string][]} */ (
+    shouldBeLegacyPrefixed.map((name) => [name, `Legacy${name}`])
+  ),
   ["NamedConstructor", "LegacyFactoryFunction"],
   ["OverrideBuiltins", "LegacyOverrideBuiltIns"],
   ["TreatNullAs", "LegacyNullToEmptyString"],
 ]);
 
 /**
  * This will allow a set of extended attribute values to be parsed.
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  */
 function extAttrListItems(tokeniser) {
   for (const syntax of extAttrValueSyntax) {
@@ -48,9 +50,9 @@ function extAttrListItems(tokeniser) {
   );
 }
 
-class ExtendedAttributeParameters extends Base {
+export class ExtendedAttributeParameters extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const tokens = { assign: tokeniser.consume("=") };
@@ -100,7 +102,7 @@ class ExtendedAttributeParameters extends Base {
     return null;
   }
 
-  /** @param {import("../writer.js").Writer)} w */
+  /** @param {import("../writer.js").Writer} w */
   write(w) {
     const { rhsType } = this;
     return w.ts.wrap([
@@ -120,7 +122,7 @@ class ExtendedAttributeParameters extends Base {
 
 export class SimpleExtendedAttribute extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const name = tokeniser.consumeKind("identifier");
@@ -194,7 +196,7 @@ information.`;
     }
   }
 
-  /** @param {import("../writer.js").Writer)} w */
+  /** @param {import("../writer.js").Writer} w */
   write(w) {
     return w.ts.wrap([
       w.ts.trivia(this.tokens.name.trivia),
@@ -226,13 +228,13 @@ function renameLegacyExtendedAttribute(extAttr) {
 // seems to be used
 export class ExtendedAttributes extends ArrayBase {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     const tokens = {};
     tokens.open = tokeniser.consume("[");
-    if (!tokens.open) return new ExtendedAttributes({});
     const ret = new ExtendedAttributes({ source: tokeniser.source, tokens });
+    if (!tokens.open) return ret;
     ret.push(
       ...list(tokeniser, {
         parser: SimpleExtendedAttribute.parse,
@@ -262,7 +264,7 @@ export class ExtendedAttributes extends ArrayBase {
     }
   }
 
-  /** @param {import("../writer.js").Writer)} w */
+  /** @param {import("../writer.js").Writer} w */
   write(w) {
     if (!this.length) return "";
     return w.ts.wrap([

lib/productions/field.js

@@ -9,7 +9,7 @@ import { Default } from "./default.js";
 
 export class Field extends Base {
   /**
-   * @param {import("../tokeniser").Tokeniser} tokeniser
+   * @param {import("../tokeniser.js").Tokeniser} tokeniser
    */
   static parse(tokeniser) {
     /** @type {Base["tokens"]} */

lib/productions/helpers.js

@@ -17,7 +17,7 @@ export function unescape(identifier) {
 
 /**
  * Parses comma-separated list
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  * @param {object} args
  * @param {Function} args.parser parser function for each item
  * @param {boolean} [args.allowDangler] whether to allow dangling comma
@@ -46,7 +46,7 @@ export function list(tokeniser, { parser, allowDangler, listName = "list" }) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  */
 export function const_value(tokeniser) {
   return (
@@ -86,7 +86,7 @@ export function const_data({ type, value }) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  */
 export function primitive_type(tokeniser) {
   function integer_type() {
@@ -109,7 +109,7 @@ export function primitive_type(tokeniser) {
   }
 
   const { source } = tokeniser;
-  const num_type = integer_type(tokeniser) || decimal_type(tokeniser);
+  const num_type = integer_type() || decimal_type();
   if (num_type) return num_type;
   const base = tokeniser.consume(
     "bigint",
@@ -124,7 +124,7 @@ export function primitive_type(tokeniser) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  */
 export function argument_list(tokeniser) {
   return list(tokeniser, {
@@ -134,8 +134,8 @@ export function argument_list(tokeniser) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
- * @param {string} typeName
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
+ * @param {string=} typeName (TODO: See Type.type for more details)
  */
 export function type_with_extended_attributes(tokeniser, typeName) {
   const extAttrs = ExtendedAttributes.parse(tokeniser);
@@ -145,8 +145,8 @@ export function type_with_extended_attributes(tokeniser, typeName) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
- * @param {string} typeName
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
+ * @param {string=} typeName (TODO: See Type.type for more details)
  */
 export function return_type(tokeniser, typeName) {
   const typ = Type.parse(tokeniser, typeName || "return-type");
@@ -165,7 +165,7 @@ export function return_type(tokeniser, typeName) {
 }
 
 /**
- * @param {import("../tokeniser").Tokeniser} tokeniser
+ * @param {import("../tokeniser.js").Tokeniser} tokeniser
  */
 export function stringifier(tokeniser) {
   const special = tokeniser.consume("stringifier");
@@ -202,8 +202,7 @@ export function getMemberIndentation(parentTrivia) {
 }
 
 /**
- * @param {object} def
- * @param {import("./extended-attributes.js").ExtendedAttributes} def.extAttrs
+ * @param {import("./interface.js").Interface} def
  */
 export function autofixAddExposedWindow(def) {
   return () => {
@@ -257,7 +256,7 @@ export function findLastIndex(array, predicate) {
 
 /**
  * Returns a proxy that auto-assign `parent` field.
- * @template T
+ * @template {Record<string | symbol, any>} T
  * @param {T} data
  * @param {*} [parent] The object that will be assigned to `parent`.
  *                     If absent, it will be `data` by default.
@@ -273,17 +272,18 @@ export function autoParenter(data, parent) {
     // `autoParenter(parse())` where the function may return nothing.
     return data;
   }
-  return new Proxy(data, {
+  const proxy = new Proxy(data, {
     get(target, p) {
       const value = target[p];
-      if (Array.isArray(value)) {
+      if (Array.isArray(value) && p !== "source") {
         // Wraps the array so that any added items will also automatically
         // get their `parent` values.
         return autoParenter(value, target);
       }
       return value;
     },
     set(target, p, value) {
+      // @ts-ignore https://github.com/microsoft/TypeScript/issues/47357
       target[p] = value;
       if (!value) {
         return true;
@@ -300,4 +300,5 @@ export function autoParenter(data, parent) {
       return true;
     },
   });
+  return proxy;
 }