diff options
| author | Carlos Mateus <carlosmatateumateus@gmail.com> | 2024-06-16 16:26:57 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-16 17:26:57 +0300 |
| commit | b52519437fa214624f6a85debcfefc79e032294f (patch) | |
| tree | aca9fa0c9d00dd574af8d67a05d07f077f442638 | |
| parent | release script now opens a pr (diff) | |
| download | taskipy2-b52519437fa214624f6a85debcfefc79e032294f.zip | |
Add feature to suggest similar tasks when a task is not found (#78)
* Add feature to suggest similar tasks when a task is not found
* Add test for feature to suggest similar tasks when a task is not found
* Add a test for when a task is not found and there are no suggestions
* Fix lint
| -rw-r--r-- | taskipy/exceptions.py | 5 | ||||
| -rw-r--r-- | taskipy/task_runner.py | 8 | ||||
| -rw-r--r-- | tests/fixtures/project_with_tasks_suggestion/pyproject.toml | 7 | ||||
| -rw-r--r-- | tests/test_taskipy.py | 14 |
4 files changed, 32 insertions, 2 deletions
diff --git a/taskipy/exceptions.py b/taskipy/exceptions.py index affdd4e..ba0d24a 100644 --- a/taskipy/exceptions.py +++ b/taskipy/exceptions.py @@ -35,11 +35,14 @@ class MalformedPyProjectError(TaskipyError): class TaskNotFoundError(TaskipyError): exit_code = 127 - def __init__(self, task_name: str): + def __init__(self, task_name: str, suggestion: Optional[str] = None): super().__init__() self.task = task_name + self.suggestion = suggestion def __str__(self): + if self.suggestion: + return f'could not find task "{self.task}", did you mean "{self.suggestion}"?' return f'could not find task "{self.task}"' class MalformedTaskError(TaskipyError): diff --git a/taskipy/task_runner.py b/taskipy/task_runner.py index 561427e..ab81012 100644 --- a/taskipy/task_runner.py +++ b/taskipy/task_runner.py @@ -2,6 +2,7 @@ import sys import platform import signal import subprocess +from difflib import get_close_matches from pathlib import Path from types import FrameType from typing import Callable, Dict, List, Tuple, Union, Optional @@ -80,7 +81,12 @@ class TaskRunner: try: task = self.__project.tasks[task_name] except KeyError: - raise TaskNotFoundError(task_name) + suggestion = None + closest_match = get_close_matches(task_name, self.__project.tasks, n=1, cutoff=0.5) + + if closest_match: + suggestion = closest_match[0] + raise TaskNotFoundError(task_name, suggestion) return pre_task, task, post_task diff --git a/tests/fixtures/project_with_tasks_suggestion/pyproject.toml b/tests/fixtures/project_with_tasks_suggestion/pyproject.toml new file mode 100644 index 0000000..302e388 --- /dev/null +++ b/tests/fixtures/project_with_tasks_suggestion/pyproject.toml @@ -0,0 +1,7 @@ +[tool.poetry]
+name = "taskipy"
+description = "tasks runner for python projects"
+
+[tool.taskipy.tasks]
+exit_17 = "exit 17"
+print_hello_stdout = "echo 'hello stdout'"
diff --git a/tests/test_taskipy.py b/tests/test_taskipy.py index a9d0b2c..c8a314f 100644 --- a/tests/test_taskipy.py +++ b/tests/test_taskipy.py @@ -314,6 +314,20 @@ class TaskRunFailTestCase(TaskipyTestCase): self.assertSubstr('could not find task "task_that_does_not_exist"', stdout) self.assertEqual(exit_code, 127) + def test_exiting_with_code_127_and_printing_suggestion_if_task_not_found(self): + cwd = self.create_test_dir_from_fixture('project_with_tasks_suggestion') + exit_code, stdout, _ = self.run_task('stdout', cwd=cwd) + + self.assertSubstr('could not find task "stdout", did you mean "print_hello_stdout"?', stdout) + self.assertEqual(exit_code, 127) + + def test_exiting_with_code_127_and_printing_if_task_not_found_and_suggestion(self): + cwd = self.create_test_dir_from_fixture("project_with_tasks_suggestion") + exit_code, stdout, _ = self.run_task("task_that_does_not_exist", cwd=cwd) + + self.assertEqual('could not find task "task_that_does_not_exist"\n', stdout) + self.assertEqual(exit_code, 127) + def test_exiting_with_code_127_and_printing_if_no_arg_is_passed(self): cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks') executable_path = path.abspath('task') |