Skip to content

Commit

Permalink
#74 - Integration with Bookmarks core plugin and support for indirect…
Browse files Browse the repository at this point in the history 
… drag & drop arrangement

- restructured the context menu to a single submenu of `Custom sort:` configurable in settings
  • Loading branch information
@SebastianMC
SebastianMC committed Oct 22, 2023
1 parent 8e6c8de commit 39d7591
Show file tree
Hide file tree
Showing 2 changed files with 148 additions and 79 deletions.
223 changes: 144 additions & 79 deletions src/main.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ interface CustomSortPluginSettings {
notificationsEnabled: boolean
mobileNotificationsEnabled: boolean
automaticBookmarksIntegration: boolean
customSortContextSubmenu: boolean
bookmarksContextMenus: boolean
bookmarksGroupToConsumeAsOrderingReference: string
}
Expand All @@ -75,6 +76,7 @@ const DEFAULT_SETTINGS: CustomSortPluginSettings = {
statusBarEntryEnabled: true,
notificationsEnabled: true,
mobileNotificationsEnabled: false,
customSortContextSubmenu: true,
automaticBookmarksIntegration: false,
bookmarksContextMenus: false,
bookmarksGroupToConsumeAsOrderingReference: 'sortspec'
Expand All @@ -94,6 +96,8 @@ const ERROR_NOTICE_TIMEOUT: number = 10000
// the monkey-around package doesn't export the below type
type MonkeyAroundUninstaller = () => void

type ContextMenuProvider = (item: MenuItem) => void

export default class CustomSortPlugin extends Plugin {
settings: CustomSortPluginSettings
statusBarItemEl: HTMLElement
Expand Down Expand Up @@ -340,68 +344,128 @@ export default class CustomSortPlugin extends Plugin {
})
);

