type check source files

Author: fasttime

packages/eslint-scope/lib/definition.js

@@ -24,8 +24,11 @@
 
 import Variable from "./variable.js";
 
+/** @import * as types from "eslint-scope" */
+
 /**
  * @constructor Definition
+ * @implements {types.Definition}
  */
 class Definition {
     constructor(type, name, node, parent, index, kind) {

packages/eslint-scope/lib/index.js

@@ -55,6 +55,8 @@ import Variable from "./variable.js";
 
 import eslintScopeVersion from "./version.js";
 
+/** @import ESTree from "estree" */
+
 /**
  * Set the default options
  * @returns {Object} options
@@ -73,9 +75,9 @@ function defaultOptions() {
 
 /**
  * Preform deep update on option object
- * @param {Object} target Options
- * @param {Object} override Updates
- * @returns {Object} Updated options
+ * @param {Record<string, any>} target Options
+ * @param {Record<string, any>} override Updates
+ * @returns {Record<string, any>} Updated options
  */
 function updateDeeply(target, override) {
 
@@ -110,7 +112,7 @@ function updateDeeply(target, override) {
  * Main interface function. Takes an Espree syntax tree and returns the
  * analyzed scopes.
  * @function analyze
- * @param {espree.Tree} tree Abstract Syntax Tree
+ * @param {ESTree.Program} tree Abstract Syntax Tree
  * @param {Object} providedOptions Options that tailor the scope analysis
  * @param {boolean} [providedOptions.optimistic=false] the optimistic flag
  * @param {boolean} [providedOptions.ignoreEval=false] whether to check 'eval()' calls

packages/eslint-scope/lib/pattern-visitor.js

@@ -25,6 +25,8 @@
 import estraverse from "estraverse";
 import esrecurse from "esrecurse";
 
+/** @import * as types from "eslint-scope" */
+
 const { Syntax } = estraverse;
 
 /**
@@ -38,6 +40,7 @@ function getLast(xs) {
 
 /**
  * Visitor for destructuring patterns.
+ * @implements {types.PatternVisitor}
  */
 class PatternVisitor extends esrecurse.Visitor {
     static isPattern(node) {

packages/eslint-scope/lib/reference.js

@@ -22,13 +22,16 @@
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+/** @import * as types from "eslint-scope" */
+
 const READ = 0x1;
 const WRITE = 0x2;
 const RW = READ | WRITE;
 
 /**
  * A Reference represents a single occurrence of an identifier in code.
  * @constructor Reference
+ * @implements {types.Reference}
  */
 class Reference {
     constructor(ident, scope, flag, writeExpr, maybeImplicitGlobal, partial, init) {
@@ -62,7 +65,6 @@ class Reference {
          * The read-write mode of the reference. (Value is one of {@link
          * Reference.READ}, {@link Reference.RW}, {@link Reference.WRITE}).
          * @member {number} Reference#flag
-         * @private
          */
         this.flag = flag;
         if (this.isWrite()) {
@@ -94,7 +96,7 @@ class Reference {
      * @returns {boolean} static
      */
     isStatic() {
-        return !this.tainted && this.resolved && this.resolved.scope.isStatic();
+        return !this.tainted && !!this.resolved && this.resolved.scope.isStatic();
     }
 
     /**
@@ -145,19 +147,16 @@ class Reference {
 
 /**
  * @constant Reference.READ
- * @private
  */
 Reference.READ = READ;
 
 /**
  * @constant Reference.WRITE
- * @private
  */
 Reference.WRITE = WRITE;
 
 /**
  * @constant Reference.RW
- * @private
  */
 Reference.RW = RW;
 

packages/eslint-scope/lib/referencer.js

@@ -30,14 +30,17 @@ import PatternVisitor from "./pattern-visitor.js";
 import { Definition, ParameterDefinition } from "./definition.js";
 import { assert } from "./assert.js";
 
+/** @import * as types from "eslint-scope" */
+/** @import ESTree from "estree" */
+
 const { Syntax } = estraverse;
 
 /**
  * Traverse identifier in pattern
  * @param {Object} options options
- * @param {pattern} rootPattern root pattern
- * @param {Refencer} referencer referencer
- * @param {callback} callback callback
+ * @param {ESTree.Pattern} rootPattern root pattern
+ * @param {?Referencer} referencer referencer
+ * @param {types.PatternVisitorCallback} callback callback
  * @returns {void}
  */
 function traverseIdentifierInPattern(options, rootPattern, referencer, callback) {
@@ -209,7 +212,7 @@ class Referencer extends esrecurse.Visitor {
 
         /**
          * Visit pattern callback
-         * @param {pattern} pattern pattern
+         * @param {ESTree.Pattern} pattern pattern
          * @param {Object} info info
          * @returns {void}
          */

packages/eslint-scope/lib/scope-manager.js

@@ -38,8 +38,14 @@ import {
 } from "./scope.js";
 import { assert } from "./assert.js";
 
+/** @import * as types from "eslint-scope" */
+/** @import ESTree from "estree" */
+/** @import { Scope } from "./scope.js" */
+/** @import Variable from "./variable.js" */
+
 /**
  * @constructor ScopeManager
+ * @implements {types.ScopeManager}
  */
 class ScopeManager {
     constructor(options) {
@@ -72,10 +78,12 @@ class ScopeManager {
     }
 
     isImpliedStrict() {
-        return this.__options.impliedStrict;
+        return !!this.__options.impliedStrict;
     }
 
     isStrictModeSupported() {
+
+        // @ts-ignore -- if ecmaVersion is undefined, the comparison returns false.
         return this.__options.ecmaVersion >= 5;
     }
 
@@ -90,7 +98,7 @@ class ScopeManager {
      * "are declared by the node" means the node is same as `Variable.defs[].node` or `Variable.defs[].parent`.
      * If the node declares nothing, this method returns an empty array.
      * CAUTION: This API is experimental. See https://github.com/estools/escope/pull/69 for more details.
-     * @param {Espree.Node} node a node to get.
+     * @param {ESTree.Node} node a node to get.
      * @returns {Variable[]} variables that declared by the node.
      */
     getDeclaredVariables(node) {
@@ -100,7 +108,7 @@ class ScopeManager {
     /**
      * acquire scope from node.
      * @function ScopeManager#acquire
-     * @param {Espree.Node} node node for the acquired scope.
+     * @param {ESTree.Node} node node for the acquired scope.
      * @param {?boolean} [inner=false] look up the most inner scope, default value is false.
      * @returns {Scope?} Scope from node
      */
@@ -154,8 +162,8 @@ class ScopeManager {
     /**
      * acquire all scopes from node.
      * @function ScopeManager#acquireAll
-     * @param {Espree.Node} node node for the acquired scope.
-     * @returns {Scopes?} Scope array
+     * @param {ESTree.Node} node node for the acquired scope.
+     * @returns {Scope[]?} Scope array
      */
     acquireAll(node) {
         return this.__get(node);
@@ -164,7 +172,7 @@ class ScopeManager {
     /**
      * release the node.
      * @function ScopeManager#release
-     * @param {Espree.Node} node releasing node.
+     * @param {ESTree.Node} node releasing node.
      * @param {?boolean} [inner=false] look up the most inner scope, default value is false.
      * @returns {Scope?} upper scope for the node.
      */
@@ -189,6 +197,8 @@ class ScopeManager {
      * @returns {void}
      */
     addGlobals(names) {
+
+        // @ts-ignore -- globalScope must be set before this method is called.
         this.globalScope.__addVariables(names);
     }
 
@@ -254,6 +264,8 @@ class ScopeManager {
     }
 
     __isES6() {
+
+        // @ts-ignore -- if ecmaVersion is undefined, the comparison returns false.
         return this.__options.ecmaVersion >= 6;
     }
 }