From: Karen Etheridge Date: Wed, 16 Jul 2014 01:21:50 +0000 (-0700) Subject: Devel-REPL-1.003026 X-Git-Tag: v1.003026^0 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2FDevel-REPL.git;a=commitdiff_plain;h=e40eb4d893968e6aada17d137cc43e698394c684;hp=5bcac6610ff5818b493b799072e47f3ebc8f1431 Devel-REPL-1.003026 - fix inclusion of of optional plugin prereqs when installation is run non-interactively --- diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..c37d76f --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,76 @@ + +CONTRIBUTING + +Thank you for considering contributing to this distribution. This file +contains instructions that will help you work with the source code. + +The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla). +This means than many of the usual files you might expect are not in the +repository, but are generated at release time (e.g. Makefile.PL). + +However, you can run tests directly using the 'prove' tool: + + $ prove -l + $ prove -lv t/some_test_file.t + $ prove -lvr t/ + +In most cases, 'prove' is entirely sufficent for you to test any +patches you have. + +You may need to satisfy some dependencies. The easiest way to satisfy +dependencies is to install the last release -- this is available at +https://metacpan.org/release/Devel-REPL. + +If you use cpanminus, you can do it without downloading the tarball first: + + $ cpanm --reinstall --installdeps --with-recommends Devel::REPL + +Dist::Zilla is a very powerful authoring tool, but requires a number of +author-specific plugins. If you would like to use it for contributing, +install it from CPAN, then run one of the following commands, depending on +your CPAN client: + + $ cpan `dzil authordeps --missing` +or + $ dzil authordeps --missing | cpanm + +You should then also install any additional requirements not needed by the +dzil build but may be needed by tests or other development: + + $ cpan `dzil listdeps --author --missing` +or + $ dzil listdeps --author --missing | cpanm + +Or, you can use the 'dzil stale' command to install all requirements at once: + + $ cpan Dist::Zilla::App::Command::stale + $ cpan `dzil stale --all` +or + $ cpanm Dist::Zilla::App::Command::stale + $ dzil stale --all | cpanm + +You can also do this via cpanm directly: + + $ cpanm --reinstall --installdeps --with-develop --with-recommends Devel::REPL + +Once installed, here are some dzil commands you might try: + + $ dzil build + $ dzil test + $ dzil test --release + $ dzil xtest + $ dzil listdeps --json + $ dzil build --notgz + +You can learn more about Dist::Zilla at http://dzil.org/. + + +If you have found a bug, but do not have an accompanying patch to fix it, you +can submit an issue report here: +https://rt.cpan.org/Public/Dist/Display.html?Name=Devel-REPL +or via bug-Devel-REPL@rt.cpan.org. +This is a good place to send your questions about the usage of this distribution. + + +This file was generated via Dist::Zilla::Plugin::GenerateFile::ShareDir 0.005 from a +template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.065. diff --git a/Changes b/Changes index 558256b..2e2eefd 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,8 @@ Revision history for {{ $dist->name }} {{ $NEXT }} + +1.003026 2014-07-16 01:20:41Z - fix inclusion of of optional plugin prereqs when installation is run non-interactively diff --git a/LICENSE b/LICENSE index 0a98a93..64771d3 100644 --- a/LICENSE +++ b/LICENSE @@ -22,7 +22,7 @@ This is free software, licensed under: Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. - 51 Franklin St, Suite 500, Boston, MA 02110-1335 USA + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. diff --git a/README.md b/README.md index df14787..244a53c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Devel::REPL - a modern perl interactive shell +# VERSION + +version 1.003026 + # SYNOPSIS my $repl = Devel::REPL->new; @@ -24,7 +28,7 @@ example to pre-load certain Perl modules when working on a particular project. # USAGE -To start a shell, follow one of the examples in the ["SYNOPSIS"](#SYNOPSIS) above. +To start a shell, follow one of the examples in the ["SYNOPSIS"](#synopsis) above. Once running, the shell accepts and will attempt to execute any code given. If the code executes successfully you'll be shown the result, otherwise an error @@ -47,8 +51,9 @@ run inside a Block structure (to protect the REPL in case the code blows up), which means a single statement doesn't require the semicolon. You can add one if you like, though. -If you followed the first example in the ["SYNOPSIS"](#SYNOPSIS) above, you'll have the -History and LexEnv plugins loaded (and there are many more available). +If you followed the first example in the ["SYNOPSIS"](#synopsis) above, you'll have the +[History](https://metacpan.org/pod/Devel::REPL::Plugin::History) and [LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::LexEnv) +plugins loaded (and there are many more available). Although the shell might support "up-arrow" history, the History plugin adds "bang" history to that so you can re-execute chosen commands (with e.g. `!53`). The LexEnv plugin ensures that lexical variables declared with the @@ -77,8 +82,6 @@ To quit from the shell, hit `Ctrl+D` or `Ctrl+C`. MSWin32 NOTE: control keys won't work if TERM=dumb because readline functionality will be disabled. - - ## Run Control Files For particular projects you might well end up running the same commands each @@ -101,48 +104,48 @@ or realive to the current working directory: system$ re.pl --rcfile /path/to/my/project/repl.rc Within the run control file you might want to load plugins. This is covered in -["The REPL shell object"](#The REPL shell object) section, below. +["The REPL shell object"](#the-repl-shell-object) section, below. ## Profiles To allow for the sharing of run control files, you can fashion them into a Perl module for distribution (perhaps via the CPAN). For more information on -this feature, please see the [Devel::REPL::Profile](http://search.cpan.org/perldoc?Devel::REPL::Profile) manual page. +this feature, please see the [Devel::REPL::Profile](https://metacpan.org/pod/Devel::REPL::Profile) manual page. A `Standard` profile ships with `Devel::REPL`; it loads the following plugins (note that some of these require optional features -- or you can also use the `Minimal` profile): -- [Devel::REPL::Plugin::History](http://search.cpan.org/perldoc?Devel::REPL::Plugin::History) -- [Devel::REPL::Plugin::LexEnv](http://search.cpan.org/perldoc?Devel::REPL::Plugin::LexEnv) -- [Devel::REPL::Plugin::DDS](http://search.cpan.org/perldoc?Devel::REPL::Plugin::DDS) -- [Devel::REPL::Plugin::Packages](http://search.cpan.org/perldoc?Devel::REPL::Plugin::Packages) -- [Devel::REPL::Plugin::Commands](http://search.cpan.org/perldoc?Devel::REPL::Plugin::Commands) -- [Devel::REPL::Plugin::MultiLine::PPI](http://search.cpan.org/perldoc?Devel::REPL::Plugin::MultiLine::PPI) -- [Devel::REPL::Plugin::Colors](http://search.cpan.org/perldoc?Devel::REPL::Plugin::Colors) -- [Devel::REPL::Plugin::Completion](http://search.cpan.org/perldoc?Devel::REPL::Plugin::Completion) -- [Devel::REPL::Plugin::CompletionDriver::INC](http://search.cpan.org/perldoc?Devel::REPL::Plugin::CompletionDriver::INC) -- [Devel::REPL::Plugin::CompletionDriver::LexEnv](http://search.cpan.org/perldoc?Devel::REPL::Plugin::CompletionDriver::LexEnv) -- [Devel::REPL::Plugin::CompletionDriver::Keywords](http://search.cpan.org/perldoc?Devel::REPL::Plugin::CompletionDriver::Keywords) -- [Devel::REPL::Plugin::CompletionDriver::Methods](http://search.cpan.org/perldoc?Devel::REPL::Plugin::CompletionDriver::Methods) -- [Devel::REPL::Plugin::ReadlineHistory](http://search.cpan.org/perldoc?Devel::REPL::Plugin::ReadlineHistory) +- [Devel::REPL::Plugin::History](https://metacpan.org/pod/Devel::REPL::Plugin::History) +- [Devel::REPL::Plugin::LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::LexEnv) +- [Devel::REPL::Plugin::DDS](https://metacpan.org/pod/Devel::REPL::Plugin::DDS) +- [Devel::REPL::Plugin::Packages](https://metacpan.org/pod/Devel::REPL::Plugin::Packages) +- [Devel::REPL::Plugin::Commands](https://metacpan.org/pod/Devel::REPL::Plugin::Commands) +- [Devel::REPL::Plugin::MultiLine::PPI](https://metacpan.org/pod/Devel::REPL::Plugin::MultiLine::PPI) +- [Devel::REPL::Plugin::Colors](https://metacpan.org/pod/Devel::REPL::Plugin::Colors) +- [Devel::REPL::Plugin::Completion](https://metacpan.org/pod/Devel::REPL::Plugin::Completion) +- [Devel::REPL::Plugin::CompletionDriver::INC](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::INC) +- [Devel::REPL::Plugin::CompletionDriver::LexEnv](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::LexEnv) +- [Devel::REPL::Plugin::CompletionDriver::Keywords](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::Keywords) +- [Devel::REPL::Plugin::CompletionDriver::Methods](https://metacpan.org/pod/Devel::REPL::Plugin::CompletionDriver::Methods) +- [Devel::REPL::Plugin::ReadlineHistory](https://metacpan.org/pod/Devel::REPL::Plugin::ReadlineHistory) ## Plugins Plugins are a way to add functionality to the REPL shell, and take advantage of -`Devel::REPL` being based on the [Moose](http://search.cpan.org/perldoc?Moose) object system for Perl 5. This +`Devel::REPL` being based on the [Moose](https://metacpan.org/pod/Moose) object system for Perl 5. This means it's simple to 'hook into' many steps of the R-E-P-L process. Plugins can change the way commands are interpreted, or the way their results are output, or even add commands to the shell environment. A number of plugins ship with `Devel::REPL`, and more are available on the CPAN. Some of the shipped plugins are loaded in the default profile, mentioned -above. These plugins can be loaded in your `$HOME/.re.pl/repl.rc` like: +above. These plugins can be loaded in your ` $HOME/.re.pl/repl.rc ` like: load_plugin qw( CompletionDriver::Global DumpHistory ); Writing your own plugins is not difficult, and is discussed in the -[Devel::REPL::Plugin](http://search.cpan.org/perldoc?Devel::REPL::Plugin) manual page, along with links to the manual pages of +[Devel::REPL::Plugin](https://metacpan.org/pod/Devel::REPL::Plugin) manual page, along with links to the manual pages of all the plugins shipped with `Devel::REPL`. ## The REPL shell object @@ -165,7 +168,7 @@ control files have already been executed: # OPTIONAL FEATURES -In addition to the prerequisites declared in this distribution, which should be automatically installed by your [CPAN](http://search.cpan.org/perldoc?CPAN) client, there are a number of optional features, used by +In addition to the prerequisites declared in this distribution, which should be automatically installed by your [CPAN](https://metacpan.org/pod/CPAN) client, there are a number of optional features, used by additional plugins. You can install any of these features by installing this distribution interactively (e.g. `cpanm --interactive Devel::REPL`).