From 9c7278a1c661d7c565fa7c033db0c02de1fe0188 Mon Sep 17 00:00:00 2001
From: "Pierre TOP (TOPI)" <ptop@octo.com>
Date: Tue, 26 Sep 2023 13:26:13 +0200
Subject: [PATCH] Allow ignoring tables

---
 .idea/GitLink.xml                            |   6 +
 .idea/codeStyles/Project.xml                 |  58 +++++++
 .idea/codeStyles/codeStyleConfig.xml         |   5 +
 .idea/inspectionProfiles/Project_Default.xml |   6 +
 .idea/vcs.xml                                |   7 +
 .idea/workspace.xml                          | 161 +++++++++++++++++++
 README.md                                    |  20 ++-
 rules/avoid-updating-all-rows.js             |  15 +-
 rules/avoid-updating-all-rows.test.js        |  21 ++-
 9 files changed, 294 insertions(+), 5 deletions(-)
 create mode 100644 .idea/GitLink.xml
 create mode 100644 .idea/codeStyles/Project.xml
 create mode 100644 .idea/codeStyles/codeStyleConfig.xml
 create mode 100644 .idea/inspectionProfiles/Project_Default.xml
 create mode 100644 .idea/vcs.xml
 create mode 100644 .idea/workspace.xml

diff --git a/.idea/GitLink.xml b/.idea/GitLink.xml
new file mode 100644
index 0000000..009597c
--- /dev/null
+++ b/.idea/GitLink.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="uk.co.ben_gibson.git.link.SettingsState">
+    <option name="host" value="72037fcc-cb9c-4c22-960a-ffe73fd5e229" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
new file mode 100644
index 0000000..e90c1a7
--- /dev/null
+++ b/.idea/codeStyles/Project.xml
@@ -0,0 +1,58 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+      <option name="HTML_ENFORCE_QUOTES" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>
\ No newline at end of file
diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml
new file mode 100644
index 0000000..79ee123
--- /dev/null
+++ b/.idea/codeStyles/codeStyleConfig.xml
@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>
\ No newline at end of file
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
new file mode 100644
index 0000000..03d9549
--- /dev/null
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..8306744
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
new file mode 100644
index 0000000..3a97fab
--- /dev/null
+++ b/.idea/workspace.xml
@@ -0,0 +1,161 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="4c19aab0-2a2f-4fb0-acf9-8a1f9cc56cda" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/rules/avoid-updating-all-rows.js" beforeDir="false" afterPath="$PROJECT_DIR$/rules/avoid-updating-all-rows.js" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/rules/avoid-updating-all-rows.test.js" beforeDir="false" afterPath="$PROJECT_DIR$/rules/avoid-updating-all-rows.test.js" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FormatOnSaveOptions">
+    <option name="myRunOnSave" value="true" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 7
+}</component>
+  <component name="ProjectId" id="2VkrICDW5O5kMPp5pHlweLfDf4D" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "RunOnceActivity.OpenProjectViewOnStart": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "WebServerToolWindowFactoryState": "false",
+    "git-widget-placeholder": "add-avoid-updating-all-rows",
+    "last_opened_file_path": "/home/octo-topi/Documents/Octo/Missions/Pix/repositories/eslint-plugin-knex/rules",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_interpreter_path": "/home/octo-topi/.nvm/versions/node/v18.18.0/bin/node",
+    "nodejs_package_manager_path": "yarn",
+    "settings.editor.selected.configurable": "actions.on.save",
+    "vue.rearranger.settings.migration": "true"
+  }
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/rules" />
+    </key>
+  </component>
+  <component name="RunManager">
+    <configuration name="test" type="js.build_tools.npm" temporary="true" nameIsGenerated="true">
+      <package-json value="$PROJECT_DIR$/package.json" />
+      <command value="run" />
+      <scripts>
+        <script value="test" />
+      </scripts>
+      <node-interpreter value="$USER_HOME$/.nvm/versions/node/v18.18.0/bin/node" />
+      <package-manager value="npm" />
+      <envs />
+      <method v="2" />
+    </configuration>
+    <recent_temporary>
+      <list>
+        <item itemvalue="npm.test" />
+      </list>
+    </recent_temporary>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="4c19aab0-2a2f-4fb0-acf9-8a1f9cc56cda" name="Changes" comment="" />
+      <created>1695390837462</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1695390837462</updated>
+      <workItem from="1695390840498" duration="6039000" />
+      <workItem from="1695411910801" duration="155000" />
+      <workItem from="1695412072158" duration="1148000" />
+      <workItem from="1695413226705" duration="4441000" />
+      <workItem from="1695714247236" duration="1826000" />
+      <workItem from="1695725997227" duration="1361000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="RECENT_FILTERS">
+      <map>
+        <entry key="Branch">
+          <value>
+            <list>
+              <RecentGroup>
+                <option name="FILTER_VALUES">
+                  <option value="HEAD" />
+                </option>
+              </RecentGroup>
+            </list>
+          </value>
+        </entry>
+      </map>
+    </option>
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State>
+              <option name="CUSTOM_BOOLEAN_PROPERTIES">
+                <map>
+                  <entry key="Show.Git.Branches" value="false" />
+                </map>
+              </option>
+              <option name="FILTERS">
+                <map>
+                  <entry key="branch">
+                    <value>
+                      <list>
+                        <option value="HEAD" />
+                      </list>
+                    </value>
+                  </entry>
+                </map>
+              </option>
+              <option name="SHOW_DETAILS_IN_CHANGES" value="false" />
+            </State>
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+  <component name="XDebuggerManager">
+    <breakpoint-manager>
+      <breakpoints>
+        <line-breakpoint type="javascript">
+          <url>file://$PROJECT_DIR$/rules/avoid-injections.js</url>
+          <line>31</line>
+          <option name="timeStamp" value="6" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="javascript">
+          <url>file://$PROJECT_DIR$/rules/avoid-updating-all-rows.js</url>
+          <line>22</line>
+          <properties lambdaOrdinal="-1" />
+          <option name="timeStamp" value="12" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="javascript">
+          <url>file://$PROJECT_DIR$/rules/avoid-updating-all-rows.js</url>
+          <line>20</line>
+          <properties lambdaOrdinal="-1" />
+          <option name="timeStamp" value="14" />
+        </line-breakpoint>
+      </breakpoints>
+    </breakpoint-manager>
+  </component>
+</project>
\ No newline at end of file
diff --git a/README.md b/README.md
index 8b3ac30..d222e8b 100644
--- a/README.md
+++ b/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"] } },
+    },
+  }
+}
+```
+
diff --git a/rules/avoid-updating-all-rows.js b/rules/avoid-updating-all-rows.js
index 18de8cf..f1c75e9 100644
--- a/rules/avoid-updating-all-rows.js
+++ b/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",
   });
 };
 
diff --git a/rules/avoid-updating-all-rows.test.js b/rules/avoid-updating-all-rows.test.js
index 4bfca35..b255092 100644
--- a/rules/avoid-updating-all-rows.test.js
+++ b/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"] } },
+          },
+        },
+      },
+    ),
+
   ],
 });