tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

13 - Feature request: Sort by modification date, treating folder and files equally 

- extended the advanced folder date handling also on the creation date
This commit is contained in:
SebastianMC 2022-09-26 16:18:35 +02:00
parent 4e64925b2d
commit 1b8e0878af
3 changed files with 35 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/custom-sort/custom-sort-types.ts
View File

@ -15,7 +15,9 @@ export enum CustomSortOrder {
byModifiedTimeReverse,
byModifiedTimeReverseAdvanced,
byCreatedTime,
byCreatedTimeAdvanced,
byCreatedTimeReverse,
byCreatedTimeReverseAdvanced,
standardObsidian, // Let the folder sorting be in hands of Obsidian, whatever user selected in the UI
default = alphabetical
}

31
src/custom-sort/custom-sort.ts
View File

@ -29,7 +29,9 @@ let Sorters: { [key in CustomSortOrder]: SorterFn } = {
[CustomSortOrder.byModifiedTimeReverse]: (a: FolderItemForSorting, b: FolderItemForSorting) => (a.isFolder && b.isFolder) ? Collator(a.sortString, b.sortString) : (b.mtime - a.mtime),
[CustomSortOrder.byModifiedTimeReverseAdvanced]: (a: FolderItemForSorting, b: FolderItemForSorting) => b.mtime - a.mtime,
[CustomSortOrder.byCreatedTime]: (a: FolderItemForSorting, b: FolderItemForSorting) => (a.isFolder && b.isFolder) ? Collator(a.sortString, b.sortString) : (a.ctime - b.ctime),
[CustomSortOrder.byCreatedTimeAdvanced]: (a: FolderItemForSorting, b: FolderItemForSorting) => a.ctime - b.ctime,
[CustomSortOrder.byCreatedTimeReverse]: (a: FolderItemForSorting, b: FolderItemForSorting) => (a.isFolder && b.isFolder) ? Collator(a.sortString, b.sortString) : (b.ctime - a.ctime),
[CustomSortOrder.byCreatedTimeReverseAdvanced]: (a: FolderItemForSorting, b: FolderItemForSorting) => b.ctime - a.ctime,
// This is a fallback entry which should not be used - the plugin code should refrain from custom sorting at all
[CustomSortOrder.standardObsidian]: (a: FolderItemForSorting, b: FolderItemForSorting) => Collator(a.sortString, b.sortString),
@ -178,27 +180,38 @@ export const determineSortingGroup = function (entry: TFile | TFolder, spec: Cus
}
}
export const sortOrderNeedsFoldersMDate = (order: CustomSortOrder | undefined, secondary?: CustomSortOrder): boolean => {
return order === CustomSortOrder.byModifiedTimeAdvanced
|| order === CustomSortOrder.byModifiedTimeReverseAdvanced
|| secondary === CustomSortOrder.byModifiedTimeAdvanced
|| secondary === CustomSortOrder.byModifiedTimeReverseAdvanced
const SortOrderRequiringFolderDate = new Set<CustomSortOrder>([
CustomSortOrder.byModifiedTimeAdvanced,
CustomSortOrder.byModifiedTimeReverseAdvanced,
CustomSortOrder.byCreatedTimeAdvanced,
CustomSortOrder.byCreatedTimeReverseAdvanced
])
export const sortOrderNeedsFolderDates = (order: CustomSortOrder | undefined, secondary?: CustomSortOrder): boolean => {
// The CustomSortOrder.standardObsidian used as default because it doesn't require date on folders
return SortOrderRequiringFolderDate.has(order ?? CustomSortOrder.standardObsidian)
|| SortOrderRequiringFolderDate.has(secondary ?? CustomSortOrder.standardObsidian)
}
// Syntax sugar for readability
export type ModifiedTime = number
export type CreatedTime = number
export const determineModifiedDateForFolder = (folder: TFolder): ModifiedTime => {
export const determineDatesForFolder = (folder: TFolder): [ModifiedTime, CreatedTime] => {
let mtimeOfFolder: ModifiedTime = DEFAULT_FOLDER_MTIME
let ctimeOfFolder: CreatedTime = DEFAULT_FOLDER_CTIME
folder.children.forEach((item) => {
if (!isFolder(item)) {
const file: TFile = item as TFile
if (file.stat.mtime > mtimeOfFolder) {
mtimeOfFolder = file.stat.mtime
}
if (file.stat.ctime > ctimeOfFolder) {
ctimeOfFolder = file.stat.ctime
}
}
})
return mtimeOfFolder
return [mtimeOfFolder, ctimeOfFolder]
}
@ -226,9 +239,9 @@ export const folderSort = function (sortingSpec: CustomSortSpec, order: string[]
const groupIdx: number | undefined = item.groupIdx
if (groupIdx !== undefined) {
const groupOrder: CustomSortOrder | undefined = sortingSpec.groups[groupIdx].order
if (sortOrderNeedsFoldersMDate(groupOrder)) {
if (sortOrderNeedsFolderDates(groupOrder)) {
if (item.folder) {
item.mtime = determineModifiedDateForFolder(item.folder)
[item.mtime, item.ctime] = determineDatesForFolder(item.folder)
}
}
}

11
src/custom-sort/sorting-spec-processor.ts
View File

@ -87,6 +87,7 @@ const OrderLiterals: { [key: string]: CustomSortOrderAscDescPair } = {
'created': {asc: CustomSortOrder.byCreatedTime, desc: CustomSortOrder.byCreatedTimeReverse},
'modified': {asc: CustomSortOrder.byModifiedTime, desc: CustomSortOrder.byModifiedTimeReverse},
'advanced modified': {asc: CustomSortOrder.byModifiedTimeAdvanced, desc: CustomSortOrder.byModifiedTimeReverseAdvanced},
'advanced created': {asc: CustomSortOrder.byCreatedTimeAdvanced, desc: CustomSortOrder.byCreatedTimeReverseAdvanced},
// Advanced, for edge cases of secondary sorting, when if regexp match is the same, override the alphabetical sorting by full name
'a-z, created': {
@ -109,6 +110,16 @@ const OrderLiterals: { [key: string]: CustomSortOrderAscDescPair } = {
desc: CustomSortOrder.alphabeticalReverse,
secondary: CustomSortOrder.byModifiedTimeReverse
},
'a-z, advanced created': {
asc: CustomSortOrder.alphabetical,
desc: CustomSortOrder.alphabeticalReverse,
secondary: CustomSortOrder.byCreatedTimeAdvanced
},
'a-z, advanced created desc': {
asc: CustomSortOrder.alphabetical,
desc: CustomSortOrder.alphabeticalReverse,
secondary: CustomSortOrder.byCreatedTimeReverseAdvanced
},
'a-z, advanced modified': {
asc: CustomSortOrder.alphabetical,
desc: CustomSortOrder.alphabeticalReverse,