-
Notifications
You must be signed in to change notification settings - Fork 6
/
README
217 lines (153 loc) · 6.95 KB
/
README
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
NAME
Devel::REPL - a modern perl interactive shell
SYNOPSIS
my $repl = Devel::REPL->new;
$repl->load_plugin($_) for qw(History LexEnv);
$repl->run
Alternatively, use the 're.pl' script installed with the distribution
system$ re.pl
DESCRIPTION
This is an interactive shell for Perl, commonly known as a REPL - Read,
Evaluate, Print, Loop. The shell provides for rapid development or
testing of code without the need to create a temporary source code file.
Through a plugin system, many features are available on demand. You can
also tailor the environment through the use of profiles and run control
files, for 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" 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 message will be returned. Here are a few examples:
$_ print "Hello, world!\n"
Hello, world!
1
$_ nosuchfunction
Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5.
$_
In the first example above you see the output of the command ("Hello,
world!"), if any, and then the return value of the statement (1).
Following that example, an error is returned when the execution of some
code fails.
Note that the lack of semicolon on the end is not a mistake - the code
is 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" above, you'll have
the History and 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 "my" keyword will automatically persist
between statements executed in the REPL shell.
When you "use" any Perl module, the "import()" will work as expected -
the exported functions from that module are available for immediate use:
$_ carp "I'm dieeeing!\n"
String found where operator expected at (eval 129) line 5, near "carp "I'm dieeeing!\n""
(Do you need to predeclare carp?)
Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n""
BEGIN not safe after errors--compilation aborted at (eval 129) line 5.
$_ use Carp
$_ carp "I'm dieeeing!\n"
I'm dieeeing!
at /usr/share/perl5/Lexical/Persistence.pm line 327
1
$_
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 time the REPL shell starts up - loading Perl modules, setting
configuration, and so on. A run control file lets you have this done
automatically, and you can have multiple files for different projects.
By default the "re.pl" program looks for "$HOME/.re.pl/repl.rc", and
runs whatever code is in there as if you had entered it at the REPL
shell yourself.
To set a new run control file that's also in that directory, pass it as
a filename like so:
system$ re.pl --rcfile myproject.pc
If the filename happens to contain a forwardslash, then it's used
absolutely, 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" 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 manual
page.
A default profile ships with "Devel::REPL"; it loads the following
plugins:
* Devel::REPL::Plugin::History
* Devel::REPL::Plugin::LexEnv
* Devel::REPL::Plugin::DDS
* Devel::REPL::Plugin::Packages
* Devel::REPL::Plugin::Commands
* Devel::REPL::Plugin::MultiLine::PPI
Plugins
Plugins are a way to add funcionality to the REPL shell, and take
advantage of "Devel::REPL" being based on the 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.
Writing your own plugins is not difficult, and is discussed in the
Devel::REPL::Plugin manual page, along with links to the manual pages of
all the plugins shipped with "Devel::REPL".
The REPL shell object
From time to time you'll want to interact with or manipulate the
"Devel::REPL" shell object itself; that is, the instance of the shell
you're currently running.
The object is always available through the $_REPL variable. One common
requirement is to load an additional plugin, after your profile and run
control files have already been executed:
$_ $_REPL->load_plugin('Timing');
1
$_ print "Hello again, world!\n"
Hello again, world!
Took 0.00148296356201172 seconds.
1
$_
REQUIREMENTS
In addition to the contents of the standard Perl distribution, you will
need the following:
* Moose >= 0.74
* MooseX::Object::Pluggable >= 0.0009
* MooseX::Getopt >= 0.18
* MooseX::AttributeHelpers >= 0.16
* namespace::clean
* File::HomeDir
* Task::Weaken
* B::Concise
* Term::ANSIColor
* Devel::Peek
Optionally, some plugins if installed will require the following
modules:
* PPI
* Data::Dump::Streamer
* Data::Dumper::Concise
* File::Next
* Sys::SigAction
* B::Keywords
* Lexical::Persistence
* App::Nopaste
* Module::Refresh
AUTHOR
Matt S Trout - mst (at) shadowcatsystems.co.uk
(<http://www.shadowcatsystems.co.uk/>)
CONTRIBUTORS
Stevan Little - stevan (at) iinteractive.com
Alexis Sukrieh - sukria+perl (at) sukria.net
epitaph
mgrimes - mgrimes (at) cpan dot org
Shawn M Moore - sartak (at) gmail.com
Oliver Gorwits - oliver on irc.perl.org
Andrew Moore - "<amoore@cpan.org>"
Norbert Buchmuller "<norbi@nix.hu>"
Dave Houston "<dhouston@cpan.org>"
Chris Marshall
LICENSE
This library is free software under the same terms as perl itself