this.registerEvent(
app.workspace.on("file-menu", (menu: Menu, file: TAbstractFile, source: string, leaf?: WorkspaceLeaf) => {
if (!this.settings.bookmarksContextMenus) return; // Don't show the context menus at all
const applyCustomSortMenuItem = (item: MenuItem) => {
item.setTitle('Apply custom sorting');
item.onClick(() => {
plugin.switchPluginStateTo(true, true)
})
};

const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (!bookmarksPlugin) return; // Don't show context menu if bookmarks plugin not available and not enabled
const suspendCustomSortMenuItem = (item: MenuItem) => {
item.setTitle('Suspend custom sorting');
item.onClick(() => {
plugin.switchPluginStateTo(false, true)
})
};

const bookmarkThisMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: bookmark for sorting.');
item.setIcon('hashtag');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
const getBookmarkThisMenuItemForFile = (file: TAbstractFile): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('Bookmark it for sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
bookmarksPlugin.bookmarkFolderItem(file)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

const getUnbookmarkThisMenuItemForFile = (file: TAbstractFile): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('UNbookmark it from sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
bookmarksPlugin.unbookmarkFolderItem(file)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

const getBookmarkAllMenuItemForFile = (file: TAbstractFile): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('Bookmark it+siblings for sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
const orderedChildren: Array<TAbstractFile> = plugin.orderedFolderItemsForBookmarking(file.parent, bookmarksPlugin)
bookmarksPlugin.bookmarkSiblings(orderedChildren)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

const getUnbookmarkAllMenuItemForFile = (file: TAbstractFile): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('UNbookmark it+siblings from sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
const orderedChildren: Array<TAbstractFile> = file.parent.children.map((entry: TFile | TFolder) => entry)
bookmarksPlugin.unbookmarkSiblings(orderedChildren)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

const getBookmarkSelectedMenuItemForFiles = (files: TAbstractFile[]): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('Custom sort: bookmark selected for sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
files.forEach((file) => {
bookmarksPlugin.bookmarkFolderItem(file)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};
const unbookmarkThisMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: UNbookmark from sorting.');
item.setIcon('hashtag');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
})
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

const getUnbookmarkSelectedMenuItemForFiles = (files: TAbstractFile[]): ContextMenuProvider =>
(item: MenuItem) => {
item.setTitle('Custom sort: UNbookmark selected from sorting.');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
files.forEach((file) => {
bookmarksPlugin.unbookmarkFolderItem(file)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};
const bookmarkAllMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: bookmark+siblings for sorting.');
item.setIcon('hashtag');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
const orderedChildren: Array<TAbstractFile> = plugin.orderedFolderItemsForBookmarking(file.parent, bookmarksPlugin)
bookmarksPlugin.bookmarkSiblings(orderedChildren)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};
const unbookmarkAllMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: UNbookmark+all siblings from sorting.');
})
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};

this.registerEvent(
app.workspace.on("file-menu", (menu: Menu, file: TAbstractFile, source: string, leaf?: WorkspaceLeaf) => {
if (!this.settings.customSortContextSubmenu) return; // Don't show the context menus at all

const customSortMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort:');
item.setIcon('hashtag');
item.onClick(() => {
const submenu = item.setSubmenu()

submenu.addItem(applyCustomSortMenuItem)
submenu.addSeparator()

if (this.settings.bookmarksContextMenus) {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
const orderedChildren: Array<TAbstractFile> = file.parent.children.map((entry: TFile | TFolder) => entry)
bookmarksPlugin.unbookmarkSiblings(orderedChildren)
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
const itemAlreadyBookmarkedForSorting: boolean = bookmarksPlugin.isBookmarkedForSorting(file)
if (!itemAlreadyBookmarkedForSorting) {
submenu.addItem(getBookmarkThisMenuItemForFile(file))
} else {
submenu.addItem(getUnbookmarkThisMenuItemForFile(file))
}
submenu.addItem(getBookmarkAllMenuItemForFile(file))
submenu.addItem(getUnbookmarkAllMenuItemForFile(file))
}
});
}

submenu.addItem(suspendCustomSortMenuItem)
};

const itemAlreadyBookmarkedForSorting: boolean = bookmarksPlugin.isBookmarkedForSorting(file)
if (!itemAlreadyBookmarkedForSorting) {
menu.addItem(bookmarkThisMenuItem)
} else {
menu.addItem(unbookmarkThisMenuItem)
}
menu.addItem(bookmarkAllMenuItem)
menu.addItem(unbookmarkAllMenuItem)
menu.addItem(customSortMenuItem)
})
)

Expand All @@ -410,40 +474,28 @@ export default class CustomSortPlugin extends Plugin {
// "files-menu" event was exposed in 1.4.11
// @ts-ignore
app.workspace.on("files-menu", (menu: Menu, files: TAbstractFile[], source: string, leaf?: WorkspaceLeaf) => {
if (!this.settings.bookmarksContextMenus) return; // Don't show the context menus at all

const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (!bookmarksPlugin) return; // Don't show context menu if bookmarks plugin not available and not enabled
if (!this.settings.customSortContextSubmenu) return; // Don't show the context menus at all

const bookmarkSelectedMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: bookmark selected for sorting.');
const customSortMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort:');
item.setIcon('hashtag');
item.onClick(() => {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
files.forEach((file) => {
bookmarksPlugin.bookmarkFolderItem(file)
})
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
}
});
};
const unbookmarkSelectedMenuItem = (item: MenuItem) => {
item.setTitle('Custom sort: UNbookmark selected from sorting.');
item.setIcon('hashtag');
item.onClick(() => {
const submenu = item.setSubmenu()

submenu.addItem(applyCustomSortMenuItem)
submenu.addSeparator()


if (this.settings.bookmarksContextMenus) {
const bookmarksPlugin = getBookmarksPlugin(plugin.settings.bookmarksGroupToConsumeAsOrderingReference)
if (bookmarksPlugin) {
files.forEach((file) => {
bookmarksPlugin.unbookmarkFolderItem(file)
})
bookmarksPlugin.saveDataAndUpdateBookmarkViews(true)
submenu.addItem(getBookmarkSelectedMenuItemForFiles(files))
submenu.addItem(getUnbookmarkSelectedMenuItemForFiles(files))
}
});
}
submenu.addItem(suspendCustomSortMenuItem)
};

menu.addItem(bookmarkSelectedMenuItem)
menu.addItem(unbookmarkSelectedMenuItem)
menu.addItem(customSortMenuItem)
})
)
}
Expand Down Expand Up @@ -704,6 +756,16 @@ class CustomSortSettingTab extends PluginSettingTab {
await this.plugin.saveSettings();
}));

new Setting(containerEl)
.setName('Enable File Explorer context submenu`Custom sort:`')
.setDesc('Gives access to operations relevant for custom sorting, e.g. applying custom sorting.')
.addToggle(toggle => toggle
.setValue(this.plugin.settings.customSortContextSubmenu)
.onChange(async (value) => {
this.plugin.settings.customSortContextSubmenu = value;
await this.plugin.saveSettings();
}));

containerEl.createEl('h2', {text: 'Bookmarks integration'});
const bookmarksIntegrationDescription: DocumentFragment = sanitizeHTMLToDom(
'If enabled, order of files and folders in File Explorer will reflect the order '
Expand Down Expand Up @@ -756,6 +818,9 @@ class CustomSortSettingTab extends PluginSettingTab {
.setValue(this.plugin.settings.bookmarksContextMenus)
.onChange(async (value) => {
this.plugin.settings.bookmarksContextMenus = value;
if (value) {
this.plugin.settings.customSortContextSubmenu = true; // automatically enable custom sort context submenu
}
await this.plugin.saveSettings();
}))
}
Expand Down
4 changes: 4 additions & 0 deletions src/types/types.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,8 @@ declare module 'obsidian' {

sortOrder: string
}

interface MenuItem {
setSubmenu: () => Menu;
}
}

0 comments on commit 39d7591

Please sign in to comment.