Allow ignoring tables

README.md

@@ -42,4 +42,22 @@ include the library itself (`knex`), but also transaction variables (`trx`,
 
 ### `knex/avoid-injections`
 
-Avoid some issues related to SQL injection by disallowing plain strings as the query argument to the raw queries. Check out [the tests](https://github.com/AntonNiklasson/eslint-plugin-knex/blob/master/rules/avoid-injections.test.js) to get a sense for what is valid and not.
+Avoid some issues related to SQL injection by disallowing plain strings as the query argument to the raw queries. Check
+out [the tests](https://github.com/AntonNiklasson/eslint-plugin-knex/blob/master/rules/avoid-injections.test.js) to get
+a sense for what is valid and not.
+
+### `knex/avoid-updating-all-rows`
+
+Avoid updating all rows of a table when unwanted.
+You can ignore tables for which it is a legitimate usage.
+
+```
+{
+  settings: {
+    knex: {
+      rule: { "avoid-updating-all-rows": { tablesToIgnore: ["author"] } },
+    },
+  }
+}
+```
+

rules/avoid-updating-all-rows.js

@@ -8,18 +8,27 @@ const meta = {
   },
 };
 
-const create = function (context) {
+const create = function(context) {
   return {
     [`CallExpression[callee.property.name='update'][callee.object.callee.name='knex']`](node) {
       check(context, node);
     },
   };
 };
-const check = function (context, node) {
+const check = function(context, node) {
+
+  if (context.settings && context.settings.knex && context.settings.knex.rule) {
+    const ruleSettings = context.settings.knex.rule["avoid-updating-all-rows"];
+    const tablesToIgnore = ruleSettings.tablesToIgnore;
+    const tableToUpdate = node.callee.object.arguments[0].value;
+    if (tablesToIgnore.includes(tableToUpdate)) {
+      return;
+    }
+  }
 
   context.report({
     node,
-    messageId: "avoid"
+    messageId: "avoid",
   });
 };
 

rules/avoid-updating-all-rows.test.js

@@ -16,10 +16,29 @@ const tester = new RuleTester({
 });
 
 tester.run("avoid-updating-all-rows", rule, {
-  valid: ["knex('books').where({id:1}).update({'status': 'archived'})"],
+  valid: ["knex('books').where({id:1}).update({'status': 'archived'})",
+    {
+      code: "knex('books').update({'status': 'archived'})",
+      settings: {
+        knex: {
+          rule: { "avoid-updating-all-rows": { tablesToIgnore: ["books"] } },
+        },
+      },
+    }],
   invalid: [
     invalidCase("knex('books').update({'status': 'archived'})", [
       { messageId: "avoid" },
     ]),
+    invalidCase("knex('books').update({'status': 'archived'})", [
+        { messageId: "avoid" }],
+      {
+        settings: {
+          knex: {
+            rule: { "avoid-updating-all-rows": { tablesToIgnore: ["author"] } },
+          },
+        },
+      },
+    ),
+
   ],
 });