feat: black magic
add config for `order` array, which determines the order in which all passed config functions for explorer will get executed in. functions will now dynamically be called on `fileTree` via array accessor (e.g. fileTree["sort"].call(...)) with corresponding function from options being passed to call)
This commit is contained in:
parent
e112fdad2b
commit
e3306cc475
@ -22,6 +22,7 @@ const defaultOptions = (): Options => ({
|
|||||||
return -1
|
return -1
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
order: ["filter", "map", "sort"],
|
||||||
})
|
})
|
||||||
export default ((userOpts?: Partial<Options>) => {
|
export default ((userOpts?: Partial<Options>) => {
|
||||||
function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
|
function Explorer({ allFiles, displayClass, fileData }: QuartzComponentProps) {
|
||||||
@ -32,17 +33,33 @@ export default ((userOpts?: Partial<Options>) => {
|
|||||||
const fileTree = new FileNode("")
|
const fileTree = new FileNode("")
|
||||||
allFiles.forEach((file) => fileTree.add(file, 1))
|
allFiles.forEach((file) => fileTree.add(file, 1))
|
||||||
|
|
||||||
// Sort tree (folders first, then files (alphabetic))
|
/**
|
||||||
fileTree.sort(opts.sortFn!)
|
* Keys of this object must match corresponding function name of `FileNode`,
|
||||||
|
* while values must be the argument that will be passed to the function.
|
||||||
// If provided, apply filter function to fileTree
|
*
|
||||||
if (opts.filterFn) {
|
* e.g. entry for FileNode.sort: `sort: opts.sortFn` (value is sort function from options)
|
||||||
fileTree.filter(opts.filterFn)
|
*/
|
||||||
|
const functions = {
|
||||||
|
map: opts.mapFn,
|
||||||
|
sort: opts.sortFn,
|
||||||
|
filter: opts.filterFn,
|
||||||
}
|
}
|
||||||
|
|
||||||
// If provided, apply map function to fileTree
|
// Execute all functions (sort, filter, map) that were provided (if none were provided, only default "sort" is applied)
|
||||||
if (opts.mapFn) {
|
if (opts.order) {
|
||||||
fileTree.map(opts.mapFn)
|
// Order is important, use loop with index instead of order.map()
|
||||||
|
for (let i = 0; i < opts.order.length; i++) {
|
||||||
|
const functionName = opts.order[i]
|
||||||
|
if (functions[functionName]) {
|
||||||
|
// for every entry in order, call matching function in FileNode and pass matching argument
|
||||||
|
// e.g. i = 0; functionName = "filter"
|
||||||
|
// converted to: (if opts.filterFn) => fileTree.filter(opts.filterFn)
|
||||||
|
|
||||||
|
// @ts-ignore
|
||||||
|
// typescript cant statically check these dynamic references, so manually make sure reference is valid and ignore warning
|
||||||
|
fileTree[functionName].call(fileTree, functions[functionName])
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get all folders of tree. Initialize with collapsed state
|
// Get all folders of tree. Initialize with collapsed state
|
||||||
|
@ -2,6 +2,8 @@
|
|||||||
import { QuartzPluginData } from "../plugins/vfile"
|
import { QuartzPluginData } from "../plugins/vfile"
|
||||||
import { resolveRelative } from "../util/path"
|
import { resolveRelative } from "../util/path"
|
||||||
|
|
||||||
|
type OrderEntries = "sort" | "filter" | "map"
|
||||||
|
|
||||||
export interface Options {
|
export interface Options {
|
||||||
title: string
|
title: string
|
||||||
folderDefaultState: "collapsed" | "open"
|
folderDefaultState: "collapsed" | "open"
|
||||||
@ -10,6 +12,7 @@ export interface Options {
|
|||||||
sortFn: (a: FileNode, b: FileNode) => number
|
sortFn: (a: FileNode, b: FileNode) => number
|
||||||
filterFn?: (node: FileNode) => boolean
|
filterFn?: (node: FileNode) => boolean
|
||||||
mapFn?: (node: FileNode) => void
|
mapFn?: (node: FileNode) => void
|
||||||
|
order?: OrderEntries[]
|
||||||
}
|
}
|
||||||
|
|
||||||
type DataWrapper = {
|
type DataWrapper = {
|
||||||
|
Loading…
Reference in New Issue
Block a user