Merge branch 'development'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us identify and fix bugs
-title: ''
+title: ""
 labels: bug, enhancement
 assignees: Rudtrack
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Technical Information:**
- - OS: [e.g. Windows, iOS, etc.]
- - Obsidian Version: [Settings -> About -> Current Version]
- - Plugin Version: [Settings -> Third-party Plugins -> Structured Tree Version]
+
+- OS: [e.g. Windows, iOS, etc.]
+- Obsidian Version: [Settings -> About -> Current Version]
+- Plugin Version: [Settings -> Third-party Plugins -> Structured Tree Version]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,13 +1,13 @@
 ---
 name: Documentation
 about: Report if documentation has errors, is lacking or missing for a feature
-title: ''
+title: ""
 labels: documentation
 assignees: Rudtrack
-
 ---
 
 **Checklist**
+
 - [ ] I have checked both ReadMe.md and the repository Wiki for documentation
 - [ ] Choose one:
   - [ ] Documentation is _wrong/has errors_

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest a new feature or idea for the plugin
-title: ''
+title: ""
 labels: enhancement
 assignees: Rudtrack
-
 ---
 
 **Describe the solution you'd like**

.github/workflows/release.yaml

@@ -31,4 +31,4 @@ jobs:
           gh release create "$tag" \
             --title="$tag" \
             --draft \
-            main.js manifest.json styles.css
+            main.js manifest.json styles.css

.prettierrc.json

@@ -0,0 +1,20 @@
+{
+	"semi": true,
+	"tabWidth": 2,
+	"printWidth": 100,
+	"singleQuote": false,
+	"trailingComma": "es5",
+	"bracketSpacing": true,
+	"bracketSameLine": false,
+	"arrowParens": "always",
+	"endOfLine": "lf",
+	"quoteProps": "as-needed",
+	"overrides": [
+		{
+			"files": "*.md",
+			"options": {
+				"tabWidth": 2
+			}
+		}
+	]
+}

CHANGELOG.md

@@ -1,58 +1,63 @@
 # Changelog
 
+## 1.4.2
+
+- Refactored names of files to better conform to best practices.
+- Added prettier config for more consistent code formatting.
+
 ## 1.4.1
 
--   Updated ReadMe.md.
--   Disabled spellchecking for lookup input field.
--   Minor bugfixes and behind-the-scenes improvements.
+- Updated ReadMe.md.
+- Disabled spellchecking for lookup input field.
+- Minor bugfixes and behind-the-scenes improvements.
 
 ## 1.4.0
 
--   Implemented a built-in way of renaming notes.
-    -   It will automatically rename files below in the hiearchy.
-    -   Can be access either through the Command Palette or by right-clicking on a note in the tree view and selecting "Rename Note".
-    -   Will not allow you to rename a note to a name that already exists in the vault.
--   Moved Canvas support to experimental as it is not fully supported by this plugin yet.
+- Implemented a built-in way of renaming notes.
+  - It will automatically rename files below in the hiearchy.
+  - Can be access either through the Command Palette or by right-clicking on a note in the tree view and selecting "Rename Note".
+  - Will not allow you to rename a note to a name that already exists in the vault.
+- Moved Canvas support to experimental as it is not fully supported by this plugin yet.
 
 ## 1.3.0
 
--   Reworked the "Auto-generate Properties" setting.
-    -   ID generation is now optional.
-    -   Can optionally create a `tags` property.
-    -   A `created` property can be optionally created with the current date.
-    -   It will use the user selected keys for title and description. If the keys are not present, it will default to `title` and `desc`.
-    -   It now generates a title based on the file name.
+- Reworked the "Auto-generate Properties" setting.
+  - ID generation is now optional.
+  - Can optionally create a `tags` property.
+  - A `created` property can be optionally created with the current date.
+  - It will use the user selected keys for title and description. If the keys are not present, it will default to `title` and `desc`.
+  - It now generates a title based on the file name.
 
 ## 1.2.0
 
--   Redesigned Lookup to include the contents of the description property.
--   Set custom Properties key for title and description.
--   Small bug fixes.
+- Redesigned Lookup to include the contents of the description property.
+- Set custom Properties key for title and description.
+- Small bug fixes.
 
 ## 1.1.0
 
--   Added support for all file types supported by Obsidian, including Canvas.
--   Small bug and grammatical fixes
+- Added support for all file types supported by Obsidian, including Canvas.
+- Small bug and grammatical fixes
 
 ## 1.0.4
 
--   Small, behind-the-scenes changes to comply with Obsidian review
+- Small, behind-the-scenes changes to comply with Obsidian review
 
 ## 1.0.3
 
--   Behind-the-scenes improvements to streamline the codebase
+- Behind-the-scenes improvements to streamline the codebase
 
 ## 1.0.2
 
--   Updated manifest version number
+- Updated manifest version number
 
 ## 1.0.1
 
--   Updated ReadMe to give credit to original repo
+- Updated ReadMe to give credit to original repo
 
 ## 1.0.0
 
 Initial Release:
 
