feat(rule): add no-globals-in-created

Author: clarkdo

docs/rules/no-globals-in-created.md

@@ -0,0 +1,38 @@
+# nuxt/no-globals-in-created
+
+> disallow `window/document` in `created/beforeCreate`
+
+- :gear: This rule is included in `"plugin:nuxt/ssr"`.
+
+## Rule Details
+
+This rule is for preventing using `window/document` in `created/beforeCreate`, since `created/beforeCreate` may be executed in server side in SSR.
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+export default {
+  created() {
+    window.foo = 'bar'
+  }
+}
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+export default {
+  created() {
+    const foo = 'bar'
+  }
+}
+
+```
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/nuxt/eslint-plugin-nuxt/blob/master/lib/rules/no-globals-in-created.js)
+- [Test source](https://github.com/nuxt/eslint-plugin-nuxt/blob/master/lib/rules/__test__/no-globals-in-created.test.js)

lib/configs/ssr.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: require.resolve('./base.js'),
+  rules: {
+    'nuxt/no-globals-in-created': 'warn'
+  }
+}

lib/rules/__test__/no-globals-in-created.test.js

@@ -0,0 +1,109 @@
+/**
+ * @fileoverview disallow `window/document` in `created/beforeCreate`
+ * @author Clark Du
+ */
+'use strict'
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+var rule = require('../no-globals-in-created')
+
+var RuleTester = require('eslint').RuleTester
+
+const parserOptions = {
+  ecmaVersion: 2018,
+  sourceType: 'module'
+}
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+var ruleTester = new RuleTester()
+ruleTester.run('no-globals-in-created', rule, {
+
+  valid: [
+    {
+      filename: 'test.vue',
+      code: `
+        export default {
+          created() {
+            const path = this.$route.path
+          },
+          beforeCreate() {
+            const path = this.$route.params.foo
+          }
+        }
+      `,
+      parserOptions
+    }
+  ],
+
+  invalid: [
+    {
+      filename: 'test.vue',
+      code: `
+        export default {
+          created() {
+            const path = window.location.pathname
+          },
+          beforeCreate() {
+            const foo = document.foo
+          }
+        }
+      `,
+      errors: [{
+        message: 'Unexpected window in created.',
+        type: 'MemberExpression'
+      }, {
+        message: 'Unexpected document in beforeCreate.',
+        type: 'MemberExpression'
+      }],
+      parserOptions
+    },
+    {
+      filename: 'test.vue',
+      code: `
+        export default {
+          created() {
+            document.foo = 'bar'
+          },
+          beforeCreate() {
+            window.foo = 'bar'
+          }
+        }
+      `,
+      errors: [{
+        message: 'Unexpected document in created.',
+        type: 'MemberExpression'
+      }, {
+        message: 'Unexpected window in beforeCreate.',
+        type: 'MemberExpression'
+      }],
+      parserOptions
+    },
+    {
+      filename: 'test.vue',
+      code: `
+        export default {
+          created() {
+            return window.foo
+          },
+          beforeCreate() {
+            return document.foo
+          }
+        }
+      `,
+      errors: [{
+        message: 'Unexpected window in created.',
+        type: 'MemberExpression'
+      }, {
+        message: 'Unexpected document in beforeCreate.',
+        type: 'MemberExpression'
+      }],
+      parserOptions
+    }
+  ]
+})

lib/rules/__test__/no-this-in-async-data.test.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Prevent using this in asyncData
+ * @fileoverview disallow `this` in asyncData
  * @author Clark Du
  */
 'use strict'

lib/rules/__test__/no-this-in-fetch.test.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Prevent using this in fetch
+ * @fileoverview disallow `this` in fetch
  * @author Clark Du
  */
 'use strict'

lib/rules/no-globals-in-created.js

@@ -0,0 +1,74 @@
+/**
+ * @fileoverview disallow `window/document` in `created/beforeCreate`
+ * @author Clark Du
+ */
+'use strict'
+
+const utils = require('../utils')
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    docs: {
+      description: 'disallow `window/document` in `created/beforeCreate`',
+      category: 'ssr'
+    },
+    fixable: null, // or "code" or "whitespace"
+    schema: [
+      // fill in your schema
+    ],
+    messages: {
+      noGlobals: 'Unexpected {{name}} in {{funcName}}.'
+    }
+  },
+
+  create: function (context) {
+    const forbiddenNodes = []
+    const options = context.options[0] || {}
+
+    const HOOKS = new Set(
+      ['created', 'beforeCreate'].concat(options.methods || [])
+    )
+    const GLOBALS = ['window', 'document']
+
+    function isGlobals (name) {
+      return GLOBALS.includes(name)
+    }
+
+    return {
+      MemberExpression (node) {
+        if (!node.object) return
+
+        const name = node.object.name
+
+        if (isGlobals(name)) {
+          forbiddenNodes.push({ name, node })
+        }
+      },
+      VariableDeclarator (node) {
+        if (!node.init) return
+
+        const name = node.init.name
+
+        if (isGlobals(name)) {
+          forbiddenNodes.push({ name, node })
+        }
+      },
+      ...utils.executeOnVue(context, obj => {
+        for (const { funcName, name, node } of utils.getParentFuncs(obj, HOOKS, forbiddenNodes)) {
+          context.report({
+            node,
+            messageId: 'noGlobals',
+            data: {
+              name,
+              funcName
+            }
+          })
+        }
+      })
+    }
+  }
+}

lib/utils/index.js

@@ -2,11 +2,35 @@ const utils = require('eslint-plugin-vue/lib/utils')
 
 module.exports = Object.assign(
   {
-    getFuncNodeWithName (node, name) {
-      return node.properties.find(item => item.type === 'Property' &&
-        utils.getStaticPropertyName(item) === name &&
-        (item.value.type === 'ArrowFunctionExpression' || item.value.type === 'FunctionExpression')
+    getProperties (node, names) {
+      return node.properties.filter(
+        p => p.type === 'Property' && (!names.size || names.has(utils.getStaticPropertyName(p.key)))
       )
+    },
+    getFuncNodeWithName (rootNode, name) {
+      return this.getProperties(rootNode, [name]).filter(
+        item => item.value.type === 'ArrowFunctionExpression' || item.value.type === 'FunctionExpression'
+      )
+    },
+    * getParentFuncs (rootNode, parentNames, childNodes) {
+      const nodes = this.getProperties(rootNode, parentNames)
+
+      for (const item of nodes) {
+        for (const { name, node: child } of childNodes) {
+          const funcName = utils.getStaticPropertyName(item.key)
+          if (!funcName) continue
+
+          if (item.value.type === 'FunctionExpression') {
+            if (
+              child &&
+              child.loc.start.line >= item.value.loc.start.line &&
+              child.loc.end.line <= item.value.loc.end.line
+            ) {
+              yield { name, node: child, funcName }
+            }
+          }
+        }
+      }
     }
   },
   utils