updates for community plugins review

obsidianmd/obsidian-releases#1196

Author: cogscides

main.js

@@ -1,10 +1,10 @@
 {
-  "id": "obsidian-keyboard-analyzer",
+  "id": "keyboard-analyzer",
   "name": "Keyboard Analyzer",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "minAppVersion": "0.12.10",
   "description": "See and analyse your keyboard hotkeys and shortcuts",
-  "author": "Cogscieds",
-  "authorUrl": "https://github.com/cogscides/obsidian-keyboard-analyzer",
+  "author": "cogscides",
+  "authorUrl": "https://github.com/cogscides",
   "isDesktopOnly": false
 }

manifest.json

@@ -1,4 +1,5 @@
 import type { Command, Hotkey, Modifier, App } from 'obsidian'
+import { Platform } from 'obsidian'
 import type { EntryType } from 'perf_hooks'
 import type { hotkeyDict, hotkeyEntry } from 'src/Interfaces'
 
@@ -139,15 +140,15 @@ export function getConvertedModifiers(modifiers: Modifier[]) {
   let convertedModifiers = modifiers.map((modifier: Modifier) => {
     if (modifier === 'Mod') {
       // check macos
-      if (process.platform === 'darwin') {
+      if (Platform.isMacOS === true) {
         return 'Cmd'
       } else {
         return 'Ctrl'
       }
     }
     if (modifier === 'Meta') {
       // check macos
-      if (process.platform === 'darwin') {
+      if (Platform.isMacOS === true) {
         return 'Cmd'
       } else {
         return 'Win'
@@ -168,13 +169,13 @@ export function getUnconvertedModifiers(modifiers: Modifier[]) {
     if (modifier === 'Ctrl') {
       return 'Ctrl'
     }
-    if (modifier === 'Cmd' && process.platform === 'darwin') {
+    if (modifier === 'Cmd' && Platform.isMacOS === true) {
       return 'Mod'
     }
     if (modifier === 'Win') {
       return 'Meta'
     }
-    if (modifier === 'Cmd' && process.platform === 'darwin') {
+    if (modifier === 'Cmd' && Platform.isMacOS === true) {
       return 'Meta'
     }
   })

src/AppShortcuts.ts

@@ -26,7 +26,7 @@
   } from 'src/AppShortcuts'
 
   // STORE
-  import { activeKey, activeModifiers } from './atciveKeysStore'
+  import { activeKey, activeModifiers } from './activeKeysStore'
 
   // CONSTANTS
   import {

src/Components/KeyboardComponent.svelte

@@ -1,15 +1,16 @@
 <script lang="ts">
+  import type { Modifier } from 'obsidian'
+  import { Platform } from 'obsidian'
   import { Coffee as CofeeIcon } from 'lucide-svelte'
   import { JavaSciptKeyCodes } from 'src/Constants'
   import { getConvertedModifiers } from 'src/AppShortcuts'
-  import type { Modifier } from 'obsidian'
   import KeyboardKey from './KeyboardKey.svelte'
 
   // TYPES
   import type { Keyboard, commandsArray } from 'src/Interfaces'
 
   // STORE
-  import { activeKey, activeModifiers } from './atciveKeysStore'
+  import { activeKey, activeModifiers } from './activeKeysStore'
 
   export let visibleCommands: commandsArray
 
@@ -98,7 +99,7 @@
                 unicode: 'Ctrl',
               }
             } else if (keyOutput === 'Meta') {
-              if (process.platform === 'darwin') {
+              if (Platform.isMacOS === true) {
                 outputKeyObj = {
                   output: '⌥',
                   keyCode: 18,
@@ -115,7 +116,7 @@
                 }
               }
             } else if (keyOutput === 'Alt') {
-              if (process.platform === 'darwin') {
+              if (Platform.isMacOS === true) {
                 outputKeyObj = {
                   output: '⌘',
                   smallText: key.smallText ? true : false,

src/Components/KeyboardLayout.svelte

@@ -18,7 +18,7 @@
   import { JavaSciptKeyCodes, SpecialSymbols } from 'src/Constants'
 
   // STORE
-  import { activeKey, activeModifiers } from './atciveKeysStore'
+  import { activeKey, activeModifiers } from './activeKeysStore'
 
   // UTILS
   import { getConvertedModifiers, sortModifiers } from 'src/AppShortcuts'

src/Components/SearchMenu.svelte

@@ -27,8 +27,6 @@ export default class ShortcutsView extends ItemView {
     return 'Keyboard Shortcuts'
   }
 
-  icon = 'keyboard-glyph'
-
   async onOpen(): Promise<void> {
     await this.draw()
   }

src/Components/atciveKeysStore.js renamed to src/Components/activeKeysStore.js

@@ -45,7 +45,7 @@ export default class KeyboardAnalizerPlugin extends Plugin {
     )
 
     // This adds a settings tab so the user can configure various aspects of the plugin
-    this.addSettingTab(new KeyboardAnalyzerSettingTab(this.app, this))
+    // this.addSettingTab(new KeyboardAnalyzerSettingTab(this.app, this))
   }
 
   async onunload() {
@@ -83,36 +83,34 @@ export default class KeyboardAnalizerPlugin extends Plugin {
 
   async onStatusBarClick(evt: MouseEvent) {
     if (evt.ctrlKey == true) {
-      let checkResult =
-        this.app.workspace.getLeavesOfType(VIEW_TYPE_SHORTCUTS_ANALYZER)
-          .length === 0
-
-      if (checkResult) {
-        this.app.workspace
-          .getLeaf(true)
-          .setViewState({ type: VIEW_TYPE_SHORTCUTS_ANALYZER })
-      }
+      this.addShortcutsView(true)
     } else {
       this.addShortcutsView()
     }
   }
 
-  async addShortcutsView(startup: boolean = false) {
+  async addShortcutsView(newLeaf: boolean = false) {
     let checkResult =
       this.app.workspace.getLeavesOfType(VIEW_TYPE_SHORTCUTS_ANALYZER)
         .length === 0
 
     if (checkResult) {
-      this.app.workspace
-        .getLeaf()
-        .setViewState({ type: VIEW_TYPE_SHORTCUTS_ANALYZER })
+      if (newLeaf) {
+        this.app.workspace
+          .getLeaf(true)
+          .setViewState({ type: VIEW_TYPE_SHORTCUTS_ANALYZER })
+      } else {
+        this.app.workspace
+          .getLeaf()
+          .setViewState({ type: VIEW_TYPE_SHORTCUTS_ANALYZER })
+      }
     }
   }
 
   registerPluginHotkeys() {
     this.addCommand({
       id: 'show-shortcuts-analyzer-view',
-      name: 'Open Shorcuts View',
+      name: 'Open keyboard shortcuts view',
       checkCallback: (checking: boolean) => {
         let checkResult =
           this.app.workspace.getLeavesOfType(VIEW_TYPE_SHORTCUTS_ANALYZER)
@@ -132,32 +130,32 @@ export default class KeyboardAnalizerPlugin extends Plugin {
   // END OF PLUGIN DECLARATION
 }
 
-class KeyboardAnalyzerSettingTab extends PluginSettingTab {
-  plugin: KeyboardAnalizerPlugin
-
-  constructor(app: App, plugin: KeyboardAnalizerPlugin) {
-    super(app, plugin)
-    this.plugin = plugin
-  }
-
-  display(): void {
-    const { containerEl } = this
-
-    containerEl.empty()
-
-    containerEl.createEl('h2', { text: 'Settings for my awesome plugin.' })
-
-    // checkbox for showing status bar item
-    new Setting(containerEl)
-      .setName('Show Status Bar Item')
-      .setDesc('Show the status bar item')
-      .addToggle((checkbox: any) =>
-        checkbox
-          .setChecked(this.plugin.settings.showStatusBarItem)
-          .onChange(async (value: boolean) => {
-            this.plugin.settings.showStatusBarItem = value
-            await this.plugin.saveSettings()
-          })
-      )
-  }
-}
+// class KeyboardAnalyzerSettingTab extends PluginSettingTab {
+//   plugin: KeyboardAnalizerPlugin
+
+//   constructor(app: App, plugin: KeyboardAnalizerPlugin) {
+//     super(app, plugin)
+//     this.plugin = plugin
+//   }
+
+//   display(): void {
+//     const { containerEl } = this
+
+//     containerEl.empty()
+
+//     containerEl.createEl('h2', { text: 'Settings for my awesome plugin.' })
+
+//     // checkbox for showing status bar item
+//     new Setting(containerEl)
+//       .setName('Show Status Bar Item')
+//       .setDesc('Show the status bar item')
+//       .addToggle((checkbox: any) =>
+//         checkbox
+//           .setChecked(this.plugin.settings.showStatusBarItem)
+//           .onChange(async (value: boolean) => {
+//             this.plugin.settings.showStatusBarItem = value
+//             await this.plugin.saveSettings()
+//           })
+//       )
+//   }
+// }