Skip to content

extract-todos v1.1 #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 26, 2024
Merged

extract-todos v1.1 #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
481a4bc
use cat not grep
jaschop-1k5o May 24, 2024
2a491ef
use file basename and customize header
jaschop-1k5o May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 25 additions & 14 deletions extract-todos/extract-todos.qml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@ import QOwnNotesTypes 1.0

Script {
property string subFolder;
property string headerText;
property variant settingsVariables: [
{
"identifier": "subFolder",
"name": "TODO Subfolder",
"description": "Restrict search for TODOs to this note subfolder.",
"type": "string",
"default": "",
}
"identifier": "subFolder",
"name": "TODO Subfolder",
"description": "Restrict search for TODOs to this note subfolder.",
"type": "string",
"default": "",
},
{
"identifier": "headerText",
"name": "Header Text",
"description": "Header text for your TODO listing",
"type": "string",
"default": "Open TODOs",
}
];

function init() {
Expand All @@ -19,13 +27,11 @@ Script {
}

function extractTodos() {

const path = script.currentNoteFolderPath() + "/" + subFolder;
const findResult = script.startSynchronousProcess("find", ["\(", "-name", "*.md", "-or", "-name", "*.txt", "\)", "-printf", "%P\n"], "", path);
const files = findResult.toString().split("\n");

const files = findResult.toString().split("\n");
const todoRegex = /^\s*- \[ \]\s*/;
var output = "<h1>Open TODOs</h1>\n";
var output = "<h1>" + headerText + "</h1>";

for (const i in files) {
const file = files[i];
Expand All @@ -35,17 +41,22 @@ Script {
.filter(s => s.match(todoRegex))
.map(s => s.replace(todoRegex, ""));
if (todos.length > 0) {
output += "<h3>" + file + "</h3><ul>\n";
output += "<h3>" + getBaseName(file) + "</h3><ul>";
for (const j in todos) {
output += "<p>" + todos[j] + "</p>\n";
output += "<p>" + todos[j] + "</p>";
}
output += "</ul>\n";
output += "</ul>";
}
}

script.setLabelText("extract todos", output);
}

function getBaseName(path) {
const fileName = path.slice(path.lastIndexOf("/") + 1);
const baseName = fileName.slice(0, fileName.indexOf("."));
return baseName;
}

function onNoteStored(note) { extractTodos() }
}

4 changes: 2 additions & 2 deletions extract-todos/info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"script": "extract-todos.qml",
"authors": ["@jaschop-1k5o"],
"platforms": ["linux"],
"version": "1.0",
"version": "1.1",
"minAppVersion": "24.5.1",
"description" : "Continuously scan your note folder for open TODOs, and display them in the scripting panel.\n\nTODOs are identified according to Markdown syntax, by lines starting with `- [ ]`\nScanning can be restricted to a subfolder.\n(Note: Script uses `find` and `grep` in the background.)"
"description" : "Continuously scan your note folder for open TODOs, and display them in the scripting panel.\n\nTODOs are identified according to Markdown syntax, by lines starting with `- [ ]`\nScanning can be restricted to a subfolder.\n(Note: Script uses `find` and `cat` in the background.)"
}