add some missing types for validation

sokra · sokra · commit 77b463bee4ba · 2018-05-17T11:00:16.000+02:00
diff --git a/declarations.d.ts b/declarations.d.ts
@@ -37,7 +37,7 @@ declare module "@webassemblyjs/ast" {
 			ModuleExport?: (p: NodePath<ModuleExport>) => void;
 			Start?: (p: NodePath<Start>) => void;
 		}
-	);
+	): void;
 	export class NodePath<T> {
 		node: T;
 	}
@@ -48,13 +48,15 @@ declare module "@webassemblyjs/ast" {
 	export class Start extends Node {
 		index: Identifier;
 	}
+	export class ModuleImportDescription {
+		type: string;
+		valtype?: string;
+		id?: Identifier;
+		signature?: Signature;
+	}
 	export class ModuleImport extends Node {
 		module: string;
-		descr: {
-			type: string;
-			valtype: string;
-			id: string;
-		};
+		descr: ModuleImportDescription;
 		name: string;
 	}
 	export class ModuleExport extends Node {
diff --git a/lib/ContextModule.js b/lib/ContextModule.js
@@ -10,6 +10,8 @@ const Module = require("./Module");
 const AsyncDependenciesBlock = require("./AsyncDependenciesBlock");
 const Template = require("./Template");
 
+/** @typedef {import("./dependencies/ContextElementDependency")} ContextElementDependency */
+
 class ContextModule extends Module {
 	// type ContextMode = "sync" | "eager" | "weak" | "async-weak" | "lazy" | "lazy-once"
 	// type ContextOptions = { resource: string, recursive: boolean, regExp: RegExp, addon?: string, mode?: ContextMode, chunkName?: string, include?: RegExp, exclude?: RegExp, groupOptions?: Object }
@@ -45,6 +47,9 @@ class ContextModule extends Module {
 			throw new Error("options.mode is a required option");
 
 		this._identifier = this._createIdentifier();
+
+		/** @type {ContextElementDependency[]} */
+		this.dependencies;
 	}
 
 	updateCacheModule(module) {
diff --git a/lib/DelegatedModule.js b/lib/DelegatedModule.js
@@ -56,7 +56,7 @@ class DelegatedModule extends Module {
 	}
 
 	source(depTemplates, runtime) {
-		const dep = this.dependencies[0];
+		const dep = /** @type {DelegatedSourceDependency} */ (this.dependencies[0]);
 		const sourceModule = dep.module;
 		let str;
 
diff --git a/lib/DependenciesBlock.js b/lib/DependenciesBlock.js
@@ -7,11 +7,16 @@
 const DependenciesBlockVariable = require("./DependenciesBlockVariable");
 
 /** @typedef {import("./ChunkGroup")} ChunkGroup */
+/** @typedef {import("./Dependency")} Dependency */
+/** @typedef {import("./AsyncDependenciesBlock")} AsyncDependenciesBlock */
 
 class DependenciesBlock {
 	constructor() {
+		/** @type {Dependency[]} */
 		this.dependencies = [];
+		/** @type {AsyncDependenciesBlock[]} */
 		this.blocks = [];
+		/** @type {TODO[]} */
 		this.variables = [];
 		// TODO remove this line, it's wrong
 		/** @type {ChunkGroup=} */
diff --git a/lib/Dependency.js b/lib/Dependency.js
@@ -7,11 +7,17 @@
 const compareLocations = require("./compareLocations");
 const DependencyReference = require("./dependencies/DependencyReference");
 
+/** @typedef {import("./Module")} Module */
+
 class Dependency {
 	constructor() {
+		/** @type {Module} */
 		this.module = null;
+		/** @type {boolean} */
 		this.weak = false;
+		/** @type {boolean} */
 		this.optional = false;
+		/** @type {TODO} */
 		this.loc = undefined;
 	}
 
diff --git a/lib/Module.js b/lib/Module.js
@@ -255,6 +255,10 @@ class Module extends DependenciesBlock {
 		}
 	}
 
+	/**
+	 * @param {string=} exportName the name of the export
+	 * @returns {boolean|string} false if the export isn't used, true if no exportName is provided and the module is used, or the name to access it if the export is used
+	 */
 	isUsed(exportName) {
 		if (!exportName) return this.used !== false;
 		if (this.used === null || this.usedExports === null) return exportName;
diff --git a/lib/dependencies/WebAssemblyImportDependency.js b/lib/dependencies/WebAssemblyImportDependency.js
@@ -8,11 +8,22 @@ const DependencyReference = require("./DependencyReference");
 const ModuleDependency = require("./ModuleDependency");
 const UnsupportedWebAssemblyFeatureError = require("../wasm/UnsupportedWebAssemblyFeatureError");
 
+/** @typedef {import("@webassemblyjs/ast").ModuleImportDescription} ModuleImportDescription */
+
 class WebAssemblyImportDependency extends ModuleDependency {
+	/**
+	 * @param {string} request the request
+	 * @param {string} name the imported name
+	 * @param {ModuleImportDescription} description the WASM ast node
+	 * @param {boolean} onlyDirectImport if only direct imports are allowed
+	 */
 	constructor(request, name, description, onlyDirectImport) {
 		super(request);
+		/** @type {string} */
 		this.name = name;
+		/** @type {ModuleImportDescription} */
 		this.description = description;
+		/** @type {boolean} */
 		this.onlyDirectImport = onlyDirectImport;
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class DelegatedModule extends Module {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`source(depTemplates, runtime) {`
`59`		`- const dep = this.dependencies[0];`
	`59`	`+ const dep = /** @type {DelegatedSourceDependency} */ (this.dependencies[0]);`
`60`	`60`	`const sourceModule = dep.module;`
`61`	`61`	`let str;`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -255,6 +255,10 @@ class Module extends DependenciesBlock {`
`255`	`255`	`}`
`256`	`256`	`}`
`257`	`257`
	`258`	`+ /**`
	`259`	`+ * @param {string=} exportName the name of the export`
	`260`	`+ * @returns {boolean\|string} false if the export isn't used, true if no exportName is provided and the module is used, or the name to access it if the export is used`
	`261`	`+ */`
`258`	`262`	`isUsed(exportName) {`
`259`	`263`	`if (!exportName) return this.used !== false;`
`260`	`264`	`if (this.used === null \|\| this.usedExports === null) return exportName;`