/ 
App-VTide-v1.0.3
River stage zero No dependents
/ App::VTide::Command::Save

NAME

App::VTide::Command::Save - Save configuration changes

VERSION

This documentation refers to App::VTide::Command::Save version 1.0.3

SYNOPSIS

  vtide save [(--name|-n) files-name] file-or-glob (file-or-glob...)
  vtide save --record-env
  vtide save --diff-env
  vtide save --save-env
  vtide save [--help|--man]

OPTIONS:
 -n --name[=]str  Save the listed files or globs to the editor files list
                  under this name (Default is the project name)
 -r --record-env  Record the current environment (use before running commands
                  like nvm, rvm and perlbrew)
 -d --diff-env    Show the diff of the current environment and recorded
                  environment
 -s --save-env    Save the environment differences to .vtide.yml
 -v --verbose     Show more verbose output.
     --help       Show this help
     --man        Show full documentation

DESCRIPTION

This App::VTide command saves extra information to the .vtide.yml config file. There are two forms:

files

Saving files or globs to the editor/files list makes it easier to add new groups of files. The name of the groups is specified by the --name parameter.

environment

Saving environment variable changes so specific groups of environment variables can be set up each time a session is started. This is a multi step process where the current environment before changes are saved via --record=env then the changes are made (e.g. running perlbrew, nvm, rvm etc) and those changes can be viewed via --dif-env and recorded to the .vtide.yml file via --save-env. This creates a temporary file .current-env to store the environment variables when --record-env is run.

SUBROUTINES/METHODS

run ()

Need to implement

save ($name, @files)

Saves new file group $name with the file or glob patters from @files into the local .vtide.yml config file.

record_env ()

Save the current environment variables to a temporary file

diff_env ()

Find the environment keys that differ in the current environment vs that stored in the temporary file

save_env ()

Save environment differences to the projects .vtide.yml file

details_sub ()

Returns the commands details.

ATTRIBUTES

env_store

The name of the temporary file for storing the environment variables

HOOKS

save_record_env ()

save_save_env ( $diff_env )

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

LICENSE AND COPYRIGHT

Copyright (c) 2016 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.