Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-01-24 03:06:16 +00:00
Code Issues Projects Releases Wiki Activity
super-productivity/packages/plugin-dev/QUICK_START.md
Johannes Millan f7f09e2171 feat(plugin): add simplified plugin development options following KISS principles 
- Add minimal-plugin: Plain JavaScript, no build process, just 10 lines
- Add simple-typescript-plugin: TypeScript with minimal tooling (just tsc)
- Add QUICK_START.md guide for choosing the right approach
- Provide progressive complexity: minimal → simple → full featured

This gives developers options based on their needs:
- Quick prototyping with plain JS
- TypeScript support without webpack complexity
- Full featured setup only when needed
2025-06-24 21:04:26 +02:00

1.1 KiB
Raw Permalink Blame History

Plugin Development Quick Start

Option 1: Plain JavaScript (Simplest)

cd minimal-plugin
# Edit plugin.js
# Zip the files and upload

Pros: No build step, instant feedback Cons: No TypeScript, no bundling

Option 2: Simple TypeScript (Recommended)

cd simple-typescript-plugin
npm install
npm run build
# Find plugin.zip in dist/

Pros: TypeScript support, simple build Cons: Limited to single file

Option 3: Full TypeScript + Webpack (Advanced)

cd example-plugin
npm install
npm run build
npm run package

Pros: Multiple files, full tooling Cons: More complex setup

Which Should I Use?

  • Just testing? → Use minimal-plugin
  • Want TypeScript? → Use simple-typescript-plugin
  • Building complex plugin? → Use example-plugin

Development Tips

  1. Start with minimal-plugin to understand the API
  2. Move to TypeScript when you need type safety
  3. Only use webpack if you need multiple source files

Testing Your Plugin

  1. Copy files to src/assets/my-plugin/ for local testing
  2. Or zip and upload via Settings → Plugins

That's it! 🚀