1
0
silverbullet/plugs/tasks/task.ts

337 lines
9.3 KiB
TypeScript
Raw Normal View History

2022-10-14 13:11:33 +00:00
import type {
ClickEvent,
IndexTreeEvent,
QueryProviderEvent,
} from "$sb/app_event.ts";
2022-03-28 13:25:05 +00:00
2023-08-28 15:12:15 +00:00
import { editor, index, markdown, space, sync } from "$sb/syscalls.ts";
2022-10-14 13:11:33 +00:00
2022-04-11 18:34:09 +00:00
import {
addParentPointers,
collectNodesMatching,
findNodeOfType,
findParentMatching,
2022-04-11 18:34:09 +00:00
nodeAtPos,
ParseTree,
2022-04-25 08:33:38 +00:00
renderToText,
2022-07-04 09:30:30 +00:00
replaceNodesMatching,
2023-07-26 15:12:56 +00:00
traverseTreeAsync,
2022-10-14 13:11:33 +00:00
} from "$sb/lib/tree.ts";
import { applyQuery, removeQueries } from "$sb/lib/query.ts";
import { niceDate } from "$sb/lib/dates.ts";
2023-07-24 17:54:31 +00:00
import { extractAttributes } from "$sb/lib/attribute.ts";
import { rewritePageRefs } from "$sb/lib/resolve.ts";
2023-08-28 15:12:15 +00:00
import { indexAttributes } from "../index/attributes.ts";
2022-03-28 13:25:05 +00:00
export type Task = {
name: string;
done: boolean;
state: string;
2022-04-11 18:34:09 +00:00
deadline?: string;
2022-07-04 09:30:30 +00:00
tags?: string[];
2022-04-04 09:51:41 +00:00
nested?: string;
// Not saved in DB, just added when pulled out (from key)
pos?: number;
page?: string;
2023-07-24 17:54:31 +00:00
} & Record<string, any>;
2022-03-28 13:25:05 +00:00
function getDeadline(deadlineNode: ParseTree): string {
return deadlineNode.children![0].text!.replace(/📅\s*/, "");
}
const completeStates = ["x", "X"];
const incompleteStates = [" "];
export async function indexTasks({ name, tree }: IndexTreeEvent) {
2022-10-14 13:11:33 +00:00
const tasks: { key: string; value: Task }[] = [];
const taskStates = new Map<string, number>();
removeQueries(tree);
addParentPointers(tree);
2023-08-01 19:35:19 +00:00
const allAttributes: Record<string, any> = {};
2023-07-26 15:12:56 +00:00
await traverseTreeAsync(tree, async (n) => {
if (n.type !== "Task") {
return false;
}
const state = n.children![0].children![1].text!;
if (!incompleteStates.includes(state) && !completeStates.includes(state)) {
if (!taskStates.has(state)) {
taskStates.set(state, 1);
} else {
taskStates.set(state, taskStates.get(state)! + 1);
}
}
const complete = completeStates.includes(state);
2022-10-14 13:11:33 +00:00
const task: Task = {
2022-07-04 09:30:30 +00:00
name: "",
done: complete,
state,
2022-03-29 15:02:28 +00:00
};
2022-04-11 18:34:09 +00:00
rewritePageRefs(n, name);
2022-07-04 09:30:30 +00:00
replaceNodesMatching(n, (tree) => {
if (tree.type === "DeadlineDate") {
task.deadline = getDeadline(tree);
// Remove this node from the tree
return null;
}
if (tree.type === "Hashtag") {
if (!task.tags) {
task.tags = [];
}
2022-11-20 09:24:24 +00:00
// Push the tag to the list, removing the initial #
task.tags.push(tree.children![0].text!.substring(1));
2022-07-04 09:30:30 +00:00
// Remove this node from the tree
2022-11-30 14:59:28 +00:00
// return null;
2022-07-04 09:30:30 +00:00
}
});
2023-07-24 17:54:31 +00:00
// Extract attributes and remove from tree
2023-07-26 15:12:56 +00:00
const extractedAttributes = await extractAttributes(n, true);
2023-07-24 17:54:31 +00:00
for (const [key, value] of Object.entries(extractedAttributes)) {
task[key] = value;
2023-08-01 19:35:19 +00:00
allAttributes[key] = value;
2023-07-24 17:54:31 +00:00
}
2022-07-04 09:30:30 +00:00
task.name = n.children!.slice(1).map(renderToText).join("").trim();
2022-04-11 18:34:09 +00:00
2022-10-14 13:11:33 +00:00
const taskIndex = n.parent!.children!.indexOf(n);
const nestedItems = n.parent!.children!.slice(taskIndex + 1);
2022-04-04 09:51:41 +00:00
if (nestedItems.length > 0) {
2022-07-04 09:30:30 +00:00
task.nested = nestedItems.map(renderToText).join("").trim();
2022-03-29 15:02:28 +00:00
}
2022-03-28 13:25:05 +00:00
tasks.push({
2022-04-04 09:51:41 +00:00
key: `task:${n.from}`,
2022-07-04 09:30:30 +00:00
value: task,
2022-03-28 13:25:05 +00:00
});
2023-07-26 15:12:56 +00:00
return true;
2022-04-04 09:51:41 +00:00
});
// console.log("Found", tasks, "task(s)");
2022-10-14 13:11:33 +00:00
await index.batchSet(name, tasks);
2023-08-01 19:35:19 +00:00
await indexAttributes(name, allAttributes, "task");
await index.batchSet(
name,
Array.from(taskStates.entries()).map(([state, count]) => ({
key: `taskState:${state}`,
value: count,
})),
);
2022-03-28 13:25:05 +00:00
}
2022-10-14 13:11:33 +00:00
export function taskToggle(event: ClickEvent) {
if (event.altKey) {
return;
}
return taskCycleAtPos(event.page, event.pos);
2022-03-28 13:25:05 +00:00
}
export async function previewTaskToggle(eventString: string) {
const [eventName, pos] = JSON.parse(eventString);
if (eventName === "task") {
return taskCycleAtPos(await editor.getCurrentPage(), +pos);
}
}
async function cycleTaskState(
2023-07-28 11:54:31 +00:00
pageName: string,
node: ParseTree,
) {
const stateText = node.children![1].text!;
let changeTo: string | undefined;
if (completeStates.includes(stateText)) {
changeTo = " ";
} else if (incompleteStates.includes(stateText)) {
changeTo = "x";
} else {
// Not a checkbox, but a custom state
const allStates = await index.queryPrefix("taskState:");
const states = [...new Set(allStates.map((s) => s.key.split(":")[1]))];
states.sort();
// Select a next state
const currentStateIndex = states.indexOf(stateText);
if (currentStateIndex === -1) {
console.error("Unknown state", stateText);
return;
}
const nextStateIndex = (currentStateIndex + 1) % states.length;
changeTo = states[nextStateIndex];
// console.log("All possible states", states);
// return;
}
2022-10-14 13:11:33 +00:00
await editor.dispatch({
changes: {
from: node.children![1].from,
to: node.children![1].to,
insert: changeTo,
},
});
2022-10-14 13:11:33 +00:00
const parentWikiLinks = collectNodesMatching(
node.parent!,
(n) => n.type === "WikiLinkPage",
);
2022-10-14 13:11:33 +00:00
for (const wikiLink of parentWikiLinks) {
const ref = wikiLink.children![0].text!;
if (ref.includes("@")) {
2023-07-28 11:54:31 +00:00
const [page, posS] = ref.split("@");
const pos = +posS;
if (page === pageName) {
// In current page, just update the task marker with dispatch
const editorText = await editor.getText();
// Check if the task state marker is still there
const targetText = editorText.substring(
pos + 1,
pos + 1 + stateText.length,
);
if (targetText !== stateText) {
console.error(
"Reference not a task marker, out of date?",
targetText,
);
return;
}
2023-07-28 11:54:31 +00:00
await editor.dispatch({
changes: {
from: pos + 1,
to: pos + 1 + stateText.length,
2023-07-28 11:54:31 +00:00
insert: changeTo,
},
});
} else {
let text = await space.readPage(page);
const referenceMdTree = await markdown.parseMarkdown(text);
// Adding +1 to immediately hit the task state node
const taskStateNode = nodeAtPos(referenceMdTree, pos + 1);
if (!taskStateNode || taskStateNode.type !== "TaskState") {
2023-07-28 11:54:31 +00:00
console.error(
"Reference not a task marker, out of date?",
taskStateNode,
2023-07-28 11:54:31 +00:00
);
return;
}
taskStateNode.children![1].text = changeTo;
2023-07-28 11:54:31 +00:00
text = renderToText(referenceMdTree);
await space.writePage(page, text);
sync.scheduleFileSync(`${page}.md`);
}
}
}
}
export async function taskCycleAtPos(pageName: string, pos: number) {
2022-10-14 13:11:33 +00:00
const text = await editor.getText();
const mdTree = await markdown.parseMarkdown(text);
2022-04-04 09:51:41 +00:00
addParentPointers(mdTree);
let node = nodeAtPos(mdTree, pos);
if (node) {
if (node.type === "TaskMarker") {
node = node.parent!;
}
if (node.type === "TaskState") {
await cycleTaskState(pageName, node);
}
}
}
2022-03-28 13:25:05 +00:00
export async function taskCycleCommand() {
2022-10-14 13:11:33 +00:00
const text = await editor.getText();
const pos = await editor.getCursor();
const tree = await markdown.parseMarkdown(text);
addParentPointers(tree);
let node = nodeAtPos(tree, pos);
if (!node) {
await editor.flashNotification("No task at cursor");
return;
}
if (["BulletList", "Document"].includes(node.type!)) {
// Likely at the end of the line, let's back up a position
node = nodeAtPos(tree, pos - 1);
}
if (!node) {
await editor.flashNotification("No task at cursor");
return;
}
console.log("Node", node);
const taskNode = node.type === "Task"
? node
: findParentMatching(node!, (n) => n.type === "Task");
if (!taskNode) {
await editor.flashNotification("No task at cursor");
return;
}
const taskState = findNodeOfType(taskNode!, "TaskState");
if (taskState) {
await cycleTaskState(await editor.getCurrentPage(), taskState);
}
}
export async function postponeCommand() {
2022-10-14 13:11:33 +00:00
const text = await editor.getText();
const pos = await editor.getCursor();
const tree = await markdown.parseMarkdown(text);
addParentPointers(tree);
2022-10-14 13:11:33 +00:00
const node = nodeAtPos(tree, pos)!;
// We kwow node.type === DeadlineDate (due to the task context)
2022-10-14 13:11:33 +00:00
const date = getDeadline(node);
const option = await editor.filterBox(
"Postpone for...",
[
{ name: "a day", orderId: 1 },
{ name: "a week", orderId: 2 },
{ name: "following Monday", orderId: 3 },
],
"Select the desired time span to delay this task",
);
if (!option) {
return;
}
// Parse "naive" due date
const [yyyy, mm, dd] = date.split("-").map(Number);
// Create new naive Date object.
// `monthIndex` parameter is zero-based, so subtract 1 from parsed month.
const d = new Date(yyyy, mm - 1, dd);
switch (option.name) {
case "a day":
d.setDate(d.getDate() + 1);
break;
case "a week":
d.setDate(d.getDate() + 7);
break;
case "following Monday":
d.setDate(d.getDate() + ((7 - d.getDay() + 1) % 7 || 7));
break;
2022-03-28 13:25:05 +00:00
}
// console.log("New date", niceDate(d));
2022-10-14 13:11:33 +00:00
await editor.dispatch({
changes: {
from: node.from,
to: node.to,
insert: `📅 ${niceDate(d)}`,
},
selection: {
anchor: pos,
},
});
2022-03-28 13:25:05 +00:00
}
export async function queryProvider({
query,
}: QueryProviderEvent): Promise<Task[]> {
2022-10-14 13:11:33 +00:00
const allTasks: Task[] = [];
2022-10-15 17:02:56 +00:00
for (const { key, page, value } of await index.queryPrefix("task:")) {
const pos = key.split(":")[1];
allTasks.push({
...value,
page: page,
2023-08-02 06:57:25 +00:00
pos: +pos,
});
}
return applyQuery(query, allTasks);
}