Skip to content

Commit

Permalink
Merge pull request #33 from jiyee/master
Browse files Browse the repository at this point in the history 
support adding this heading to a daily note for review

Thanks @jiyee!
  • Loading branch information
@ryanjamurphy
ryanjamurphy authored Nov 3, 2023
2 parents a385ba0 + 4cebd11 commit de27261
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 73 deletions.
7 changes: 7 additions & 0 deletions data.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"dailyNotesFolder": "",
"reviewSectionHeading": "## Review",
"linePrefix": "- ",
"defaultReviewDate": "tomorrow",
"blockLinePrefix": "!"
}
182 changes: 111 additions & 71 deletions main.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,17 @@ const DEFAULT_SETTINGS: IReviewSettings = {
blockLinePrefix: "!",
}

enum ReviewType {
Note,
Block,
Heading,
}

export default class Review extends Plugin {
settings: IReviewSettings;

async onload() {
console.log('Loading the Review plugin v1.6.4.');
console.log('Loading the Review plugin v1.6.5.');

this.settings = Object.assign({}, DEFAULT_SETTINGS, (await this.loadData()))

Expand All @@ -40,7 +45,7 @@ export default class Review extends Plugin {
let leaf = this.app.workspace.activeLeaf;
if (leaf) {
if (!checking) {
new ReviewModal(this.app).open();
new ReviewModal(this.app, ReviewType.Note).open();
}
return true;
}
Expand All @@ -56,7 +61,23 @@ export default class Review extends Plugin {
let leaf = this.app.workspace.activeLeaf;
if (leaf) {
if (!checking) {
new ReviewBlockModal(this.app).open();
new ReviewModal(this.app, ReviewType.Block).open();
}
return true;
}
return false;
}
});

this.addCommand({
id: 'future-review-heading',
name: 'Add this heading to a daily note for review',

checkCallback: (checking: boolean) => {
let leaf = this.app.workspace.activeLeaf;
if (leaf) {
if (!checking) {
new ReviewModal(this.app, ReviewType.Heading).open();
}
return true;
}
Expand Down Expand Up @@ -97,39 +118,37 @@ export default class Review extends Plugin {
console.log("Checking if line '" + inputLine + "' is a block.");
let blockString = "";
if (noteBlocks) { // the file does contain blocks. If not, return ""
for (let eachBlock in noteBlocks) { // iterate through the blocks.
for (let eachBlock in noteBlocks) { // iterate through the blocks.
console.log("Checking block ^" + eachBlock);
let blockRegExp = new RegExp("(" + eachBlock + ")$", "gim");
if (inputLine.match(blockRegExp)) { // if end of inputLine matches block, return it
blockString = eachBlock;
console.log("Found block ^" + blockString);
return blockString;
}
}
}
return blockString;
}
}
return blockString;
}

async setReviewDate(someDate: string, someBlock?: string) {
async setReviewDate(reviewDate: string, reviewType: ReviewType) {
let obsidianApp = this.app;
let naturalLanguageDates = obsidianApp.plugins.getPlugin('nldates-obsidian'); // Get the Natural Language Dates plugin.
let notesFolder = await getDailyNoteSettings().folder;


if (!naturalLanguageDates) {
new Notice("The Natural Language Dates plugin is not available. Please make sure it is installed and enabled before trying again.");
return;
}

if (someDate === "") {
someDate = this.settings.defaultReviewDate;
if (reviewDate === "") {
reviewDate = this.settings.defaultReviewDate;
}
// Use the Natural Language Dates plugin's processDate method to convert the input date into a daily note title.
let parsedResult = naturalLanguageDates.parseDate(someDate);
let parsedResult = naturalLanguageDates.parseDate(reviewDate);
let inputDate = parsedResult.formattedString;


console.debug("Date string to use: " + inputDate);

// Get the folder path.
Expand All @@ -156,28 +175,49 @@ export default class Review extends Plugin {
let noteFile = obsidianApp.workspace.activeLeaf.view.file;
let noteLink = obsidianApp.metadataCache.fileToLinktext(noteFile, noteFile.path, true);

if (someBlock != undefined) {
console.log("Checking for block:");
let lineBlockID = this.getBlock(someBlock, noteFile);
console.debug(lineBlockID);

if (this.getBlock(someBlock, noteFile) === "") { // The line is not already a block
console.debug("This line is not currently a block. Adding a block ID.");
lineBlockID = this.createBlockHash(someBlock).toString();
let lineWithBlock = someBlock + " ^" + lineBlockID;
obsidianApp.vault.read(noteFile).then(function (result) {
let previousNoteText = result;
let newNoteText = previousNoteText.replace(someBlock, lineWithBlock);
obsidianApp.vault.modify(noteFile, newNoteText);
})
}
noteLink = noteLink + "#^" + lineBlockID;
reviewLinePrefix = this.settings.blockLinePrefix;
switch (reviewType) {
case ReviewType.Note:
break;
case ReviewType.Block:
let editor = this.app.workspace.activeLeaf.view.sourceMode.cmEditor;
let cursor = editor.getCursor();
let lineText = editor.getLine(cursor.line);

if (lineText != undefined) {
console.log("Checking for block:");
let lineBlockID = this.getBlock(lineText, noteFile);
console.debug(lineBlockID);

if (this.getBlock(lineText, noteFile) === "") { // The line is not already a block
console.debug("This line is not currently a block. Adding a block ID.");
lineBlockID = this.createBlockHash(lineText).toString();
let lineWithBlock = lineText + " ^" + lineBlockID;
obsidianApp.vault.read(noteFile).then(function (result) {
let previousNoteText = result;
let newNoteText = previousNoteText.replace(lineText, lineWithBlock);
obsidianApp.vault.modify(noteFile, newNoteText);
});
}
noteLink = noteLink + "#^" + lineBlockID;
reviewLinePrefix = this.settings.blockLinePrefix;
}

break;
case ReviewType.Heading:
let heading = this.findHeadingOfLine();
if (heading) {
heading = heading.replace(/^#(#*) /gm, "");
noteLink = noteLink + "#" + heading;
}

break;
default:
break;
}

// check if the daily note file exists
let files = obsidianApp.vault.getFiles();
const dateFile = files.filter(e => e.name === inputDate //hat-tip 🎩 to @MrJackPhil for this little workflow
const dateFile = files.filter(e => e.name === inputDate //hat-tip 🎩 to @MrJackPhil for this little workflow
|| e.path === inputDate
|| e.basename === inputDate
)[0];
Expand Down Expand Up @@ -212,58 +252,58 @@ export default class Review extends Plugin {
obsidianApp.vault.modify(dateFile, newNoteText);
new Notice("Set note \"" + noteName + "\" for review on " + inputDate + ".");
});
}
}
} else {
new Notice("You've entered an invalid date (note that \"two weeks\" will not work, but \"in two weeks\" will). The note was not set for review. Please try again.");
}
return;
}
}

class ReviewModal extends Modal {
constructor(app: App) {
super(app);
lookupOffset(string: string, regex: RegExp, offset?: number) : number {
regex = (regex.global) ? regex : new RegExp(regex.source, "g" + (regex.ignoreCase ? "i" : "") + (regex.multiline ? "m" : ""));
if (typeof (offset) == "undefined") {
offset = string.length;
} else if(offset < 0) {
offset = 0;
}
var stringToWorkWith = string.substring(0, offset + 1);
var lastIndexOf = -1;
var nextStop = 0;
var result;
while((result = regex.exec(stringToWorkWith)) != null) {
lastIndexOf = result.index;
regex.lastIndex = ++nextStop;
}
return lastIndexOf;
}

onOpen() {
let _this = this;
console.debug(_this);
let { contentEl } = this;
let inputDateField = new TextComponent(contentEl)
.setPlaceholder(this.app.plugins.getPlugin("review-obsidian").settings.defaultReviewDate);
let inputButton = new ButtonComponent(contentEl)
.setButtonText("Set Review Date")
.onClick(() => {
let inputDate = inputDateField.getValue();
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate);
this.close();
});
inputDateField.inputEl.focus();
inputDateField.inputEl.addEventListener('keypress', function (keypressed) {
if (keypressed.key === 'Enter') {
var inputDate = inputDateField.getValue()
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate);
_this.close();
}
});
}
findHeadingOfLine() : string | undefined {
let editor = this.app.workspace.activeLeaf.view.sourceMode.cmEditor;
let cursor = editor.getCursor();
cursor.ch = editor.getLine(cursor.line).length;

onClose() {
let { contentEl } = this;
contentEl.empty();
const cursorOffset = editor.posToOffset(cursor);
let headingOffset = this.lookupOffset(editor.getValue(), /^#(#*) /gm, cursorOffset);
// If not found from the cursor position, return undefined
if (headingOffset === -1) {
return undefined;
}

return editor.getLine(editor.offsetToPos(headingOffset).line);
}
}

class ReviewBlockModal extends Modal {
constructor(app: App) {
class ReviewModal extends Modal {

reviewType: ReviewType;

constructor(app: App, reviewType: ReviewType) {
super(app);
this.reviewType = reviewType;
}

onOpen() {
let _this = this;
let editor = this.app.workspace.activeLeaf.view.sourceMode.cmEditor;
let cursor = editor.getCursor();
let lineText = editor.getLine(cursor.line);
console.debug(_this);
let { contentEl } = this;
let inputDateField = new TextComponent(contentEl)
Expand All @@ -272,14 +312,14 @@ class ReviewBlockModal extends Modal {
.setButtonText("Set Review Date")
.onClick(() => {
let inputDate = inputDateField.getValue();
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate, lineText);
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate, _this.reviewType);
this.close();
});
inputDateField.inputEl.focus();
inputDateField.inputEl.addEventListener('keypress', function (keypressed) {
if (keypressed.key === 'Enter') {
var inputDate = inputDateField.getValue()
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate, lineText);
_this.app.plugins.getPlugin("review-obsidian").setReviewDate(inputDate, _this.reviewType);
_this.close();
}
});
Expand Down Expand Up @@ -331,7 +371,7 @@ class ReviewSettingTab extends PluginSettingTab {
new Setting(containerEl)
.setName('Block review line prefix')
.setDesc('Set the prefix used when adding blocks to daily notes with Review. Use e.g., `- [ ] ` to link the block as a task, or `!` to create embeds.')
.addText((text) =>
.addText((text) =>
text
.setPlaceholder('!')
.setValue(plugin.settings.blockLinePrefix)
Expand All @@ -343,7 +383,7 @@ class ReviewSettingTab extends PluginSettingTab {
new Setting(containerEl)
.setName('Default review date')
.setDesc('Set a default date to be used when no date is entered. Use natural language: "Next Monday", "November 5th", and "tomorrow" all work.')
.addText((text) =>
.addText((text) =>
text
.setPlaceholder('')
.setValue(plugin.settings.defaultReviewDate)
Expand All @@ -352,12 +392,12 @@ class ReviewSettingTab extends PluginSettingTab {
plugin.saveData(plugin.settings);
})
);

// containerEl.createEl('h3', { text: 'Preset review schedules' });

/*
TKTKTK: Figure out how to add a function to a button inside the setting element. Currently `doSomething`, below, throws errors.
containerEl.createEl('button', { text: "Add a new review schedule preset", attr: { onclick: "doSomething({ console.log('button clicked') });"}});
*/
}
}
}
2 changes: 1 addition & 1 deletion manifest.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "review-obsidian",
"name": "Review",
"version": "1.6.4",
"version": "1.6.5",
"description": "Add a link to the current note to a daily note on a future date (or a past date, you time traveller).",
"author": "ryanjamurphy",
"authorUrl": "https://axle.design",
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "review-obsidian",
"version": "1.6.4",
"version": "1.6.5",
"description": "Add a link to the current note to a daily note on a future date (or a past date, you time traveller).",
"main": "main.js",
"repository": "ryanjamurphy/review-obsidian",
Expand Down

0 comments on commit de27261

Please sign in to comment.