O_O checklist - sentance case UI

Author: mProjectsCode

exampleVault/O_O 2024 Checklist.md

@@ -0,0 +1,63 @@
+## Releasing & naming
+
+- [x] Remove placeholder names such as `MyPlugin` and `SampleSettingTab`.
+- [x] Don't include the word "Obsidian" in your name unless it absolutely makes sense. Most of the time it's redundant.
+- [x] Don't include your plugin name in command names. Obsidian adds this for you.
+- [x] Don't prefix commands with your plugin ID. Obsidian adds this for you.
+- [ ] Don't include `main.js` in your repo. Only include it in your releases.
+- [x] If you haven't, consider add a `fundingUrl` so that users of your plugin can show some support. [Learn more](https://docs.obsidian.md/Reference/Manifest#fundingUrl).
+
+## Compatibility
+
+- [x] Don't provide default hotkeys when possible. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+setting+a+default+hotkey+for+commands).
+- [x] Don't override core styling. If needed, add your own class and make the styling only apply to your class.
+- [x] Do scan your code for deprecated methods (they usually show up as strikeout text in IDEs).
+- [ ] Don't assign styles via JavaScript or in HTML. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#No+hardcoded+styling).
+- [x] Don't access the hardcoded `.obsidian` folder if you need to access the configuration directory. The location could be customized, so please use `Vault.configDir` instead.
+
+## Mobile support
+
+Please only complete this section if you have `isDesktopOnly` set to false in your manifest.
+
+- [x] Don't use node.js modules such as `fs`, `path`, and `electron`.
+- [x] Don't use regex lookbehinds if you want to support iOS versions lower than 16.4 (ignore this if you don't use regex in your plugin). [Learn more](https://docs.obsidian.md/Plugins/Getting+started/Mobile+development#Lookbehind+in+regular+expressions).
+- [x] Don't use the `FileSystemAdapter` class.
+- [x] Don't use `process.platform`, use Obsidian's `Platform` instead. [Link to API](https://docs.obsidian.md/Reference/TypeScript+API/Platform).
+- [x] Don't use `fetch` or `axios.get`, use Obsidian's `requestUrl` instead. [Link to API](https://docs.obsidian.md/Reference/TypeScript+API/requestUrl).
+
+## Coding style
+
+- [x] Don't use `var`. Use `let` or `const` instead. [Learn more](https://javascript.plainenglish.io/4-reasons-why-var-is-considered-obsolete-in-modern-javascript-a30296b5f08f).
+- [x] Don't use the global `app` instance. Use `this.app` provided to your plugin instance instead. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid%20using%20global%20app%20instance).
+- [x] Do break up your `main.ts` into smaller files or even folders if it gets big to make code easier to find.
+- [ ] Don't use `Promise`. Use `async` and `await` instead. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Prefer+async%2Fawait+over+Promise).
+- [ ] Don't use global variables. Try to keep variables either in the scope of classes or functions. [Learn more](http://wiki.c2.com/?GlobalVariablesAreBad).
+- [x] Do test with `instanceof` before casting into other types such as `TFile`, `TFolder`, or `FileSystemAdapter`, 
+- [ ] Don't use use `as any` and use proper typing instead.
+
+
+## API usage
+
+- [ ] Don't use `Vault.modify`. If you want to edit the active file, prefer using the `Editor` interface. If you want to edit it in the background, use `Vault.process`.
+- [x] Don't manually read and write frontmatter. Instead, use `FileManager.processFrontMatter`. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Prefer+%60FileManager.processFrontMatter%60+to+modify+frontmatter+of+a+note).
+- [x] Don't use `vault.delete` to delete files. Use `trashFile` instead to make sure the file is deleted according to the users preferences. [Learn more](https://docs.obsidian.md/Reference/TypeScript+API/FileManager/trashFile).
+- [ ] Don't use the `Adapter` API whenever possible. Use `Vault` API instead. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Prefer+the+Vault+API+over+the+Adapter+API).
+- [x] Don't manage reading and write plugin data yourself. Use `Plugin.loadData()` and `Plugin.saveData()` instead.
+- [ ] Do use `normalizePath()` if you take user defined paths. [Learn more](https://docs.obsidian.md/Reference/TypeScript+API/normalizePath).
+
+
+## Performance
+
+- [x] Do optimize your plugin's load time. [Detailed guide](https://docs.obsidian.md/Plugins/Guides/Optimizing+plugin+load+time).
+- [x] Don't iterate all files to find a file or folder by its path. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path).
+- [x] If you want your plugins to be compatible with Obsidian 1.7.2+ (currently in early access), update your plugin to work with `DeferredViews`. [Detailed guide](https://docs.obsidian.md/Plugins/Guides/Understanding+deferred+views).
+- [ ] If you're using `moment`, make sure you're doing `import { moment} from 'obsidian'` so that you don't import another copy.
+- [x] Do minimize your `main.js` for releasing.
+
+## User interface
+
+- [x] Don't use setting headings unless you have more than one section. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Only+use+headings+under+settings+if+you+have+more+than+one+section).
+- [x] Don't include the word "setting" or "option" in setting headings. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+%22settings%22+in+settings+headings).
+- [ ] Do use sentence case in all text in UI elements to be consistent with rest of Obsidian UI. [Learn more](https://en.wiktionary.org/wiki/sentence_case).
+- [x] Don't use `<h1>` or `<h2>` for setting header. Use Obsidian API instead. [Learn more](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Use+%60setHeading%60+instead+of+a+%60%3Ch1%3E%60%2C+%60%3Ch2%3E%60).
+- [x] Don't do `console.log` unless they are absolutely necessarily. Remove testing console logs that are not needed for production.

packages/core/src/api/InternalAPI.ts

@@ -299,7 +299,7 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 				});
 			}),
 			{
-				title: 'Meta Bind Image Suggester',
+				title: 'Meta Bind image suggester',
 				classes: ['mb-image-suggester-modal'],
 			},
 		).open();
@@ -320,7 +320,7 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 				});
 			}),
 			{
-				title: 'Meta Bind Date Picker',
+				title: 'Meta Bind date picker',
 			},
 		).open();
 	}
