This aims for a comprehensive template to develop a Scratch 3.0 extension easily.
- scratch-gui and scratch-vm have been integrated with
git subtreeand everything is managed with Rush - Live reloading is supported
- Testing (TBD)
- Built files can be deployed to GitHub Pages
Developing your own extension for Scratch 3.0 is a little tricky since your extension requires scratch-gui and scratch-vm to be executed and integrating with them is not easy.
You can clone scratch-gui and scratch-vm manually and integrate your extension into them by using yarn link.
But yarn link could be a headache sometimes since it configures linkages between packages globally which means that you can have each package at only a particular directory.
If you would like to move a package to another directory or use a package at different directory, then you need to execute yarn unlink first to remove a global linkage which could be forgotten and not easy to manage everything.
So, this is developed as a out-of-the-box template which already integrate scratch-gui and scratch-vm with git subtree and can manage them with Rush.
Rush is a quite useful monorepo manager but can be used for sub trees as packages.
It manages linkages between packages locally unlike yarn link and builds all packages in the right order according to dependencies like your extension, scratch-vm and scratch-gui.
Also, thanks to Rush running task for all packages simultaneously, live reloading works for all packages by running just a single Rush task. When you change and save the source code of your extension, your extension and scratch-gui will be automatically built and browser will automatically reload scratch-gui with the latest extension.
Get this source code and install dependencies.
git clone https://github.com/eqot/scratch3-extension-template
cd scratch3-extension-template
rush update
Start a development server and watch update.
rush start
Build files.
rush build
Deploy built files to GitHub Pages.
rush deploy