Add task-tags & ignore-overlong-task-comments settings (#1550)

astral-sh · Jan 4, 2023 · ca48492 · ca48492
1 parent 7c23701
commit ca48492
Show file tree

Hide file tree

Showing 17 changed files with 436 additions and 105 deletions.
diff --git a/README.md b/README.md
@@ -2224,6 +2224,27 @@ target-version = "py37"
 
 ---
 
+#### [`task-tags`](#task-tags)
+
+A list of task tags to recognize (e.g., "TODO", "FIXME", "XXX").
+
+Comments starting with these tags will be ignored by commented-out code
+detection (`ERA`), and skipped by line-length checks (`E501`) if
+`ignore-overlong-task-comments` is set to `true`.
+
+**Default value**: `["TODO", "FIXME", "XXX"]`
+
+**Type**: `Vec<String>`
+
+**Example usage**:
+
+```toml
+[tool.ruff]
+task-tags = ["HACK"]
+```
+
+---
+
 #### [`unfixable`](#unfixable)
 
 A list of check code prefixes to consider un-autofix-able.
@@ -2970,6 +2991,27 @@ staticmethod-decorators = ["staticmethod", "stcmthd"]
 
 ---
 
+### `pycodestyle`
+
+#### [`ignore-overlong-task-comments`](#ignore-overlong-task-comments)
+
+Whether or not line-length checks (`E501`) should be triggered for
+comments starting with `task-tags` (by default: ["TODO", "FIXME",
+and "XXX"]).
+
+**Default value**: `false`
+
+**Type**: `bool`
+
+**Example usage**:
+
+```toml
+[tool.ruff.pycodestyle]
+ignore-overlong-task-comments = true
+```
+
+---
+
 ### `pydocstyle`
 
 #### [`convention`](#convention)

diff --git a/flake8_to_ruff/src/converter.rs b/flake8_to_ruff/src/converter.rs
@@ -390,6 +390,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -402,6 +403,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });
@@ -450,6 +452,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -462,6 +465,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });
@@ -510,6 +514,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -522,6 +527,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });
@@ -570,6 +576,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -582,6 +589,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });
@@ -630,6 +638,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -647,6 +656,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });
@@ -699,6 +709,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -711,6 +722,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: Some(pydocstyle::settings::Options {
                 convention: Some(Convention::Numpy),
             }),
@@ -762,6 +774,7 @@ mod tests {
             src: None,
             target_version: None,
             unfixable: None,
+            task_tags: None,
             update_check: None,
             flake8_annotations: None,
             flake8_bugbear: None,
@@ -779,6 +792,7 @@ mod tests {
             isort: None,
             mccabe: None,
             pep8_naming: None,
+            pycodestyle: None,
             pydocstyle: None,
             pyupgrade: None,
         });

diff --git a/resources/test/fixtures/pycodestyle/E501_1.py b/resources/test/fixtures/pycodestyle/E501_1.py
@@ -0,0 +1,6 @@
+# TODO: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
+# TODO comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
+#     TODO    comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
+# FIXME: comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
+# FIXME comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
+#     FIXME    comments starting with one of the configured task-tags sometimes are longer than line-length so that you can easily find them with `git grep`
diff --git a/ruff.schema.json b/ruff.schema.json
@@ -288,6 +288,17 @@
         }
       }
     },
+    "pycodestyle": {
+      "description": "Options for the `pycodestyle` plugin.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Pycodestyle"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "pydocstyle": {
       "description": "Options for the `pydocstyle` plugin.",
       "anyOf": [
@@ -366,6 +377,16 @@
         }
       ]
     },
+    "task-tags": {
+      "description": "A list of task tags to recognize (e.g., \"TODO\", \"FIXME\", \"XXX\").\n\nComments starting with these tags will be ignored by commented-out code detection (`ERA`), and skipped by line-length checks (`E501`) if `ignore-overlong-task-comments` is set to `true`.",
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "type": "string"
+      }
+    },
     "unfixable": {
       "description": "A list of check code prefixes to consider un-autofix-able.",
       "type": [
@@ -1443,6 +1464,19 @@
       },
       "additionalProperties": false
     },
+    "Pycodestyle": {
+      "type": "object",
+      "properties": {
+        "ignore-overlong-task-comments": {
+          "description": "Whether or not line-length checks (`E501`) should be triggered for comments starting with `task-tags` (by default: [\"TODO\", \"FIXME\", and \"XXX\"]).",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "Pydocstyle": {
       "type": "object",
       "properties": {

diff --git a/src/checkers/lines.rs b/src/checkers/lines.rs
@@ -57,7 +57,7 @@ pub fn check_lines(
         }
 
         if enforce_line_too_long {
-            if let Some(check) = line_too_long(index, line, settings.line_length) {
+            if let Some(check) = line_too_long(index, line, settings) {
                 checks.push(check);
             }
         }

diff --git a/src/eradicate/checks.rs b/src/eradicate/checks.rs
@@ -31,7 +31,7 @@ pub fn commented_out_code(
     let line = locator.slice_source_code_range(&Range::new(location, end_location));
 
     // Verify that the comment is on its own line, and that it contains code.
-    if is_standalone_comment(&line) && comment_contains_code(&line) {
+    if is_standalone_comment(&line) && comment_contains_code(&line, &settings.task_tags[..]) {
         let mut check = Check::new(CheckKind::CommentedOutCode, Range::new(start, end));
         if matches!(autofix, flags::Autofix::Enabled)
             && settings.fixable.contains(&CheckCode::ERA001)