Obsidian Helper

[Ambushfall]

Open obsidian-helper in Script Kit

// Name: Obsidian Helper
// Author: Ambushfall
// Description: Usable script to easily add small additions to obsidian and allows preview and edit of markdown files directly.

// This is just for speed of use.

import '@johnlindquist/kit'
import { Choice } from '@johnlindquist/kit'
import { readFileSync } from 'fs'
import _ from 'lodash'

let { obsidiandir, write } = await db('obsidiandir')

let route =
  obsidiandir.length > 0
    ? await arg(
        {
          placeholder: 'Select Obsidian vault',
          shortcuts: [
            {
              name: 'Cancel',
              key: 'escape',
              bar: 'right',
              onPress: () => mainScript(),
              visible: true
            }
          ],
          onNoChoices: async input => {
            setPanel(
              md(
                `# Vault location not found <code>${input}</code>\n Type <kbd>enter</kbd> to create a new vault at this location: <code>${input}</code>`
              )
            )
          },
          onChoiceFocus: async (_, state) => {
            const Files: string[] = await readdir(state.focused?.value)
            const FilteredDir: string[] = Files.filter((file: string) =>
              file.toLowerCase().includes('.md')
            )
            let html = `<h1>Note List:</h1><ul style="margin:20px; padding:10px;">\n`
            FilteredDir.forEach(e => {
              html += `<li>${e}</li>`
            })
            html += `</ul>`
            setPreview(html)
          }
        },
        obsidiandir.map((e: string) => {
          return {
            type: 'text',
            name: e.split('\\').at(-1),
            value: e
          }
        })
      )
    : await path({
        hint: 'Paste path to your obsidian vault!'
      })

if (!obsidiandir.find((e: string) => e == route) || obsidiandir.length == 0) {
  obsidiandir.push(route)
  await write()
}

if (isDir(route)) {
  const Files: string[] = await readdir(route)
  const FilteredDir: string[] = Files.filter((file: string) =>
    file.toLowerCase().includes('.md')
  )

  let { filename } = await arg(
    {
      placeholder: 'select File'
    },
    (): Choice[] => {
      return FilteredDir.map((file: string) => {
        const str = readFileSync(path.join(route, file), 'utf-8')
        // log(str)
        return {
          type: 'text',
          name: file.replaceAll('.md', ''),
          value: {
            filename: file
          },
          preview: () => md(str)
        }
      })
    }
  )

  /**
   * This is taken directly from the examples for editor functionality
   *
   */
  let changed = false

  let filePath = path.join(route, filename)
  let autoSave = _.debounce(async input => {
    await writeFile(filePath, input.trim())
  }, 3000)
  let value = await ensureReadFile(filePath)
  let cmd = isWin ? 'ctrl' : 'cmd'

  let content = await editor({
    value,
    scrollTo: 'bottom',
    shortcuts: [
      {
        name: 'Save',
        key: `${cmd}+s`,
        onPress: input => {
          submit(input)
        },
        bar: 'right'
      },
      {
        name: 'Open',
        key: `${cmd}+o`,
        onPress: async () => {
          open(filePath)
        },
        bar: 'right'
      }
    ],
    onEscape: async input => {
      submit(input)
    },
    onAbandon: async input => {
      submit(input)
    },
    onInput: async input => {
      changed = true
      autoSave(input)
    }
  })
  hide()

  let trimmed = content.trim()

  if (changed) {
    await writeFile(filePath, trimmed)
  }
}

process.exit(0)

[xeniode]

Hi, thanks for sharing. Would it be possible for you to elaborate on how to use this? It looks like it would prompt me for a vault path. But I get an error. I tried creating obsidiandir.json in the /db dir, but still errors out.

The API docs for db are empty, so it is hard for me to understand what you are doing with it.

Thus I am looking for a little guidance on how you are using db.

Thanks.

[Ambushfall]

Yeah, of course, it prompts you for the location of your vault, the folder that contains the markdown files, and then it writes a list to the db, it is possible that i might've left out a default value xD

anyhow it should look like smthn like this

obsidiandir.json

{ 
  "obsidiandir" : ["~path/to/obsidiandir"] 
}

[xeniode]

That did the trick. Thank you much, works well.

[Ambushfall]

Ps, you dont have to create the file yourself, this is how it works generally

// const { data, write } = await db("filename")
// on calling await write(); it will create the file under ur kenvs db

// you can set defaults too

/***
*  This will basically create db/keyvaluestore.json
*  With the following content
*  { "someKeyValueFromJson" : { "otherKey": "string"}}
*
*/

 const { someKeyValueFromJson, write } = await db("keyvaluestore", 
{ 
    // this is the key we decouple in the const
    someKeyValueFromJson : { 
        otherKey: "string" 
        // ... any other default value
        }  
});

// to update otherkey, we would do this
// not a 100% sure, but it should work similar to a key value store
someKeyValueFromJson.otherKey = "smthn";
await write();