Marty/qownnotes-scripts
1
0
Fork 0
mirror of https://github.com/marty-oehme/scripts.git synced 2024-06-26 13:47:56 +00:00
Code Issues Projects Releases Wiki Activity

Added additional parameter parsing as new todo item.

Browse source 
Fixed bug where no project results in "undefined" project.

Added unfinished "importFromTaskwarrior" case. Also generalized few internal tasks into functions.

Written working Import from Taskwarrior action. Also updated description in info.json to reflect the changes.
This commit is contained in:
Filip Makowski 2017-06-02 18:41:47 +02:00
parent 9734a7f646
commit 7a1315b494
2 changed files with 99 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
taskwarrior/info.json
View file

@ -5,5 +5,5 @@
"version": "0.0.1",
"minAppVersion": "17.06.1",
"authors": ["@fmakowski"],
"description" : "This script creates menu items and buttons to import and export Taskwarrior tasks.\n\n<b>Dependencies</b>\n\nUnix-like OSes only!\n<a href=\"http://taskwarrior.org\">Taskwarrior</a>\n\n<b>Usage</b>\n\nThe script takes selected text from your note and parse it to create task entries based on it. The following rules currently apply for the test to be parsed correctly:\n * the project is defined by writing \"project:\" (case-insensitive) immediately followed by the project name; the rest of the line content is skipped\n * the task is defined by making a list item, using either - (minus) or * (asterisk) at the beginning; the task description taken will be used with the most recently detected project name to create a new task\n\n<b>To Do</b>\n\n * write \"import\" part of the script\n * foolproof used regexps\n * make project nesting easier\n * use headers to determine project name and nesting\n * Windows support"
"description" : "This script creates menu items and buttons to import and export Taskwarrior tasks.\n\n<b>Dependencies</b>\n\nUnix-like OSes only!\n<a href=\"http://taskwarrior.org\">Taskwarrior</a>\n\n<b>Usage</b>\n\n<i>Export:</i>\nThe script takes selected text from your note and parse it to create task entries based on it. The following rules currently apply for the test to be parsed correctly:\n * the project is defined by writing \"project:\" (case-insensitive) immediately followed by the project name; the rest of the line content is skipped\n * the task is defined by making a list item, using either - (minus) or * (asterisk) at the beginning; the task description taken will be used with the most recently detected project name to create a new task\n\n<i>Import:</i>\nThe script takes selected text from your note, parsing it into the project names you want to fetch from Taskwarrior into the note. The tasks will be written as a list right below the selection. The project names will be appended before the lists As \"Project: [projectName]\" to separate lists.<b>To Do</b>\n\n * foolproof used regexps\n * make project nesting easier\n * use headers to determine project name and nesting\n * Windows support\n * Taskwarrior parameter parsing (like tags, dates, priority, etc.)"
}

120
taskwarrior/taskwarrior.qml
View file

@ -14,7 +14,43 @@ QtObject {
script.registerCustomAction("exportToTaskwarrior", "Export selected list as Taskwarrior tasks", "Export to Taskwarrior");
// create a menu entry "Create meeting note" with a button and a freedesktop theme icon
// script.registerCustomAction("importFromTaskwarrior", "Import tasks from Taskwarrior as a list", "Import from Taskwarrior");
script.registerCustomAction("importFromTaskwarrior", "Import tasks from Taskwarrior as a list", "Import from Taskwarrior");
}
/**
* Get selected text and separate it by lines.
*
* @returns array of strings representing separate lines
*/
function getSelectedTextAndSeparateByNewline() {
var text = script.noteTextEditSelectedText();
var separatedByLines;
// Consider Windows different newline method.
if (script.platformIsWindows()) {
separatedByLines = text.split('\r\n');
} else {
separatedByLines = text.split('\n');
}
return separatedByLines;
}
/**
* Parse input string to get the project name and run supplied function if found.
*
* @param str input string which may contain project name
* @param func function to be executed if the project name is found
*
* @returns boolean for if the project name was detected or not
*/
function getProjectNameAndRun(str, func) {
// We are trying to get the name of the project.
// To do so, we are getting the substring of a line by using regexp group.
var projectRegExp = /project:[\s*]?(.+)?[\s*]?/i;
var isProjectName = projectRegExp.exec(str);
if (isProjectName) {
func(isProjectName[1]);
return true;
}
}
/**
@ -25,35 +61,23 @@ QtObject {
*/
function customActionInvoked(identifier) {
var pathToTaskwarrior = "/usr/bin/task";
switch (identifier) {
// export selected lines to Taskwarriors as tasks.
// The project name will be taken from "Project:" keyword detected in first lines.
case "exportToTaskwarrior":
// Get selected text and separate it by lines.
var text = script.noteTextEditSelectedText();
var separatedByLines;
// Consider Windows different newline method.
if (script.platformIsWindows()) {
separatedByLines = text.split('\r\n');
} else {
separatedByLines = text.split('\n');
}
// Starting with an empty default project name.
var projectName;
var projectName = "";
// For each line, we are gathering data to properly create tasks.
separatedByLines.forEach(function (line){
// We are trying to get the name of the project.
// To do so, we are getting the substring of a line by using regexp group.
var projectRegExp = /project:[\s*]?(.+)?[\s*]?/i;
var isProjectNameLine = projectRegExp.exec(line);
if (isProjectNameLine) {
projectName = isProjectNameLine[1];
getSelectedTextAndSeparateByNewline().forEach(function (line){
if (getProjectNameAndRun(line, function (proName) {
projectName = proName;
// We expect, that the project name would be the only thing in line, hence `return`.
return;
}
})) return;
// We are trying to get the task description.
// It should be started with either - (minus) or * (asterisk) to indicate list item.
@ -63,8 +87,7 @@ QtObject {
var isTask = taskRegExp.exec(line);
if (isTask) {
taskDescription = isTask[1];
script.log(taskDescription);
script.startDetachedProcess("/usr/bin/task",
script.startDetachedProcess(pathToTaskwarrior,
[
"add",
"pro:" + projectName,
@ -74,6 +97,59 @@ QtObject {
return;
}
});
break;
case "importFromTaskwarrior":
// Get selected text to determine the project we want to import from.
var projectNames = [];
getSelectedTextAndSeparateByNewline().forEach(function (line){
if (getProjectNameAndRun(line, function (proName) {
projectNames.push(proName);
})) return;
});
// To avoid overwriting what we have selected, we are simply writing it
script.noteTextEditWrite(script.noteTextEditSelectedText());
projectNames.forEach( function(projectName) {
var result = script.startSynchronousProcess(pathToTaskwarrior,
[
"pro:" + projectName,
"rc.report.next.columns=description",
"rc.report.next.labels=Desc"
],
"");
if (result) {
var tasksSeparated;
// The result does not contain any \n, so we are splitting by whitespace.
tasksSeparated = result.toString().split('\n');
tasksSeparated.splice(0, 1); // removing ""
if (tasksSeparated.length === 0) {
script.log("No entries");
return;
}
tasksSeparated.splice(0, 1); // removing "Desc"
tasksSeparated.splice(0, 1); // removing "----"
tasksSeparated.splice(tasksSeparated.length - 1, 1); // removing ""
tasksSeparated.splice(tasksSeparated.length - 1, 1); // removing "X tasks"
tasksSeparated.splice(tasksSeparated.length - 1, 1); // removing ""
script.noteTextEditWrite("\n");
script.noteTextEditWrite("Project: " + projectName + "\n\n");
tasksSeparated.forEach( function(taskDesc){
script.noteTextEditWrite("* " + taskDesc + "\n");
});
}
});
break;
}
}
}