Improve linting / Fix typos / Security Audit (#81)

* Remove "debug" from allowed console methods in ESLint configuration

* Fix typos

* Fix More typos

* Fix Security Audit

Author: 4Source

.eslintrc.release

@@ -9,13 +9,12 @@
 				"allow": [
 					"warn",
 					"error",
-					"debug"
 				]
 			}
 		],
 		"multiline-comment-style": [
 			"error",
-			"starred-block"
+			"starred-block",
 		]
 	}
 }

.github/CONTRIBUTING.md

@@ -25,7 +25,7 @@ If not related issue exists, open a new one using the appropriate <a href="../..
 ### Start working:
 #### 1. Fork the repository.
 #### 2. Create a new vault 
-Just for testing the plugin so you **can't** exedentially destroy your real vault
+Just for testing the plugin so you **can't** accidentally destroy your real vault
 #### 3. Clone repository to your local machine.
 ```shell
 cd path/to/vault

.github/pull_request_template.md

@@ -20,5 +20,5 @@ Fixes # <!-- Issue number --->
 - [<!-- x --> ] I have performed a self-review of my code
 - [<!-- x --> ] I have commented my code, particularly in hard-to-understand areas
 - [<!-- x --> ] I have made corresponding changes to the documentation
-- [<!-- x --> ] I have tested my changes in Obsidian and describte how I tested in [Tests](#tests)
+- [<!-- x --> ] I have tested my changes in Obsidian and described how I tested in [Tests](#tests)
 - [<!-- x --> ] My code fixes the feature discussed in [Related Issues](#related-issues) if not or not fully describe what is missing in [Missing changes](#missing-changes)

README.md

@@ -11,14 +11,13 @@ Allows you to create various global settings profiles. You can sync them between
 ![SettingsProfiles-VaultSwitchDemo_v5](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/5c68105f-6613-4ba6-ab6b-c581b4badab7)
 The demo shows creating a new profile for an existing vault with a theme set and plugin installed. Then a new vault is created and settings profiles are installed. After installation, the previously created profile will be automatically recognized. This is selected and loads all settings including themes and plugins. The newly created vault will then have the same settings as the existing vault.
 
-
 # Usage
 After enabling the plugin in the settings menu, you need to create a new profile. 
 
-You can do this in the settings tab. Just click on the "Add new Profile". Give it a name and select whitch options should be enabled. To switch between profiles click on "Switch to Profile" obsidian should reload.
+You can do this in the settings tab. Just click on the "Add new Profile". Give it a name and select which options should be enabled. To switch between profiles click on "Switch to Profile" obsidian should reload.
 
 # Features
-- Multible profile settings
+- Multiple profile settings
 - Easy and fast switch settings
 - Global settings
 
@@ -91,7 +90,7 @@ The [profiles list](#Profiles-list) below will be reloaded from the files.
 ## Profiles list
 As soon as you have created a profile, all profiles stored in the [Profile save path](#Profile-save-path-) will be listed here.
 ### Profile ![settings](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/88596802-e7b7-4bba-986d-6972758fce99) *Button*
-Let you cange the [Profile options](#Profile-options) for the profile. 
+Let you change the [Profile options](#Profile-options) for the profile. 
 ### Profile ![trash-2](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/ec7767a9-1b49-4cc1-874e-7ee85aec907f) *Button*
 Deletes this profile and all settings. **Attention!** This will delete this profile globally. You can no longer access it in any vault.
 <!-- ### Profile ![plus-circle](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/228a9cd7-1904-48d2-9c9c-5c1b5f2691c9) *Button*
@@ -106,10 +105,10 @@ Indicates that this profile is not selected. By pressing this button you can swi
 
 # Profile options
 ### Name
-Containes the name of the profile.
+Contains the name of the profile.
 ### Auto-Sync
 If activated, changes in the settings are automatically saved as long as the profile is active and [Profile update](#Profile_update) is enabled.
-### Apperance
+### Appearance
 Controls whether the appearance settings should be saved in this profile. This includes CSS snippets and themes.
 ### App
 Controls whether the app settings should be saved in this profile. The app settings includes the "Editor"-tab and "Files and links"-tab.
@@ -118,11 +117,11 @@ Controls whether the bookmarks should be saved in this profile.
 ### Community plugins
 Controls the community plugins should be saved in this profile. This includes which plugins are activated, the source code and the settings that were made for the plugin.
 ### Core plugins
-Controls wheter the core plugins settings should be saved in this profile.
+Controls whether the core plugins settings should be saved in this profile.
 ### Graph
-Controls wheter the graph settings should be saved in this profile.
+Controls whether the graph settings should be saved in this profile.
 ### Hotkeys
-Controls wheter the hotkeys settings should be saved in this profile.
+Controls whether the hotkeys settings should be saved in this profile.
 
 # Status-Bar
 ### Status-Bar ![users](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/d3bee41e-57be-478d-bbf0-a691f165a02e)
@@ -148,7 +147,7 @@ Updates the UI elements.
 
 # Admittance
 ### Access file outside vault
-Is requiered to save setting profiles at a global space so they could be accessed from different vaults.
+Is required to save setting profiles at a global space so they could be accessed from different vaults.
 
 # Contribution
 Feel free to contribute.

package-lock.json

@@ -35,6 +35,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 						this.updateProfile();
 					}
 					else if (!getIgnoreFilesList(profile).contains(filename)) {
+						// TODO: Maybe use like git reference by content with a hash over the content to identify changes instead of modifiedAt date should be more stable with synchronizing across devices
 						profile.modifiedAt = new Date();
 						this.updateCurrentProfile(profile);
 					}
@@ -319,12 +320,12 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	/**
 	 * Check relevant files for profile are changed
 	 * @param profile The profile to check
-	 * @returns `ture` if at least one file has changed and is newer than the saved profile
+	 * @returns `true` if at least one file has changed and is newer than the saved profile
 	 */
 	areSettingsChanged(profile: ProfileOptions): boolean {
 		try {
 			const sourcePath = [getVaultPath(), this.app.vault.configDir];
-			const targetPath = [this.getAbsolutProfilesPath(), profile.name];
+			const targetPath = [this.getAbsoluteProfilesPath(), profile.name];
 
 			// Check target dir exist
 			if (!existsSync(join(...sourcePath))) {
@@ -351,12 +352,12 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	/**
 	 * Check relevant files for profile are saved
 	 * @param profile The profile to check
-	 * @returns `ture` if at no file has changed or all are older than the saved profile
+	 * @returns `true` if at no file has changed or all are older than the saved profile
 	 */
 	areSettingsSaved(profile: ProfileOptions): boolean {
 		try {
 			const sourcePath = [getVaultPath(), this.app.vault.configDir];
-			const targetPath = [this.getAbsolutProfilesPath(), profile.name];
+			const targetPath = [this.getAbsoluteProfilesPath(), profile.name];
 
 			// Check target dir exist
 			if (!existsSync(join(...sourcePath))) {
@@ -392,7 +393,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			// Load profile data
 			this.getProfilesList().forEach((value, index, array) => {
 				if (value.name === profile.name) {
-					array[index] = loadProfileOptions(profile, this.getAbsolutProfilesPath()) || value;
+					array[index] = loadProfileOptions(profile, this.getAbsoluteProfilesPath()) || value;
 				}
 			});
 			return this.getProfile(profile.name);
@@ -413,7 +414,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			await this.saveProfile(profile.name);
 
 			// Save profile data
-			await saveProfileOptions(profile, this.getAbsolutProfilesPath());
+			await saveProfileOptions(profile, this.getAbsoluteProfilesPath());
 
 			// Reload profiles list from files
 			this.refreshProfilesList();
@@ -439,7 +440,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			if (profileName === '') {
 				// Open dialog save current profile
 				if (currentProfile) {
-					new DialogModal(this.app, 'Save befor deselect profile?', 'Otherwise, unsaved changes will be lost.', async () => {
+					new DialogModal(this.app, 'Save before deselect profile?', 'Otherwise, unsaved changes will be lost.', async () => {
 						// Save current profile
 						await this.saveProfileSettings(currentProfile);
 					}, async () => { }, 'Save', false, 'Do not Save')
@@ -459,7 +460,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 
 			// Check is current profile
 			if (currentProfile?.name === targetProfile.name) {
-				new Notice('Allready current profile!');
+				new Notice('Already current profile!');
 				return;
 			}
 
@@ -474,7 +475,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 					this.updateCurrentProfile(profile);
 				});
 
-			// Open dialog obsidain should be reloaded
+			// Open dialog obsidian should be reloaded
 			new DialogModal(this.app, 'Reload Obsidian now?', 'This is required for changes to take effect.', () => {
 				// Save Settings
 				this.saveSettings().then(() => {
@@ -503,7 +504,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			// Add profile to profileList
 			this.appendProfilesList(profile);
 
-			// Enabel new Profile
+			// Enable new Profile
 			const selectedProfile = this.getProfilesList().find(value => value.name === profile.name);
 			if (selectedProfile) {
 				// Sync the profile settings
@@ -578,7 +579,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			}
 
 			// Remove to profile settings
-			removeDirectoryRecursiveSync([this.getAbsolutProfilesPath(), profileName]);
+			removeDirectoryRecursiveSync([this.getAbsoluteProfilesPath(), profileName]);
 			this.refreshProfilesList();
 			await this.saveSettings();
 		}
@@ -599,7 +600,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 			const profile = this.getProfile(profileName);
 
 			const sourcePath = [getVaultPath(), this.app.vault.configDir];
-			const targetPath = [this.getAbsolutProfilesPath(), profileName];
+			const targetPath = [this.getAbsoluteProfilesPath(), profileName];
 			let changed = false;
 
 			// Check target dir exist
@@ -641,7 +642,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 		try {
 			const profile = this.getProfile(profileName);
 
-			const sourcePath = [this.getAbsolutProfilesPath(), profileName];
+			const sourcePath = [this.getAbsoluteProfilesPath(), profileName];
 			const targetPath = [getVaultPath(), this.app.vault.configDir];
 
 			// Check target dir exist
@@ -721,7 +722,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	 * @throws {Error} If the device ID cannot be determined.
 	 * @throws {Error} If no valid profiles path can be found.
 	 */
-	getAbsolutProfilesPath(): string {
+	getAbsoluteProfilesPath(): string {
 		const relativePath = this.getProfilesPath();
 		let path = relativePath;
 
@@ -768,7 +769,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	 */
 	refreshProfilesList() {
 		try {
-			this.globalSettings.profilesList = loadProfilesOptions(this.getAbsolutProfilesPath());
+			this.globalSettings.profilesList = loadProfilesOptions(this.getAbsoluteProfilesPath());
 			return;
 		}
 		catch (e) {
@@ -827,7 +828,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 
 	/**
 	 * Set the refresh interval in current settings
-	 * @param interval To what the invervall should be set to
+	 * @param interval To what the interval should be set to
 	 */
 	setUiRefreshInterval(interval: number) {
 		if (interval > 0 && interval < 900000) {
@@ -897,7 +898,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 
 	/**
 	 * Set the delay time for profile update in current settings
-	 * @param delay To what the invervall should be set to
+	 * @param delay To what the interval should be set to
 	 */
 	setProfileUpdateDelay(delay: number) {
 		if (delay > 100 && delay < 900000) {
@@ -926,7 +927,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	}
 
 	/**
-	 * Gets the currently enabeled profile.
+	 * Gets the currently enabled profile.
 	 * @returns The ProfileSetting object. Or undefined if not found.
 	 */
 	getCurrentProfile(): ProfileOptions | undefined {
@@ -973,9 +974,9 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	}
 
 	/**
-	 * Checks profile contains all requiered properties
+	 * Checks profile contains all required properties
 	 * @param profile The profile to check
-	 * @returns True if profile contains all requiered properties
+	 * @returns True if profile contains all required properties
 	 */
 	isValidProfile(profile: ProfileOptions): boolean {
 		let result = true;
@@ -1005,7 +1006,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	 * @returns Is loaded profile newer/equal than saved profile
 	 */
 	isProfileUpToDate(profile: ProfileOptions): boolean {
-		const profileOptions = loadProfileOptions(profile, this.getAbsolutProfilesPath());
+		const profileOptions = loadProfileOptions(profile, this.getAbsoluteProfilesPath());
 
 		if (!profileOptions || !profileOptions.modifiedAt) {
 			return true;
@@ -1024,7 +1025,7 @@ export default class SettingsProfilesPlugin extends PluginExtended {
 	 * @returns Is saved profile newer/equal than saved profile
 	 */
 	isProfileSaved(profile: ProfileOptions): boolean {
-		const profileOptions = loadProfileOptions(profile, this.getAbsolutProfilesPath());
+		const profileOptions = loadProfileOptions(profile, this.getAbsoluteProfilesPath());
 
 		if (!profileOptions || !profileOptions.modifiedAt) {
 			return false;