Add search Command for Simplified Task Filtering #450
+31
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
inkarkat
requested changes
Dec 27, 2024
There was a problem hiding this comment.
- 595fdea has already been merged; please rebase on top of it
- This PR also (accidentally?) includes the proposed (in Add a renameproj Command to Rename Project Tags #449) new
renameprojaction - New actions need to be covered by automated tests; the checklist in the PR template (that you've deleted!) asks for those.
I don't want to curb your enthusiasm, but this is a mature (and slow-moving) project. By first opening issues with your suggestions, you did the right thing; I'd recommend to first wait for (positive) feedback before proceeding with implementations.
| "search") | ||
| shift | ||
| if [ -z "$1" ]; then | ||
| die "usage: $TODO_SH search [KEYWORD...]" |
There was a problem hiding this comment.
Searching without any KEYWORD doesn't make sense, and the usage contradicts the check above.
| if [ -z "$1" ]; then | ||
| die "usage: $TODO_SH search [KEYWORD...]" | ||
| fi | ||
| grep -i "$@" "$TODO_FILE" |
There was a problem hiding this comment.
Unlike list, this doesn't do any numbering, formatting, and highlighting; this is just a plain grep?!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
###Pull Request Description:
This pull request introduces a new search command to the todo.txt-cli, designed to simplify the task filtering process.
###Problem:
The existing list command is versatile but can be complex for users when filtering tasks using multiple terms or regex. This complexity can deter new users from effectively using the CLI.
###Solution:
Introduced a new search command to make task filtering simple and intuitive.
The search command allows users to find tasks by specifying keywords directly, without requiring complex syntax.
###Example usage:
todo.sh search "keyword"
This displays all tasks containing the specified keyword(s).
Changes Made:
todo.sh:
Added a search action in the command handler.
Implemented filtering logic using grep to find matching tasks from todo.txt.
###Test Cases:
Created a new file test/search.test with test cases to ensure the functionality works correctly.
Verified edge cases such as no matches or invalid input.
###Documentation:
Updated README.md to include usage examples for the new search command.
###Example Output:
Input:
todo.sh search "meeting"
Output:
3 (A) Prepare for team meeting +work @office
7 Follow up after client meeting +work @email
###Impact:
Simplifies task filtering for users, especially beginners.
Improves the overall user experience and aligns with the goal of simplifying task management.
###Fixes #445