hananoshikayomaru / obsidian-incomplete-files Goto Github PK

View Code? Open in Web Editor NEW

4.0 1.0 1.0 417 KB

Rule based incomplete files discovery

License: MIT License

Shell 1.87% JavaScript 2.40% TypeScript 82.05% CSS 3.07% Svelte 10.61%

obsidian-incomplete-files's Introduction

Obsidian Incomplete files

This plugin help discover your incomplete files base on given rules.

✅ Powerful, Dead Simple

Demo: https://www.youtube.com/watch?v=GO3N-IdBNVA&ab_channel=YomaruHananoshika

Features

rule based incomplete files detection
show all incomplete files with issues
non intrusive, you install the plugin and don't need to do anything else
incomplete files view: see all your incomplete files in a list
1. see last update time of this file
realtime udpate of your incomplete files
highly optimized so it is fast to analyse files

Rules

rule name	description	DEFAULT
EMTPY CONTENT	This rule cannot be turned off. When the file has no content, it is treaded as incomplete.	✅
EMPTY CONTENT HEADING	When a heading has no content, it is treated as incomplete.	✅
INCOMPLETE STNTAX	When a file has the incomplete syntax, it is treated as incomplete. The incomplete syntax is `%% INCOMPLETE(issue which is a string) %%` or `%% INCOMPLETE %%`	✅

Installation

Through community plugin store

You can install this plugin in the community plugin store. 👍

Through BRAT

install the BRAT plugin
go to the plugin option, add beta plugin, copy and paste the link of this repo.
the plugin will automatically appear in the list of installed community plugins, enabled this plugin

Manual installation

cd to .obsidian/plugins
git clone this repo
cd obsidian-incomplete-files && bun install && bun run build
there you go 🎉

Contribution

how to start

clone this repo to your plugins
bun install
bun dev

Create a new rule

add a new enum to INCOMPLETE_ISSUE_TYPE
also add to settingSchemas.ts
create your scanner

export const issueScanners = [
 checkEmptyContent,
 checkEmptyContentHeading,
 checkIncompleteSyntax,
];

// this is the interface you can refer to 
export type IssueScanner = {
 issueType: INCOMPLETE_ISSUE_TYPE;
 func: ScanFunction;
 icon: string;
 setting: {
  name: string;
  description: string;
  default: boolean;
 };
};

create a test case for your scanner
test it in your development vault
there you go 🎉

Give Thanks

If you are enjoying this plugin then please support my work and enthusiasm by sponsoring me on Github or buying me a coffee on https://www.buymeacoffee.com/yomaru.

obsidian-incomplete-files's People

Contributors

Stargazers

Watchers

Forkers

radlakha

obsidian-incomplete-files's Issues

[YOM-555] complete the rules

null

_YOM-555

[YOM-556] incomplete files group base on folder path

null

_YOM-556

Ignore whitespace in Incomplete syntax

Allow whitespace between INCOMPLETE and the open bracket.
I will submit a pull request to fix this minor irritant.
/r

problematic writing style

this writing style will make the plugin think that it is not complete. But in Obsidian, this writing style is not recognize as a valid heading.

✅ / ❌ we need to determine whether we should follow the markdown definition or obsidian definition.

[YOM-554] Yaml complete: true will make a file complete

or other status: complete, we should let user choose how they want the yaml to be.

_YOM-554

[YOM-558] incomplete files group base on tags

null

_YOM-558

[YOM-565] fix bug

app.js:1 Uncaught Error: element or incompleteFilesContainer is null
    at isFileInView (plugin:incomplete-files:16508:11)
    at eval (plugin:incomplete-files:17101:16)
    at e.tryTrigger (app.js:1:695499)
    at e.trigger (app.js:1:695432)
    at t.trigger (app.js:1:713365)
    at t.onChange (app.js:1:703783)
    at e.trigger (app.js:1:610660)
    at e.<anonymous> (app.js:1:608471)
    at app.js:1:237027
    at Object.next (app.js:1:237132)

_YOM-565