oracular (3) App::Sqitch::Role::ContextCommand.3pm.gz

Name

       App::Sqitch::Role::ContextCommand - A command that needs to know where things are

Synopsis

         package App::Sqitch::Command::add;
         extends 'App::Sqitch::Command';
         with 'App::Sqitch::Role::ContextCommand';

Description

       This role encapsulates the options and target parameters required by commands that need to know where to
       find project files.

Interface

   Class Methods
       "options"

         my @opts = App::Sqitch::Command::add->options;

       Adds contextual options "--plan-file" and "--top-dir".

       "configure"

       Configures the options used for target parameters.

   Instance Methods
       "target_params"

       Returns a list of parameters to be passed to App::Sqitch::Target's "new" and "all_targets" methods.

See Also

       App::Sqitch::Command::add
           The "add" command adds changes to the the plan and change scripts to the project.

       App::Sqitch::Command::deploy
           The "deploy" command deploys changes to a database.

       App::Sqitch::Command::bundle
           The "bundle" command bundles Sqitch changes for distribution.

Author

       David E. Wheeler <david@justatheory.com>

License

       Copyright (c) 2012-2024 iovation Inc., David E. Wheeler

       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
       associated documentation files (the "Software"), to deal in the Software without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
       following conditions:

       The above copyright notice and this permission notice shall be included in all copies or substantial
       portions of the Software.

       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
       LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
       EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
       IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
       THE USE OR OTHER DEALINGS IN THE SOFTWARE.