Add plugin: Scribe

[Mikodin]

I am submitting Scribe a new Community Plugin

Repo URL

Link to my plugin:
https://github.com/Mikodin/obsidian-scribe

Release Checklist

• I have tested the plugin on
  • Windows
  • macOS
  • Linux
  • Android (if applicable)
  • iOS (if applicable)
• My GitHub release contains all required files (as individual files, not just in the source.zip / source.tar.gz)
  • main.js
  • manifest.json
  • styles.css (optional)
• GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
• The id in my manifest.json matches the id in the community-plugins.json file.
• My README.md describes the plugin's purpose and provides clear usage instructions.
• I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
• I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
• I have added a license in the LICENSE file.
• My project respects and is compatible with the original license of any code from other plugins that I'm using.
  I have given proper attribution to these other projects in my README.md.

[github-actions]

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Expected ',' or ']' after array element in JSON at position 517737

---

^{This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.}

[github-actions]

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting.

---

^{This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.}

[ObsidianReviewBot]

Thank you for your submission, an automated scan of your plugin code's revealed the following issues:

Required

[1]:The command name should not include the plugin name.

[1]:Using innerHTML, outerHTML or similar API's is a security risk. Instead, use the DOM API or the Obsidian helper functions: https://docs.obsidian.md/Plugins/User+interface/HTML+elements

---

Do NOT open a new PR for re-validation.
Once you have pushed all of the required changes to your repo, the bot will update the labels on this PR within 6 hours.
If you think some of the required changes are incorrect, please comment with /skip and the reason why you think the results are incorrect.

[ObsidianReviewBot]

Changes requested by bot have been made, assigning human for additional review.

[joethei]

Api, Api, Api, .setName('AssemblyAI Api Key')
All characters in API are capitalized

'Scribe: 🎙️ Recording Started', 'Scribe: ▶️🎙️ Resuming Recording', 'Scribe: ⏸️🎙️ Recording Paused', 'Scribe: 🛑️ Recording Cancelled', Scribe: ✅ Audio File saved ${recordingFile.name}, Scribe: 🎧 Beginning Transcription w/ ${this.settings.transcriptPlatform},, Scribe: 🎧 Completed Transcription w/ ${this.settings.transcriptPlatform},, new Notice('Scribe: 🧠 Sending to LLM to Summarize');, new Notice('Scribe: 🧠 LLM Summation complete');, .setName('Open AI Api Key'), 'You can find this in your OpenAI Dev Console, .setName('AssemblyAI Api Key'), 'You can find this in your AssemblyAI Dev Console, .setName('LLM Model for creating the Summary'), .setName('Transcript Platform: Your audio is uploaded to this service'), item.setTitle('🕹️ Open Controls');, item.setTitle('🛑🎙️ Stop Recording');, item.setTitle('🎙️ Start Recording');, LLM Model for creating the Summary, Transcript Platform, name: 'Begin Recording',, name: 'Transcribe & Summarize Current File',, name: 'Fix Mermaid Chart',
Use sentence case in UI

new Notice('Scribe: 🧠 LLM Summation complete');
Looks like you made a typo here.

export function formatForFilename(input: string): string {
Obsidian has the normalizePath function for this.

const statusBarItemEl = plugin.addStatusBarItem();
Remove this sample code.

item.setTitle('🕹️ Open Controls');, item.setTitle('🛑🎙️ Stop Recording');, item.setTitle('🎙️ Start Recording');
Instead of the emojis, use the setIcon function on the menu items instead.

[github-actions]

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Expected ',' or '}' after property value in JSON at position 518802

---

^{This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.}

[github-actions]

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: prashanthpulisetti/password-audit. If you are submitting from a GitHub org, you need to be a public member of the org.

---

^{This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.}

[Mikodin]

Api, Api, Api, .setName('AssemblyAI Api Key') All characters in API are capitalized

'Scribe: 🎙️ Recording Started', 'Scribe: ▶️🎙️ Resuming Recording', 'Scribe: ⏸️🎙️ Recording Paused', 'Scribe: 🛑️ Recording Cancelled', Scribe: ✅ Audio File saved ${recordingFile.name}, Scribe: 🎧 Beginning Transcription w/ ${this.settings.transcriptPlatform},, Scribe: 🎧 Completed Transcription w/ ${this.settings.transcriptPlatform},, new Notice('Scribe: 🧠 Sending to LLM to Summarize');, new Notice('Scribe: 🧠 LLM Summation complete');, .setName('Open AI Api Key'), 'You can find this in your OpenAI Dev Console, .setName('AssemblyAI Api Key'), 'You can find this in your AssemblyAI Dev Console, .setName('LLM Model for creating the Summary'), .setName('Transcript Platform: Your audio is uploaded to this service'), item.setTitle('🕹️ Open Controls');, item.setTitle('🛑🎙️ Stop Recording');, item.setTitle('🎙️ Start Recording');, LLM Model for creating the Summary, Transcript Platform, name: 'Begin Recording',, name: 'Transcribe & Summarize Current File',, name: 'Fix Mermaid Chart', Use sentence case in UI

new Notice('Scribe: 🧠 LLM Summation complete'); Looks like you made a typo here.

export function formatForFilename(input: string): string { Obsidian has the normalizePath function for this.

const statusBarItemEl = plugin.addStatusBarItem(); Remove this sample code.

item.setTitle('🕹️ Open Controls');, item.setTitle('🛑🎙️ Stop Recording');, item.setTitle('🎙️ Start Recording'); Instead of the emojis, use the setIcon function on the menu items instead.

@joethei
Thank you for the feedback 🙏
I've applied all the changes, thanks for the push on using setIcon on the menu
I didn't realize that they only render on mobile 👌

[joethei]

You missed a couple, mostly in the sentence case section.
And the formatForFilename function was also not removed.

[Mikodin]

You missed a couple, mostly in the sentence case section. And the formatForFilename function was also not removed.

Thanks @joethei ! Got all the sentence cases and replaced formatForFilename with normalizePath
🚀

[joethei]

I don't see any changes for 5 of the UI strings,

[Mikodin]

I don't see any changes for 5 of the UI strings,

@joethei
🤔 Hmm, maybe I am misunderstanding the change being asked
It's for sentence casing right?

Sorry for the back and forth, thank you for the review and patience

Mikodin/obsidian-scribe@9be0961#diff-a2a171449d862fe29692ce031981047d7ab755ae7f84c707aef80701b3ea0c80R248

Mikodin/obsidian-scribe@9be0961#diff-9c9d24790e2b8d4f03202dc4d12f8918030d8398322460bb5dd2b74a06a369edR45

Mikodin/obsidian-scribe@9be0961#diff-9c9d24790e2b8d4f03202dc4d12f8918030d8398322460bb5dd2b74a06a369edR60

And then the settings pane

[joethei]

• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/modal/components/ModalSettings.tsx#L40
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L22
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/modal/components/ModalSettings.tsx#L56
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L14
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L32

These also need to use sentence case.

[Mikodin]

• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/modal/components/ModalSettings.tsx#L40
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L22
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/modal/components/ModalSettings.tsx#L56
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L14
• https://github.com/Mikodin/obsidian-scribe/blob/933904b26453e4db09dc0ee31dbe70af4471f976/src/commands/commands.ts#L32

These also need to use sentence case.

@joethei
Wow, I'm blind! 😂

Updated - thank you

Mikodin/obsidian-scribe@159848c
Mikodin/obsidian-scribe@10c22bb

[ObsidianReviewBot]

The automated review has not found any issues with your code, ready for manual review.

[ObsidianReviewBot]

The automated review has not found any issues with your code, ready for manual review.