ash-project/igniter
1
0
Fork 0
mirror of https://github.com/ash-project/igniter.git synced 2024-09-19 21:12:54 +12:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore: add some docs for extensions

Browse source
This commit is contained in:
Zach Daniel 2024-09-13 18:21:38 -04:00
parent 1c122be06f
commit ef46c64672
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
documentation/configuring-igniter.md
View file

@ -8,6 +8,16 @@ Use `mix igniter.setup` to create a `.igniter.exs` file in your project root. Th
See the documentation in `Igniter.Project.IgniterConfig` for available configuration. See the documentation in `Igniter.Project.IgniterConfig` for available configuration.
## Extensions
Igniter supports extensions. These extensions are limited to determining where modules should be created (i.e a module in `/web` ending in `Controller`).
This is not bulletproof and will likely need to be improved over time. (The best thing would be if Phoenix conventions were the same as the
elixir conventions of module names matching paths). To this end, you will want to add the phoenix extension if your generator builds any phoenix-related modules.
For an end user, this can be done with `mix igniter.add_extension phoenix`.
For those writing tasks, use `Igniter.compose_task("igniter.add_extension", ["phoenix"])`.
## Moving files ## Moving files
One available configuration is `module_location`. This configuration dictates where modules are placed when there is a folder that exactly matches their module name. There are two available strategies for this, and with igniter not only can you change your mind, but you can actually _move back and forth_ between each strategy. To move any modules to their rightful place, use `mix igniter.move_files`. One available configuration is `module_location`. This configuration dictates where modules are placed when there is a folder that exactly matches their module name. There are two available strategies for this, and with igniter not only can you change your mind, but you can actually _move back and forth_ between each strategy. To move any modules to their rightful place, use `mix igniter.move_files`.