Script Kit 1.59.1 - May 2023 Release

[johnlindquist]

Script Kit 1.59.1 - May 2023 Release

• Download from https://www.scriptkit.com/
• Join our Discord: https://discord.gg/qnUX4XqJQd
• Sponsor to Keep Script Kit Growing ❤️ (and unlock the debugger): https://github.com/sponsors/johnlindquist/sponsorships?sponsor=johnlindquist

Sunsetting Features

We're "sunsetting"/not supporting a few features going forward.

The npm and db apis will still be available (they're used internally in the SDK!), but we won't be actively supporting them

1. await npm(). Use await import() or regular import statements instead.

Script Kit now recommends using standard import methods. When you attempt to run a script and an import fails, Script Kit will catch the error and prompt you to install it. This removes the need for await npm(). This is especially useful for people using TypeScript as you don't need to worry about typing npm anymore.

2. await db(). We now recommend keyv: https://www.npmjs.com/package/keyv

keyv is a much better solution for storing/retrieving data and achieves all of the future features we had planned for db.

We'll do our best to update older demos/tutorials that use these methods as we're able.

Previews Everywhere

Every prompt type (term, drop, fields, etc) now supports the preview key. Pass in HTML to display it to the right side of your prompt. This is great for instructions and guiding the user through each script:

Note: The md() helper is often used to transform markdown into HTML

await term({
  preview: md(`# Follow these steps:

1. First, type \`ls\` to see the files in this directory
2. Then, type \`cat <filename>\` to see the contents of a file
3. Finally, type \`exit\` to exit the terminal
  `),
})

await drop({
  placeholder: "Drop an mp3",
  preview: md(`# Convert mp3 to wav

## Instructions

1. Drag and drop an mp3 file
2. A progress prompt will open then close when ready
3. Your .wav will be created next to the .mp3 file
    `),
})

term.write()

When a term prompt is open, you can issue terminal commands from shortcuts, etc by using term.write(myCommand)

await term({
  shortcuts: [
    {
      name: "List files",
      key: `${cmd}+l`,
      onPress: () => {
        let command = isWin ? "dir" : "ls"
        term.write(command)
      },
      bar: "right",
    },
    {
      name: "Up a Directory",
      key: `${cmd}+u`,
      onPress: () => {
        term.write("cd ..")
      },
      bar: "left",
    },
    {
      name: "Clear",
      key: `${cmd}+k`,
      onPress: () => {
        let command = isWin ? "cls" : "clear"
        term.write(command)
      },
      bar: "left",
    },
  ],
})

Kenv Improvements:

"New Kenv" prompt for GitHub repo:

When creating a new Kenv, it will guide you through the process of linking the Kenv to a remote GitHub repo:

With a script selected, take Kenv actions

Press "right" (or cmd+k) with a script selected to reveal many "Kenv" actions:

Push/Pull From Remote Kenv

From a script (or a "Manage Kenv"), you can now push/pull changes as it swaps you over to a terminal to take action:

"Trusted" Kenvs

Thanks to Script Kit + AI integrations, we've had a large influx of "non-developer" users. This necessitated more warnings/protections around sharing scripts.

Some scripts have features that run scripts automatically: Shortcuts, schedule, background, etc. These kenvs now need to be "Trusted" to enable these features to add an extra layer of protection against bad actors. PLEASE only use scripts from people you absolutely trust.

You can "trust" a kenv during new/clone setup, or later from the Kit tab->Manage Kenv menu. You can also "untrust" a kenv from the same menu.

"Trigger" flag

If a script is run by "schedule", "shortcut", etc, you can now access what triggered it by using

if(flag?.trigger === "schedule") // do something specific

This will allow you customize the behavior based on whether you invoked it manually or automatically

Windows Fixes

Handled edge-cases around

• Windows setup/install process
• Windows usernames that include spaces
• Windows terminal fixes

Thanks to all the Windows bug reports and testers on Discord. Please keep them coming ❤️

Node 18.15.0

We're now on node 18.15.0. View the CHANGELOG: https://github.com/nodejs/node/blob/main/doc/changelogs/CHANGELOG_V18.md#18.15.0

Happy Scripting - John Lindquist