By Kevin McAleer, 6 Minutes
Page last updated November 21, 2026

You started with an empty folder. You now have a plugin that adds two commands, a linter with two rules and a quick fix, and a drawer of blocks. More to the point, you know how every part of it works, so you can build the plugin your club, class or workbench needs.
| Lesson | Skill |
|---|---|
| 1 to 2 | How the plugin host works, where plugins live, and the Plugin Rack |
| 3 | A plugin with one command, and the edit, save, Reload loop |
| 4 | Load errors, crashes and how to track down a bug |
| 5 | Reading code with patterns, messages and the status bar |
| 6 | Editing the open file safely |
| 7 | Linters, diagnostics, severities and the Problems panel |
| 8 | Quick fixes |
| 9 | Rules about your own hardware, and avoiding false alarms |
| 10 | Custom blocks |
| 11 | Sharing a plugin, and trust |
Every plugin is built from the same four pieces.
| Decorator | The function receives | It returns |
|---|---|---|
@plugin.command(id, title) |
ctx |
message, edit, status, or a list of them |
@plugin.linter(name) |
ctx |
a list of diagnostic, each with optional fixes |
@plugin.blocks(name) |
nothing | a list of block |
Here’s the finished ClubKit. It’s also in the download below.
"""ClubKit: a Snakie plugin for our robot club."""
import re
from snakie import Context, block, diagnostic, edit, fix, message, plugin, status
HEADER = "# Robot Club\n"
PIN_USE = re.compile(r"Pin\(\s*(\d+)")
LONG_SLEEP = re.compile(r"\bsleep\(\s*(\d{3,})\s*\)")
OFF_HEADER = {23: "the power supply mode", 24: "USB power sensing", 29: "the VSYS voltage reading"}
# ---------- Commands ----------
@plugin.command("clubkit.header", "Add club header")
def add_header(ctx: Context):
"""Put the club's header comment at the top of the file."""
if ctx.file.content.startswith(HEADER):
return message("info", "This file already has the club header.")
return [
edit(HEADER + f"# File: {ctx.file.name}\n\n" + ctx.file.content),
message("info", f"Added the club header to {ctx.file.name}."),
]
@plugin.command("clubkit.pins", "List the pins")
def list_pins(ctx: Context):
"""Report every GPIO pin the program uses."""
pins = sorted({int(n) for n in PIN_USE.findall(ctx.file.content)})
if not pins:
return message("warning", "No pins found. Is this the right file?")
names = ", ".join(f"GP{n}" for n in pins)
return [
message("info", f"{ctx.file.name} uses {len(pins)} pin(s): {names}"),
status(f"Pins: {names}", tooltip="From ClubKit"),
]
# ---------- Linter ----------
@plugin.linter("club-rules")
def club_rules(ctx: Context):
"""Squiggle the mistakes our club makes most often."""
found = []
for number, line in enumerate(ctx.file.content.splitlines(), start=1):
code = line.split("#")[0]
match = LONG_SLEEP.search(code)
if match:
found.append(diagnostic(
number,
f"sleep({match.group(1)}) waits {match.group(1)} seconds. Did you mean milliseconds?",
severity="warning",
column=match.start() + 1,
end_column=match.end() + 1,
source="clubkit",
fixes=[fix(f"Change to sleep_ms({match.group(1)})", f"sleep_ms({match.group(1)})")],
))
for match in PIN_USE.finditer(code):
pin = int(match.group(1))
if pin in OFF_HEADER:
found.append(diagnostic(
number,
f"GP{pin} is used by the Pico for {OFF_HEADER[pin]}. Pick another pin.",
severity="error",
column=match.start(1) + 1,
end_column=match.end(1) + 1,
source="clubkit",
))
return found
# ---------- Blocks ----------
@plugin.blocks("ClubKit")
def club_blocks():
"""Blocks for the club's robot."""
imports = [{"module": "clubbot"}]
return [
block("forward", "drive forward %1 cm", "clubbot.forward({CM})\n",
args=[{"name": "CM", "kind": "number", "default": 20}],
imports=imports, tooltip="Drive forward in a straight line."),
block("turn", "turn %1 by %2 degrees", "clubbot.turn({DIR} * {DEG})\n",
args=[{"name": "DIR", "kind": "choice", "options": [["right", "1"], ["left", "-1"]]},
{"name": "DEG", "kind": "number", "default": 90}],
imports=imports, tooltip="Turn on the spot."),
block("stop", "stop the motors", "clubbot.stop()\n",
imports=imports, tooltip="Stop both motors."),
block("distance", "distance ahead in cm", "clubbot.distance()",
shape="value", output="Number",
imports=imports, tooltip="How far away the nearest thing is."),
]
Downloads
.snakie/pluginsClubKit was a made-up example. Here are some real ones worth building.
main() loopinfo diagnostic on any bare Pin(15), suggesting a named constant such as BUZZER_PIN = 15while True: loops with no sleep inside, which can make a board hard to interruptStart with whichever mistake you’ve explained to someone three times this month.
Build a plugin, share it with someone, and tell us what it does. We’d love to see it.
Quick quiz 1 of 3
Which decorator would you use for a rule that underlines mistakes as you type?
Quick quiz 2 of 3
What do all plugin functions have in common?
Quick quiz 3 of 3
What is the best first plugin to write for your own group?
You can use the arrows ← → on your keyboard to navigate between lessons.
Comments