catch store.watch with string argument

chrisvfritz · chrisvfritz · commit 60a8cccf8fc6 · 2016-10-22T20:41:15.000-04:00
diff --git a/rules/vuex/store-watch-with-string.js b/rules/vuex/store-watch-with-string.js
@@ -0,0 +1,14 @@
+'use strict'
+
+module.exports = {
+  pattern: /\bstore\s*.\s*watch\s*\(\s*['"`]/,
+  warning: function (match) {
+    return {
+      reason: 'The new store.watch takes a function as the first argument, allowing you to watch not only state, but also custom getters',
+      fix: (
+        'Update store.watch to use a function rather than a string path for the first argument (see link below for an example)'
+      ),
+      docsHash: 'store-watch-with-String-Property-Path-deprecated'
+    }
+  }
+}
diff --git a/rules/vuex/store-watch-with-string.spec.js b/rules/vuex/store-watch-with-string.spec.js
@@ -0,0 +1,63 @@
+'use strict'
+
+const check = createRuleChecker('vuex/store-watch-with-string')
+
+describe('Rule: store-watch-with-string', () => {
+  it('does not match an empty line', () => {
+    const warning = check('')
+    expect(warning).toBe(null)
+  })
+
+  it('does not match store.watch with no arguments', () => {
+    const warning = check(`
+      store.watch(
+    `)
+    expect(warning).toBe(null)
+  })
+
+  it('does not match store.watch with arrow function arg', () => {
+    const warning = check(`
+      store.watch(state => {
+    `)
+    expect(warning).toBe(null)
+  })
+
+  it('does not match store.watch with regular function arg', () => {
+    const warning = check(`
+      store.watch(function (state) {
+    `)
+    expect(warning).toBe(null)
+  })
+
+  it('matches store.watch with a string argument', () => {
+    const warning = check(`
+      store.watch('user.notifications', callback)
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Update store.watch to use a function rather than a string path for the first argument (see link below for an example)')
+  })
+
+  it('matches store.watch with a string argument and a bunch of spaces', () => {
+    const warning = check(`
+      store . watch ( 'user.notifications' , callback)
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Update store.watch to use a function rather than a string path for the first argument (see link below for an example)')
+  })
+
+  it('matches store.watch with a string argument using double quotes', () => {
+    const warning = check(`
+      store.watch('user.notifications', callback)
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Update store.watch to use a function rather than a string path for the first argument (see link below for an example)')
+  })
+
+  it('matches store.watch with a string argument using backticks', () => {
+    const warning = check(`
+      store.watch(\`user.notifications\`, callback)
+    `)
+    expect(warning).toBeTruthy()
+    expect(warning.fix).toBe('Update store.watch to use a function rather than a string path for the first argument (see link below for an example)')
+  })
+})
