You've already forked tribes-plugin-new
self
f0331eb311
Add a minimal devenv setup for the plugin generator project with Elixir, formatting hooks, and a tracked lock file. Document the local test command in the README.
39 lines
743 B
Markdown
39 lines
743 B
Markdown
# tribes_plugin
|
|
|
|
Igniter-powered generators for standalone Tribes plugin projects.
|
|
|
|
## Usage
|
|
|
|
Create a new plugin project:
|
|
|
|
```bash
|
|
mix tribes_plugin.new ../tribes-plugin-billing --description "Billing reports"
|
|
```
|
|
|
|
Install or refresh plugin files in an existing Mix project:
|
|
|
|
```bash
|
|
mix tribes_plugin.install --app billing_reports --module BillingReports
|
|
```
|
|
|
|
Generate an additional host-chrome LiveView page:
|
|
|
|
```bash
|
|
mix tribes_plugin.gen.page Reports
|
|
```
|
|
|
|
The generated plugin keeps `:tribes_plugin` as a dev/test dependency so future
|
|
template updates can be delivered through:
|
|
|
|
```bash
|
|
mix igniter.upgrade tribes_plugin
|
|
```
|
|
|
|
## Development
|
|
|
|
Use the repo-local devenv shell for tests and formatting:
|
|
|
|
```bash
|
|
devenv shell -- mix test
|
|
```
|