@@ -360,7 +360,7 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 				});
 			}),
 			{
-				title: 'Meta Bind Error Overview',
+				title: 'Meta Bind error overview',
 				classes: ['mb-error-collection-modal', 'markdown-rendered'],
 			},
 		).open();

packages/core/src/metadata/InternalMetadataSources.ts

@@ -66,7 +66,7 @@ export class GlobalMetadataSource implements IMetadataSource<GlobalMetadataCache
 		if (hadStoragePath) {
 			throw new ParsingValidationError(
 				ErrorLevel.ERROR,
-				'Bind Target Validator',
+				'Bind target validator',
 				`Failed to parse bind target. Bind target storage type 'global_memory' does not support a storage path.`,
 				bindTargetDeclaration,
 				storagePath.position,

packages/core/src/modals/ModalContent.ts

@@ -23,8 +23,8 @@ export abstract class ModalContent extends Mountable {
 		} else {
 			throw new MetaBindInternalError({
 				errorLevel: ErrorLevel.CRITICAL,
-				effect: 'Failed to close modal.',
-				cause: 'Modal reference in ModalContent is undefined.',
+				effect: 'Failed to close modal',
+				cause: 'Modal reference in ModalContent is undefined',
 			});
 		}
 	}

packages/core/src/modals/modalContents/ImageSuggesterModalComponent.svelte

@@ -28,7 +28,7 @@
 </script>
 
 <div class="mb-image-search-container">
-	<input type="text" bind:value={search} placeholder="Search Images..." />
+	<input type="text" bind:value={search} placeholder="Search images..." />
 </div>
 <div class="mb-image-card-grid">
 	{#each filteredOptions as option}

packages/core/src/modals/modalContents/buttonBuilder/ButtonBuilderModalComponent.svelte

@@ -67,31 +67,31 @@
 
 	function getActionLabel(actionType: ButtonActionType): string {
 		if (actionType === ButtonActionType.COMMAND) {
-			return 'Run a Command';
+			return 'Run a command';
 		} else if (actionType === ButtonActionType.OPEN) {
-			return 'Open a Link';
+			return 'Open a link';
 		} else if (actionType === ButtonActionType.JS) {
-			return 'Run a JavaScript File';
+			return 'Run a JavaScript file';
 		} else if (actionType === ButtonActionType.INPUT) {
-			return 'Insert Text at Cursor';
+			return 'Insert text at cursor';
 		} else if (actionType === ButtonActionType.SLEEP) {
-			return 'Sleep for Some Time';
+			return 'Sleep for some time';
 		} else if (actionType === ButtonActionType.TEMPLATER_CREATE_NOTE) {
-			return 'Create a New Note Using Templater';
+			return 'Create a new note using Templater';
 		} else if (actionType === ButtonActionType.UPDATE_METADATA) {
-			return 'Update Metadata';
+			return 'Update metadata';
 		} else if (actionType === ButtonActionType.CREATE_NOTE) {
-			return 'Create a New Note';
+			return 'Create a new note';
 		} else if (actionType === ButtonActionType.REPLACE_IN_NOTE) {
-			return 'Replace Text in Note';
+			return 'Replace text in note';
 		} else if (actionType === ButtonActionType.REGEXP_REPLACE_IN_NOTE) {
-			return 'Replace Text in Note using Regexp';
+			return 'Replace text in note using regexp';
 		} else if (actionType === ButtonActionType.REPLACE_SELF) {
-			return 'Replace Button with Text';
+			return 'Replace button with text';
 		} else if (actionType === ButtonActionType.INSERT_INTO_NOTE) {
-			return 'Insert Text into the Note';
+			return 'Insert text into the note';
 		} else if (actionType === ButtonActionType.INLINE_JS) {
-			return 'Run JavaScript Code';
+			return 'Run JavaScript code';
 		}
 
 		expectType<never>(actionType);
@@ -166,7 +166,7 @@
 </SettingComponent>
 
 <SettingComponent
-	name="CSS Classes"
+	name="CSS classes"
 	description="A list of CSS classes to add to the button. Multiple classes should be separated by a space."
 >
 	<input type="text" bind:value={buttonConfig.class} />

packages/core/src/modals/modalContents/buttonBuilder/CreateNoteActionSettings.svelte

@@ -29,16 +29,16 @@
 	<Button variant={ButtonStyleType.PRIMARY} onclick={() => createNoteActionChangeFolderPath(action)}>Change</Button>
 </SettingComponent>
 
-<SettingComponent name="File Name: {action.fileName || 'default'}" description="The file name of the new note.">
+<SettingComponent name="File name: {action.fileName || 'default'}" description="The file name of the new note.">
 	<input type="text" bind:value={action.fileName} placeholder="some name" />
 </SettingComponent>
 
-<SettingComponent name="Open Note" description="Whether to open the new note after this action ran.">
+<SettingComponent name="Open note" description="Whether to open the new note after this action ran.">
 	<Toggle bind:checked={action.openNote}></Toggle>
 </SettingComponent>
 
 <SettingComponent
-	name="Open If Note Already Exists"
+	name="Open if note already xxists"
 	description="Whether to open the note instead of creating a new one if the note already exists."
 >
 	<Toggle bind:checked={action.openIfAlreadyExists}></Toggle>

packages/core/src/modals/modalContents/buttonBuilder/InlineJsActionSettings.svelte

@@ -12,7 +12,7 @@
 	} = $props();
 </script>
 
-<SettingComponent name="JS Code" description="The JavaScript code to run."></SettingComponent>
+<SettingComponent name="JS code" description="The JavaScript code to run."></SettingComponent>
 
 <div class="meta-bind-full-width meta-bind-high">
 	<textarea bind:value={action.code}></textarea>

packages/core/src/modals/modalContents/buttonBuilder/InsertIntoNoteActionSettings.svelte

@@ -16,7 +16,7 @@
 	<input type="number" bind:value={action.line} placeholder="0" />
 </SettingComponent>
 
-<SettingComponent name="Text to Insert" description="The text to insert into the note."></SettingComponent>
+<SettingComponent name="Text to insert" description="The text to insert into the note."></SettingComponent>
 <div class="meta-bind-full-width meta-bind-high">
 	<textarea bind:value={action.value}></textarea>
 </div>

packages/core/src/modals/modalContents/buttonBuilder/JSActionSettings.svelte

@@ -12,6 +12,6 @@
 	} = $props();
 </script>
 
-<SettingComponent name="JS File" description="The JavaScript file to run.">
+<SettingComponent name="JS file" description="The JavaScript file to run.">
 	<input type="text" bind:value={action.file} placeholder="someJsFile.js" />
 </SettingComponent>

packages/core/src/modals/modalContents/buttonBuilder/OpenActionSettings.svelte

@@ -17,6 +17,6 @@
 	<input type="text" bind:value={action.link} placeholder="[[Some Note]] or https://www.example.com" />
 </SettingComponent>
 
-<SettingComponent name="New Tab" description="Whether to open the link in a new tab.">
+<SettingComponent name="New tab" description="Whether to open the link in a new tab.">
 	<Toggle bind:checked={action.newTab}></Toggle>
 </SettingComponent>

packages/core/src/modals/modalContents/buttonBuilder/RegexpReplaceInNoteActionSettings.svelte

@@ -16,11 +16,11 @@
 	<input type="text" bind:value={action.regexp} />
 </SettingComponent>
 
-<SettingComponent name="Regexp Flags" description="The regexp flags for this regexp.">
+<SettingComponent name="Regexp flags" description="The regexp flags for this regexp.">
 	<input type="text" bind:value={action.regexpFlags} placeholder="g" />
 </SettingComponent>
 
-<SettingComponent name="Replacement Text" description="The text to replace the button with."></SettingComponent>
+<SettingComponent name="Replacement text" description="The text to replace the button with."></SettingComponent>
 <div class="meta-bind-full-width meta-bind-high">
 	<textarea bind:value={action.replacement}></textarea>
 </div>

packages/core/src/modals/modalContents/buttonBuilder/ReplaceInNoteActionSettings.svelte

@@ -12,15 +12,15 @@
 	} = $props();
 </script>
 