--   Forked from [Obsidian Dendron Tree](https://github.com/levirs565/obsidian-dendron-tree) by [levirs565](https://github.com/levirs565).
--   Added setting to choose how files are deleted
+- Forked from [Obsidian Dendron Tree](https://github.com/levirs565/obsidian-dendron-tree) by [levirs565](https://github.com/levirs565).
+- Added setting to choose how files are deleted

README.md

@@ -8,13 +8,13 @@ Structured Tree adds a tree for exploring and managing hierarchical notes simila
 
 Features:
 
--   Browse notes using a hierarchical naming scheme.
--   Lookup functionality.
--   Automatic frontmatter generation for new files with user-customizable options.
--   Multi-vault support.
--   Custom resolver and renderer for links and embeds.
--   Built-in renaming modal.
--   Support for all file types supported by Obsidian.
+- Browse notes using a hierarchical naming scheme.
+- Lookup functionality.
+- Automatic frontmatter generation for new files with user-customizable options.
+- Multi-vault support.
+- Custom resolver and renderer for links and embeds.
+- Built-in renaming modal.
+- Support for all file types supported by Obsidian.
 
 ## File Support
 
@@ -36,10 +36,10 @@ To expand and collapse a note, select the arrow (![Note arrow](images/arrow.png)
 
 Right-click a note on Desktop or long-press on Mobile to open the note's menu, which includes:
 
--   "Create Current Note": Creates a file for the selected note (only shown when the note doesn't have a corresponding file).
--   "Create New Note": Opens Lookup with the selected note's path as the initial prompt.
--   "Delete Note": Deletes the selected note file (only shown when the note has a corresponding file).
--   "Rename Note": Opens the renaming modal for the selected note.
+- "Create Current Note": Creates a file for the selected note (only shown when the note doesn't have a corresponding file).
+- "Create New Note": Opens Lookup with the selected note's path as the initial prompt.
+- "Delete Note": Deletes the selected note file (only shown when the note has a corresponding file).
+- "Rename Note": Opens the renaming modal for the selected note.
 
 ## Lookup
 

__mocks__/nanoid.ts

@@ -1,3 +1,3 @@
 export function customAlphabet(alphabet: string, defaultSize?: number): (size?: number) => string {
-    return () => ""
+	return () => "";
 }

esbuild.config.mjs

@@ -13,44 +13,44 @@ if you want to view the source, please visit the github repository of this plugi
 const prod = process.argv[2] === "production";
 
 const context = await esbuild.context({
-  banner: {
-    js: banner,
-  },
-  entryPoints: ["./src/main.ts"],
-  bundle: true,
-  external: [
-    "obsidian",
-    "electron",
-    "@codemirror/autocomplete",
-    "@codemirror/collab",
-    "@codemirror/commands",
-    "@codemirror/language",
-    "@codemirror/lint",
-    "@codemirror/search",
-    "@codemirror/state",
-    "@codemirror/view",
-    "@lezer/common",
-    "@lezer/highlight",
-    "@lezer/lr",
-    ...builtins,
-  ],
-  format: "cjs",
-  target: "es2018",
-  logLevel: "info",
-  sourcemap: prod ? false : "inline",
-  treeShaking: true,
-  plugins: [
-    esbuildSvelte({
-      compilerOptions: { css: true },
-      preprocess: sveltePreprocess(),
-    }),
-  ],
-  outfile: "main.js",
+	banner: {
+		js: banner,
+	},
+	entryPoints: ["./src/main.ts"],
+	bundle: true,
+	external: [
+		"obsidian",
+		"electron",
+		"@codemirror/autocomplete",
+		"@codemirror/collab",
+		"@codemirror/commands",
+		"@codemirror/language",
+		"@codemirror/lint",
+		"@codemirror/search",
+		"@codemirror/state",
+		"@codemirror/view",
+		"@lezer/common",
+		"@lezer/highlight",
+		"@lezer/lr",
+		...builtins,
+	],
+	format: "cjs",
+	target: "es2018",
+	logLevel: "info",
+	sourcemap: prod ? false : "inline",
+	treeShaking: true,
+	plugins: [
+		esbuildSvelte({
+			compilerOptions: { css: true },
+			preprocess: sveltePreprocess(),
+		}),
+	],
+	outfile: "main.js",
 });
 
 if (prod) {
-  await context.rebuild();
-  process.exit(0);
+	await context.rebuild();
+	process.exit(0);
 } else {
-  await context.watch();
+	await context.watch();
 }

jest.config.js

@@ -1,5 +1,5 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+	preset: "ts-jest",
+	testEnvironment: "node",
+};

manifest.json

@@ -1,11 +1,11 @@
 {
 	"id": "structured-tree",
 	"name": "Structured Tree",
-	"version": "1.4.1",
+	"version": "1.4.2",
 	"minAppVersion": "1.1.0",
 	"description": "A file explorer similar to Dendron for navigating hierarchical notes separated by '.'",
 	"author": "Marius Svarverud",
 	"authorUrl": "https://github.com/Rudtrack",
 	"fundingUrl": "https://github.com/sponsors/Rudtrack",
 	"isDesktopOnly": false
-}
+}