catch arbitrary route properties

chrisvfritz · chrisvfritz · commit 507fcde56d1b · 2016-10-13T02:35:04.000-04:00
diff --git a/rules/vue-router/arbitrary-route-properties.js b/rules/vue-router/arbitrary-route-properties.js
@@ -0,0 +1,18 @@
+'use strict'
+
+var chalk = require('chalk')
+
+module.exports = {
+  pattern: /\b(route\s*\.\s*)((?!(?:path|components?|instances|name|parent|redirect|matchAs|beforeEnter|meta|query|params|matched|router|subRoutes|fullPath))\w+)/,
+  warning: function (match, routeDot, property) {
+    return {
+      reason: 'Arbitrary route properties must now be scoped under the new meta property, to avoid conflicts with future features',
+      fix: (
+        'Replace ' + chalk.red(match) + ' with ' +
+        chalk.green(routeDot + 'meta.' + property) +
+        ', then also update the route option to be scoped under meta'
+      ),
+      docsHash: 'Arbitrary-Route-Properties'
+    }
+  }
+}
diff --git a/rules/vue-router/arbitrary-route-properties.spec.js b/rules/vue-router/arbitrary-route-properties.spec.js
@@ -0,0 +1,54 @@
+'use strict'
+
+const check = createRuleChecker('vue-router/arbitrary-route-properties')
+
+describe('Rule: arbitrary-route-properties', () => {
+  it('does not match an empty line', () => {
+    const warning = check('')
+    expect(warning).toBe(null)
+  })
+
+  it('does not match "route.meta"', () => {
+    const warning = check('route.meta')
+    expect(warning).toBe(null)
+  })
+
+  it('does not match "route.path"', () => {
+    const warning = check('route.path')
+    expect(warning).toBe(null)
+  })
+
+  it('does not match "route.query"', () => {
+    const warning = check('route.query')
+    expect(warning).toBe(null)
+  })
+
+  it('does not match "route.redirect"', () => {
+    const warning = check('route.query')
+    expect(warning).toBe(null)
+  })
+
+  it('matches "route.foo"', () => {
+    const warning = check(`
+      route.foo
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Replace route.foo with route.meta.foo, then also update the route option to be scoped under meta')
+  })
+
+  it('matches "route.foo.bar.baz"', () => {
+    const warning = check(`
+      route.foo.bar.baz
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Replace route.foo with route.meta.foo, then also update the route option to be scoped under meta')
+  })
+
+  it('matches "route.foo[1]"', () => {
+    const warning = check(`
+      route.foo[1]
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Replace route.foo with route.meta.foo, then also update the route option to be scoped under meta')
+  })
+})