-<SettingComponent name="Line From" description="The line that marks the start of the area to replace.">
+<SettingComponent name="Line from" description="The line that marks the start of the area to replace.">
 	<input type="number" bind:value={action.fromLine} placeholder="0" />
 </SettingComponent>
 
-<SettingComponent name="Line To" description="The line that marks the end of the area to replace.">
+<SettingComponent name="Line to" description="The line that marks the end of the area to replace.">
 	<input type="number" bind:value={action.toLine} placeholder="0" />
 </SettingComponent>
 
-<SettingComponent name="Replacement Text" description="The text to replace the note section."></SettingComponent>
+<SettingComponent name="Replacement text" description="The text to replace the note section."></SettingComponent>
 <div class="meta-bind-full-width meta-bind-high">
 	<textarea bind:value={action.replacement}></textarea>
 </div>

packages/core/src/modals/modalContents/buttonBuilder/ReplaceSelfActionSettings.svelte

@@ -12,7 +12,7 @@
 	} = $props();
 </script>
 
-<SettingComponent name="Replacement Text" description="The text to replace the match with."></SettingComponent>
+<SettingComponent name="Replacement text" description="The text to replace the match with."></SettingComponent>
 <div class="meta-bind-full-width meta-bind-high">
 	<textarea bind:value={action.replacement}></textarea>
 </div>

