SeaCogs/.docs/hotreload.md

# HotReload

HotReload automatically reloads cogs in local cog paths on file change.  
This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog.

## Installation

```bash
[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
[p]cog install seacogs hotreload
[p]load hotreload
```

## Commands

### hotreload compile

Determines if the cog should try to compile a modified Python file before reloading the associated cog. Useful for catching syntax errors. Disabled by default.

### hotreload notifychannel

Set the channel where hotreload will send notifications when a cog is reloaded.

### hotreload list

Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths.
docs(hotreload): add docs 2025-01-26 15:28:21 +00:00			`# HotReload`

			`HotReload automatically reloads cogs in local cog paths on file change.`
			This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog.

			`## Installation`

			```bash
			`[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs`
			`[p]cog install seacogs hotreload`
docs: fixed incorrect command instructions 2025-01-26 15:33:34 +00:00			`[p]load hotreload`
docs(hotreload): add docs 2025-01-26 15:28:21 +00:00			```

			`## Commands`

feat(hotreload): add pre-compilation this feature will detect syntax errors before reloading a cog and cancel the cog reload if it detects one. DOES NOT detect runtime/logic errors, only syntax errors. 2025-01-29 23:24:19 +00:00			`### hotreload compile`

			`Determines if the cog should try to compile a modified Python file before reloading the associated cog. Useful for catching syntax errors. Disabled by default.`

docs(hotreload): add docs 2025-01-26 15:28:21 +00:00			`### hotreload notifychannel`

			`Set the channel where hotreload will send notifications when a cog is reloaded.`

			`### hotreload list`

			`Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths.`