DSW Plugin Template

Template repository to create DSW plugins.

Get Started

1. Fill in the project metadata.
2. Define settings and user settings data using zod.
   • If you don't want to have any settings, you can delete these files and use PluginBuilder.createWithNoSettings instead.
   • If you want just one, you can delete the other and create a null codec instead using makeNullCodec().
3. Start implementing your plugin by defining the components in the components folder and adding them to the PluginBuilder in plugin.ts. See @ds-wizard/plugin-sdk for more details.

Useful Commands

• npm run build = creates a production build of the plugin
• npm run dev = watch for file changes and run the dev server (you can change the port in package.json)
• npm run typecheck = check for type errors
• npm run lint = run linter
• npm run format = format the code (however, it is more convenient to set up formatter directly in VS Code, see below)

Formatter in VS Code

Create .vscode/settings.json for easier code editing:

{
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
}

Readme and License

Update the rest of the readme and delete the template instructions. Update the license in LICENSE and package.json.

---

Plugin Name

Plugin description.

Plugin UUID: <UUID>

How to Install

See the Plugins page in the DSW Guide for instructions on how to install the plugin.

Changelog

0.1.0

Initial version...

License

This project is licensed under the MIT License - see the LICENSE file for more details.