/usr/share/doc/libdist-zilla-perl/todo/config-arg-prefix.mkdn is in libdist-zilla-perl 4.300005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | # CONFIG ARG PREFIX RESERVATIONS
1. All config arg names that start with [a-z] are reserved for the plugin.
2. All config arg names that start with - are reserved for the plugin.
3. All config arg names that start with : are reserved for Dist::Zilla.
4. All config arg names that start with = are prohibited and are used internall
for things like plugin_name (?)
This will let us say:
[Plugin]
:version = 1.23
...which will then assert: Plugin->VERSION(1.23)
The first two rules are already more or less in place for things like the
Prereq plugin. It might be cool to make it easy for plugin authors to get at
the two sets of args (-x and x) in their BUILDARGS or something. Possibly a
Plugin-role-provided method to partition the args.
We should also try to set aside the :-args as early as possible, so they're
never available during plugin init without really digging. This would be
similar to the way in which -args are not provided to generators in
Sub::Exporter.
## TODO
Think about applying the same rules to plugin names. For example, in the
future virtual plugins could be created with names like :Blorgle that do...
stuff.
|