You've already forked tribes-plugin-template
self
0ba524bad9
CI / Test (push) Failing after 21s
Update the static plugin template to match the host-backed test/precommit wrapper generated by tribes-plugin-new. Clarify dependency boundaries around host_api, ui@1, and raw Mix aliases.
54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# Development
|
|
|
|
## Local Setup
|
|
|
|
This template expects a sibling Tribes checkout at `../tribes`.
|
|
|
|
```bash
|
|
mix deps.get
|
|
devenv shell -- plugin test
|
|
```
|
|
|
|
To load the plugin in the host during development:
|
|
|
|
```bash
|
|
cd ../tribes
|
|
ln -s ../tribes-plugin-template plugins/my_plugin
|
|
iex --sname dev -S mix phx.server
|
|
```
|
|
|
|
Set `TRIBES_HOST_ROOT=/path/to/tribes` if your host checkout is not a sibling.
|
|
|
|
## Command Wrapper
|
|
|
|
Use `scripts/plugin` for host-aware workflows:
|
|
|
|
```bash
|
|
scripts/plugin validate
|
|
scripts/plugin test
|
|
scripts/plugin precommit
|
|
scripts/plugin smoke
|
|
```
|
|
|
|
Inside the template devenv shell, the `plugin` command is available and forwards
|
|
through the same wrapper.
|
|
|
|
Prefer `plugin test` over raw `mix test` for host-backed plugin suites. The
|
|
wrapper runs Mix with the host database/services and points the host plugin
|
|
manager at the host manifest plus built-in providers such as `tribes_ui`. Use
|
|
`mix raw_test` / `mix raw_precommit` only for deliberate low-level debugging.
|
|
|
|
## Assets
|
|
|
|
Browser code lives in `assets/ts` and is compiled to `priv/static`:
|
|
|
|
```bash
|
|
devenv shell -- npm run build --prefix assets
|
|
```
|
|
|
|
Use the wrapper form for installs too:
|
|
|
|
```bash
|
|
devenv shell -- npm install --prefix assets
|
|
```
|