feat: add custom attachment types support

re #43

Author: JYC333

CHANGELOG.md

@@ -1,3 +1,13 @@
+# [2.2.0](https://github.com/JYC333/obsidian-attachment-name-formatting/compare/2.1.10...2.2.0) (2024-08-13)
+
+
+### Features
+
+* add custom attachment types support ([9f2e76a](https://github.com/JYC333/obsidian-attachment-name-formatting/commit/9f2e76a464d2606bfbf9dd69c6ea66927f03315d)), closes [#43](https://github.com/JYC333/obsidian-attachment-name-formatting/issues/43)
+* add using notename as a subfolder ([2310cc4](https://github.com/JYC333/obsidian-attachment-name-formatting/commit/2310cc42c1c6a9cfcc5b70ff092b0757f22e12c1)), closes [#40](https://github.com/JYC333/obsidian-attachment-name-formatting/issues/40) [#44](https://github.com/JYC333/obsidian-attachment-name-formatting/issues/44)
+
+
+
 ## [2.1.10](https://github.com/JYC333/obsidian-attachment-name-formatting/compare/2.1.9...2.1.10) (2024-08-12)
 
 

README.md

@@ -1,3 +1,5 @@
+# This plugin will soon be archived and will no longer be maintained. I plan to wait for a while after the update to see if any issues arise. Personally, I've switched to using [Trilium](https://github.com/TriliumNext/Notes) as I found managing attachments and syncing notes manually with Obsidian a bit tedious. That said, Obsidian is still an excellent tool, and I have no criticisms of it. Thank you for using this plugin—I hope it has been helpful to you.
+
 ## Obsidian Attachment Name Formatting
 
 This plugin will format all attachments in the format: "noteName attachmentFormat indexNumber.xxx"
@@ -29,9 +31,10 @@ When using "Copy" mode, it will take a bit longer time than usual renaming time,
 #### Core Function
 
 -   Format attachments in active file, such as "noteName image 1.png". Format time and absolute note path hash can add into attachment name, such as "noteName image 1 20220101000000.png", "noteName image 1 6666cd76.png". Defualt setting is not adding time and path hash. You can also exclude the noteName in the attachment noteName, but the time suffix will be added automatically.
--   Format attachmnets in selected folder
--   Format attachments with customize subfolder for each attachment type
+-   Format attachmnets in selected folder (support recursively)
+-   Format attachments with customize subfolder for each attachment type, and can add note name as another level subfolder
 -   Attachment name can be customized for each type of attachment, you can use any character that allowed in a note name
+-   Attachment type not supported officially can be added in the setting
 -   Connector (the character between noteName, attachmentFormat, indexNumber, time and pathHash) can be customized, you can use any character that allowed in a note name. You can also customized different connectors seperately or even don't use connector.
 -   Add new attachment -> will rename the attachment based on type and index
 -   Change order -> will rename attachments with new order
@@ -44,22 +47,24 @@ When using "Copy" mode, it will take a bit longer time than usual renaming time,
 
 ### Supported attachment format
 
-1. Image files: png, webp, jpg, jpeg, gif, bmp, svg
+1. Image files: png, webp, jpg, jpeg, gif, bmp, svg, avif
 2. Audio files: mp3, wav, m4a, ogg, 3gp, flac
 3. Video files: mp4, webp, ogv, mov, mkv
 4. PDF files: pdf
 
 `webm` file type will be regard as vedieo even if it can be audio.
 
+Customized attachment format can be added in the setting.
+
 ### Known Issues
 
 -   When delete an attachment which is already renamed, it will not rename and will occupy the indexNmuber for this note. But will be renamed to tmp_xxx if there is a conflict later.
 -   When there are two attachments have same name but in different paths, the function will not work correctly. Try to not change the setting "Files & Links -> Default location for new attachments".
 
 ### Roadmap
 
--   When deleting attachment in a file, rename it with "noteName attachmentFormat unuse 1.xxx".
--   When deleting an attachment that no other file using this attachment, delete it from vault. (Could be disable)
+~~-   When deleting attachment in a file, rename it with "noteName attachmentFormat unuse 1.xxx".
+-   When deleting an attachment that no other file using this attachment, delete it from vault. (Could be disable)~~
 
 ### Development Setup
 

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "obsidian-attachment-name-formatting",
 	"name": "Attachment Name Formatting",
-	"version": "2.1.10",
+	"version": "2.2.0",
 	"minAppVersion": "0.12.0",
 	"description": "Obsidian plugin for formatting attachments name (filename attachmentType indexNumber.xxx)",
 	"author": "JYC333",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-attachment-name-formattion",
-	"version": "2.1.10",
+	"version": "2.2.0",
 	"description": "Obsidian plugin for formatting attachments name (filename attachmentType indexNumber.xxx)",
 	"main": "main.js",
 	"scripts": {

src/constants.ts

@@ -13,7 +13,7 @@ export const DEFAULT_SETTINGS: ANFSettings = {
 	multipleConnectors: ["_", "_", "_", "_"],
 	multipleConnectorsEnabled: [true, true, true, true],
 	enableImage: true,
-	imageExtensions: [true, true, true, true, true, true, true], // same amout with image extensions
+	imageExtensions: [true, true, true, true, true, true, true, true], // same amout with image extensions
 	image: "image",
 	enableAudio: true,
 	audioExtensions: [true, true, true, true, true, true], // same amout with audio extensions
@@ -24,6 +24,8 @@ export const DEFAULT_SETTINGS: ANFSettings = {
 	enablePdf: true,
 	pdfExtensions: [true], // same amout with pdf extensions
 	pdf: "pdf",
+	customExtensions: {},
+	enableCustom: false,
 	oneInMany: "Default",
 	enableAuto: true,
 	enableTime: false,

src/main.ts

@@ -321,22 +321,52 @@ export default class AttachmentNameFormatting extends Plugin {
 			// Create a list of attachments, classified by types
 			const attachmentList: AttachmentList = {};
 			for (const item of attachments.embeds) {
+				let extensionAll;
+				// Check whether the custom extensions are enabled
+				if (this.settings.enableCustom) {
+					extensionAll = Object.assign(
+						{},
+						extensions,
+						this.settings.customExtensions
+					);
+				} else {
+					extensionAll = Object.assign({}, extensions);
+				}
+
 				for (const [fileType, fileExtensions] of Object.entries(
-					extensions
+					extensionAll
 				)) {
-					const attachmentEnable = ("enable" +
-						fileType.slice(0, 1).toUpperCase() +
-						fileType.slice(1)) as keyof ANFSettings;
-					const extensionEnable = (fileType +
-						"Extensions") as keyof ANFSettings;
 					const attachmentExtension = item.link.split(".").pop();
-					const attachmentExtensionInd =
-						extensions[fileType].indexOf(attachmentExtension);
+
+					// Check whether official attachment is enabled
+					let isAttachmentEnable;
+					if (Object.keys(extensions).contains(fileType)) {
+						const attachmentEnable = ("enable" +
+							fileType.slice(0, 1).toUpperCase() +
+							fileType.slice(1)) as keyof ANFSettings;
+						const extensionEnable = (fileType +
+							"Extensions") as keyof ANFSettings;
+						const attachmentExtensionInd =
+							extensions[fileType].indexOf(attachmentExtension);
+						isAttachmentEnable =
+							this.settings[attachmentEnable] &&
+							// @ts-ignore
+							this.settings[extensionEnable][
+								attachmentExtensionInd
+							];
+					} else {
+						isAttachmentEnable = true;
+					}
+
+					// Get all custom extensions
+					const customExtentions = [].concat(
+						...Object.values(this.settings.customExtensions)
+					);
+
 					if (
-						fileExtensions.contains(attachmentExtension) &&
-						this.settings[attachmentEnable] &&
-						// @ts-ignore
-						this.settings[extensionEnable][attachmentExtensionInd]
+						(fileExtensions.contains(attachmentExtension) ||
+							customExtentions.contains(attachmentExtension)) &&
+						isAttachmentEnable
 					) {
 						if (!attachmentList.hasOwnProperty(fileType)) {
 							attachmentList[fileType] = [];
@@ -464,7 +494,9 @@ export default class AttachmentNameFormatting extends Plugin {
 
 						const baseNameComponent = [
 							file.basename,
-							this.settings[fileType as keyof ANFSettings],
+							Object.keys(this.settings).includes(fileType)
+								? this.settings[fileType as keyof ANFSettings]
+								: fileType,
 							num,
 						];
 

src/modals.ts

@@ -195,7 +195,7 @@ export class MultiConnectorModal extends Modal {
 	}
 }
 
-export class SuboldersModal extends Modal {
+export class SubfoldersModal extends Modal {
 	plugin: AttachmentNameFormatting;
 
 	constructor(app: App, plugin: AttachmentNameFormatting) {
@@ -291,6 +291,137 @@ export class AttachmentExtensionModal extends Modal {
 	}
 }
 
+export class CustomAttachmentExtensionModal extends Modal {
+	plugin: AttachmentNameFormatting;
+
+	constructor(app: App, plugin: AttachmentNameFormatting) {
+		super(app);
+		this.plugin = plugin;
+	}
+
+	onOpen() {
+		const { contentEl } = this;
+		contentEl.createEl("h2", {
+			text: `Add/Remove custom attachment extenstions.`,
+		});
+		contentEl.createEl("p", {
+			text: "Please separate the extension with comma, for example: zip,rar.",
+		});
+
+		for (const extension of Object.keys(
+			this.plugin.settings.customExtensions
+		)) {
+			new Setting(contentEl)
+				.setName(extension)
+				.addText((text) => {
+					text.setValue(
+						this.plugin.settings.customExtensions[extension].join(
+							","
+						)
+					).onChange(async (value) => {
+						this.plugin.settings.customExtensions[extension] =
+							value.split(",");
+						await this.plugin.saveSettings();
+					});
+				})
+				.addExtraButton((extraButton) => {
+					extraButton.setIcon("x-circle").onClick(() => {
+						delete this.plugin.settings.customExtensions[extension];
+
+						this.plugin.saveSettings();
+						this.close();
+						this.open();
+					});
+				});
+		}
+
+		new Setting(contentEl).addButton((button) => {
+			button.setButtonText("Add").onClick(async () => {
+				new CustomAttachmentNameModal(this.app, this.plugin).open();
+				this.close();
+			});
+		});
+	}
+
+	onClose() {
+		const { contentEl } = this;
+		contentEl.empty();
+	}
+}
+
+class CustomAttachmentNameModal extends Modal {
+	plugin: AttachmentNameFormatting;
+	text: string;
+
+	constructor(app: App, plugin: AttachmentNameFormatting) {
+		super(app);
+		this.plugin = plugin;
+	}
+
+	onOpen() {
+		const { contentEl } = this;
+		contentEl.createEl("h1", {
+			text: "Add custom attachment type",
+		});
+		contentEl.createEl("p", {
+			text: 'Please enter the custom attachment type name, for example "custom".',
+		});
+		contentEl.createEl("p", {
+			text: "The name will be used as the format name for this type of attachment.",
+		});
+		contentEl.createEl("p", {
+			text: "Note: the name should not be empty or already exists.",
+		});
+
+		new Setting(contentEl)
+			.addText((text) => {
+				text.setPlaceholder("custom").onChange(async (value) => {
+					this.text = value;
+				});
+			})
+			.addButton((button) =>
+				button
+					.setButtonText("OK")
+					.setCta()
+					.onClick(() => {
+						if (
+							this.plugin.settings.customExtensions.hasOwnProperty(
+								this.text
+							)
+						) {
+							new WarningModal(
+								this.app,
+								"Custom extension type already exists, please change."
+							).open();
+						} else if (
+							this.text === undefined ||
+							this.text === ""
+						) {
+							new WarningModal(
+								this.app,
+								"Custom extension type can not be empty."
+							).open();
+						} else {
+							this.plugin.settings.customExtensions[
+								this.text.toString()
+							] = [];
+							this.plugin.saveSettings();
+							new CustomAttachmentExtensionModal(
+								app,
+								this.plugin
+							).open();
+							this.close();
+						}
+					})
+			);
+	}
+
+	onClose() {
+		const { contentEl } = this;
+		contentEl.empty();
+	}
+}
+
 export class WarningModal extends Modal {
 	text: string;
 

src/settings.ts

@@ -4,8 +4,9 @@ import AttachmentNameFormatting from "./main";
 import {
 	ExcludedFoldersModal,
 	MultiConnectorModal,
-	SuboldersModal,
+	SubfoldersModal,
 	AttachmentExtensionModal,
+	CustomAttachmentExtensionModal,
 	WarningModal,
 } from "./modals";
 import { ANFSettings } from "./types";
@@ -128,6 +129,9 @@ export class ANFSettingTab extends PluginSettingTab {
 		}
 
 		for (const item of ATTACHMENT_TYPE) {
+			if (item === "custom") {
+				continue;
+			}
 			const attachmentType = item as keyof ANFSettings;
 			const typeSetting = new Setting(containerEl)
 				.setName(`Format for ${attachmentType}`)
@@ -189,6 +193,24 @@ export class ANFSettingTab extends PluginSettingTab {
 			});
 		}
 
+		new Setting(containerEl)
+			.setName(`Format for custom attachment types`)
+			.setDesc(`Set the format for custom attachment types.`)
+			.addExtraButton((button) => {
+				button.onClick(() => {
+					new CustomAttachmentExtensionModal(app, this.plugin).open();
+				});
+			})
+			.addToggle((toggle) => {
+				toggle
+					.setValue(this.plugin.settings.enableCustom)
+					.onChange(async (value) => {
+						this.plugin.settings.enableCustom = value;
+						await this.plugin.saveSettings();
+						this.display();
+					});
+			});
+
 		new Setting(containerEl)
 			.setName("Handle same attachment used in different notes")
 			.setDesc(
@@ -316,7 +338,7 @@ export class ANFSettingTab extends PluginSettingTab {
 			)
 			.addExtraButton((extraButton) => {
 				extraButton.onClick(() => {
-					new SuboldersModal(app, this.plugin).open();
+					new SubfoldersModal(app, this.plugin).open();
 				});
 			});
 

src/types.ts

@@ -19,6 +19,8 @@ export interface ANFSettings {
 	enablePdf: boolean;
 	pdfExtensions: boolean[];
 	pdf: string;
+	customExtensions: Record<string, string[]>;
+	enableCustom: boolean;
 	oneInMany: string;
 	enableAuto: boolean;
 	enableTime: boolean;

versions.json

@@ -31,5 +31,6 @@
 	"2.1.7": "0.12.0",
 	"2.1.8": "0.12.0",
 	"2.1.9": "0.12.0",
-	"2.1.10": "0.12.0"
+	"2.1.10": "0.12.0",
+	"2.2.0": "0.12.0"
 }