packages/core/src/modals/modalContents/buttonBuilder/SleepActionSettings.svelte

@@ -12,6 +12,6 @@
 	} = $props();
 </script>
 
-<SettingComponent name="Sleep Time" description="The time to sleep in milliseconds.">
+<SettingComponent name="Sleep time" description="The time to sleep in milliseconds.">
 	<input type="number" bind:value={action.ms} placeholder="100 ms" />
 </SettingComponent>

packages/core/src/modals/modalContents/buttonBuilder/TemplaterCreateNoteActionSettings.svelte

@@ -36,7 +36,7 @@
 </script>
 
 <SettingComponent
-	name="Template File: {action.templateFile || 'none'}"
+	name="Template file: {action.templateFile || 'none'}"
 	description="The template file to create a new note of."
 >
 	<Button variant={ButtonStyleType.PRIMARY} onclick={() => templaterCreateNoteActionChangeTemplateFile(action)}
@@ -50,16 +50,16 @@
 	</Button>
 </SettingComponent>
 
-<SettingComponent name="File Name: {action.fileName || 'default'}" description="The file name of the new note.">
+<SettingComponent name="File name: {action.fileName || 'default'}" description="The file name of the new note.">
 	<input type="text" bind:value={action.fileName} placeholder="some name" />
 </SettingComponent>
 
