forked from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added tech doc with list of challenges and a solution idea
- Loading branch information
1 parent
b096e4c
commit 676ad34
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## Challenges to address (as of 2.1.14): | ||
|
||
- the initial notifications "Custom sorting ON" and "Parsing custom sorting specification SUCCEEDED!" | ||
don't reflect the actual state in some cases - the custom sorting is not applied | ||
- the notifications are shown more than once in some cases | ||
- when the File Explorer is not visible on start (1.7.2 and the lazy views) it is not possible to auto-apply custom sort | ||
and attempting to do so ends up with an error | ||
- there are more challenges when attempting to apply the custom sorting automatically on start | ||
|
||
An idea of solution, not ideal, but acceptable at glance: | ||
- simplify the logic of notifications - only show when successful | ||
- introduce a new popup "Custom sorting was not applied automatically, apply now?" | ||
- only when it was enabled, only when the File Explorer view is visible | ||
- allow to disable this popup in settings (or via a checkbox "don't show it again") | ||
- introduce a new popup "File Explorer view is not visible, cannot apply custom sort" | ||
- only when the user explicitly attempts to apply custom sort | ||
|
||
Additional remarks: | ||
- [Brian Ray](https://github.com/bray) mentions a Lazy Plugin loader in #163 | ||
- check it out and make sure it works correctly (gracefully, not necessarily auto-apply custom sort) | ||
- in some rare cases the custom sorting can be applied successfully on start | ||
- keep this scenario handled correctly | ||
- see #161 for the sequence of events (a) -> (b) -> (c) -> (d) | ||
|
||
## References: | ||
|
||
#163: Obsidian 1.7.2 - automatic sorting fails when launching Obsidian | ||
[#163](https://github.com/SebastianMC/obsidian-custom-sort/issues/163) | ||
|
||
#162: Obsidian 1.7.2 breaking changes - when File Explorer is not displayed an attempt to apply custom sort fails with error | ||
[#162](https://github.com/SebastianMC/obsidian-custom-sort/issues/162) | ||
|
||
#161: Find out how to automatically apply custom sort on app start / vault (re)load etc. | ||
[#161](https://github.com/SebastianMC/obsidian-custom-sort/issues/161) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters