browserEnv fixes

* window variables were not checked for exports
* window variable was populated incorrectly

Author: Extersky

.README/rules/require-jsdoc.md

@@ -22,7 +22,7 @@ be checked by the rule.
   - `ancestorsOnly` - Only check node ancestors to check if node is exported
   - `exports` - ESM exports are checked for JSDoc comments (Defaults to `true`)
   - `modules` - CommonJS exports are checked for JSDoc comments  (Defaults to `true`)
-  - `browserEnv` - Populates window variable
+  - `browserEnv` - Window global exports are checked for JSDoc comments
 
 - `require` - An object with the following optional boolean keys which all
     default to `false` except as noted:

README.md

@@ -3436,7 +3436,7 @@ be checked by the rule.
   - `ancestorsOnly` - Only check node ancestors to check if node is exported
   - `exports` - ESM exports are checked for JSDoc comments (Defaults to `true`)
   - `modules` - CommonJS exports are checked for JSDoc comments  (Defaults to `true`)
-  - `browserEnv` - Populates window variable
+  - `browserEnv` - Window global exports are checked for JSDoc comments
 
 - `require` - An object with the following optional boolean keys which all
     default to `false` except as noted:
@@ -3695,6 +3695,24 @@ export default class A {
 }
 // Options: [{"publicOnly":{"ancestorsOnly":true},"require":{"ClassDeclaration":true}}]
 // Message: Missing JSDoc comment.
+
+var test = function () {
+
+}
+// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
+// Message: Missing JSDoc comment.
+
+window.test = function () {
+
+}
+// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
+// Message: Missing JSDoc comment.
+
+function test () {
+
+}
+// Options: [{"publicOnly":{"browserEnv":true}}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:
@@ -4111,6 +4129,19 @@ export default class A {
 
 }
 // Options: [{"publicOnly":{"ancestorsOnly":true},"require":{"ClassDeclaration":true}}]
+
+/**
+ *
+ */
+var test = function () {
+
+}
+// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
+
+let test = function () {
+
+}
+// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
 ````
 
 

src/exportParser.js

@@ -111,7 +111,14 @@ const getSymbol = function (node, globals, scope, opt) {
   return null;
 };
 
-createSymbol = function (node, globals, value, scope) {
+const createBlockSymbol = function(block, name, value, globals, isGlobal) {
+  block.props[name] = value;
+  if (isGlobal && globals.props.window && globals.props.window.special) {
+    globals.props.window.props[name] = value;
+  }
+};
+
+createSymbol = function (node, globals, value, scope, isGlobal) {
   const block = scope || globals;
   let symbol;
   switch (node.type) {
@@ -124,13 +131,13 @@ createSymbol = function (node, globals, value, scope) {
     if (value) {
       const valueSymbol = getSymbol(value, globals, block);
       if (valueSymbol) {
-        block.props[node.name] = valueSymbol;
+        createBlockSymbol(block, node.name, valueSymbol, globals, isGlobal);
 
         return block.props[node.name];
       }
       debug('Identifier: Missing value symbol for %s', node.name);
     } else {
-      block.props[node.name] = createNode();
+      createBlockSymbol(block, node.name, createNode(), globals, isGlobal);
 
       return block.props[node.name];
     }
@@ -141,7 +148,7 @@ createSymbol = function (node, globals, value, scope) {
     const propertySymbol = getSymbol(node.property, globals, block, {simpleIdentifier: !node.computed});
     const propertyValue = getSymbolValue(propertySymbol);
     if (symbol && propertyValue) {
-      symbol.props[propertyValue] = getSymbol(value, globals, block);
+      createBlockSymbol(symbol, propertyValue, getSymbol(value, globals, block), globals, isGlobal);
 
       return symbol.props[propertyValue];
     }
@@ -204,12 +211,13 @@ const mapVariables = function (node, globals, opt) {
     break;
   } case 'VariableDeclaration': {
     node.declarations.forEach((declaration) => {
-      createSymbol(declaration.id, globals, declaration.init);
+      const isGlobal = opts.initWindow && node.kind === 'var' && globals.props.window;
+      createSymbol(declaration.id, globals, declaration.init, globals, isGlobal);
     });
     break;
   } case 'FunctionDeclaration': {
     if (node.id.type === 'Identifier') {
-      createSymbol(node.id, globals, node, globals);
+      createSymbol(node.id, globals, node, globals, true);
     }
     break;
   } case 'ExportDefaultDeclaration': {
@@ -302,6 +310,12 @@ const isNodeExported = function (node, globals, opt) {
     }
   }
 
+  if (opt.initWindow && globals.props.window) {
+    if (findNode(node, globals.props.window)) {
+      return true;
+    }
+  }
+
   if (opt.exports && findExportedNode(globals, node)) {
     return true;
   }
@@ -335,7 +349,8 @@ const parse = function (ast, node, opt) {
     globalVars.props.exports = globalVars.props.module.props.exports;
   }
   if (opts.initWindow) {
-    globalVars.props.window = globalVars;
+    globalVars.props.window = createNode();
+    globalVars.props.window.special = true;
   }
 
   if (opts.ancestorsOnly) {

test/rules/assertions/requireJsdoc.js

@@ -665,6 +665,69 @@ export default {
       parserOptions: {
         sourceType: 'module'
       }
+    },
+    {
+      code: `
+          var test = function () {
+
+          }
+      `,
+      errors: [{
+        message: 'Missing JSDoc comment.',
+        type: 'FunctionExpression'
+      }],
+      options: [{
+        publicOnly: {
+          browserEnv: true
+        },
+        require: {
+          FunctionExpression: true
+        }
+      }],
+      parserOptions: {
+        sourceType: 'module'
+      }
+    },
+    {
+      code: `
+          window.test = function () {
+
+          }
+      `,
+      errors: [{
+        message: 'Missing JSDoc comment.',
+        type: 'FunctionExpression'
+      }],
+      options: [{
+        publicOnly: {
+          browserEnv: true
+        },
+        require: {
+          FunctionExpression: true
+        }
+      }],
+      parserOptions: {
+        sourceType: 'module'
+      }
+    },
+    {
+      code: `
+          function test () {
+
+          }
+      `,
+      errors: [{
+        message: 'Missing JSDoc comment.',
+        type: 'FunctionDeclaration'
+      }],
+      options: [{
+        publicOnly: {
+          browserEnv: true
+        }
+      }],
+      parserOptions: {
+        sourceType: 'module'
+      }
     }
   ],
   valid: [{
@@ -1452,5 +1515,44 @@ export default {
     parserOptions: {
       sourceType: 'module'
     }
+  },
+  {
+    code: `
+      /**
+       *
+       */
+      var test = function () {
+
+      }
+    `,
+    options: [{
+      publicOnly: {
+        browserEnv: true
+      },
+      require: {
+        FunctionExpression: true
+      }
+    }],
+    parserOptions: {
+      sourceType: 'module'
+    }
+  },
+  {
+    code: `
+      let test = function () {
+
+      }
+    `,
+    options: [{
+      publicOnly: {
+        browserEnv: true
+      },
+      require: {
+        FunctionExpression: true
+      }
+    }],
+    parserOptions: {
+      sourceType: 'module'
+    }
   }]
 };