-<SettingComponent name="Open Note" description="Whether to open the new note after this action ran.">
+<SettingComponent name="Open note" description="Whether to open the new note after this action ran.">
 	<Toggle bind:checked={action.openNote}></Toggle>
 </SettingComponent>
 
 <SettingComponent
-	name="Open If Note Already Exists"
+	name="Open if note already exists"
 	description="Whether to open the note instead of creating a new one if the note already exists."
 >
 	<Toggle bind:checked={action.openIfAlreadyExists}></Toggle>

packages/core/src/modals/modalContents/buttonBuilder/UpdateMetadataActionSettings.svelte

@@ -13,7 +13,7 @@
 	} = $props();
 </script>
 
-<SettingComponent name="Metadata Property" description="The metadata property in form of a bind target.">
+<SettingComponent name="Metadata property" description="The metadata property in form of a bind target.">
 	<input type="text" bind:value={action.bindTarget} placeholder="some value" />
 </SettingComponent>
 

packages/obsidian/src/dependencies/DependencyManager.ts

@@ -19,7 +19,7 @@ export class DependencyManager {
 		if (dependency === undefined) {
 			throw new MetaBindDependencyError({
 				errorLevel: ErrorLevel.CRITICAL,
-				effect: `Dependency Violation Detected`,
+				effect: `Dependency violation detected`,
 				cause: `Attempted to access dependency ${pluginId} which is not a listed dependency. Please report this error.`,
 			});
 		}
@@ -33,7 +33,7 @@ export class DependencyManager {
 	private throwPluginNotFound(pluginId: string): void {
 		throw new MetaBindDependencyError({
 			errorLevel: ErrorLevel.ERROR,
-			effect: `Dependency Violation Detected`,
+			effect: `Dependency violation detected`,
 			cause: `Plugin ${pluginId} is required, but not installed. Please install the plugin.`,
 		});
 	}
@@ -42,7 +42,7 @@ export class DependencyManager {
 		if (Version.lessThan(version, dependency.minVersion)) {
 			throw new MetaBindDependencyError({
 				errorLevel: ErrorLevel.ERROR,
-				effect: `Dependency Violation Detected`,
+				effect: `Dependency violation detected`,
 				cause: `Plugin ${dependency.pluginId} is outdated. Required version is at least ${dependency.minVersion}, installed version is ${version}. Please update the plugin.`,
 			});
 		}
@@ -53,7 +53,7 @@ export class DependencyManager {
 		) {
 			throw new MetaBindDependencyError({
 				errorLevel: ErrorLevel.ERROR,
-				effect: `Dependency Violation Detected`,
+				effect: `Dependency violation detected`,
 				cause: `Plugin ${dependency.pluginId} is too new. Required version is lower than ${dependency.maxVersion}, installed version is ${version}. Please downgrade the plugin.`,
 			});
 		}

packages/obsidian/src/playground/PlaygroundView.ts

@@ -21,7 +21,7 @@ export class PlaygroundView extends ItemView {
 	}
 
 	getDisplayText(): string {
-		return 'Meta Bind Playground';
+		return 'Meta Bind playground';
 	}
 
 	// eslint-disable-next-line @typescript-eslint/require-await