para

head

my $text = edit('original text');
say "Edited text: {$text.trim}";


Proc::Editor runs a text editor and returns the edited text.


This is merely a shortcut for convenience, all arguments are passed on to
C<Proc::Editor.new.edit(...)>.


Create a new instance of C<Proc::Editor>. C<:editors> may be used to override
the default list of editors to try. By default, the environment variables
$VISUAL and $EDITOR are checked, then it tries /usr/bin/vi, /bin/vi and /bin/ed
(in that order).


C<edit(Str $text?, IO::Path :$file, Bool :$keep)>


Writes C<$text> to a temporary file runs an editor with that file as argument.
On success, the contents of the file are returned. If C<$file> is defined, it
is used instead of creating a temporary file. The file used (temporary or not)
are deleted afterwards unless C<:keep> is provided.


Starts an editor with the given C<$path> as argument. Returns the editors
exit-code on success (which should always be 0) or dies on error.


This library is free software; you can redistribute it and/or modify it under
the Artistic License 2.0.



class Proc::Editor:ver<0.0.2> {
  has @.editors = (
    %*ENV<VISUAL>,
    %*ENV<EDITOR>,
    |</usr/bin/vi /bin/vi /bin/ed>
  ).grep(*.defined);

  # TODO: Check if the file already exists and if so, try other paths.
  method temporary-file(--> IO::Path) {
    $*TMPDIR.add(('edit', $*PID, $.WHERE, now.Rat, 10000.rand.Int).join('-'))
  }

  method edit-file(IO::Path:D $path) {
    my $exitcode;

    for @.editors.grep: { .e && .f && .x with .IO } -> $editor {
      my $proc = Proc::Async.new: $editor, $path.absolute;

      react {
        whenever $proc.start {
          $exitcode = .exitcode;
          done;
        }

        # Catch SIGINT and pass it on to the edior, otherwise it'll kill the
        # parent process (us).
        whenever signal(SIGINT) {
          $proc.kill('INT');
        }
      }

      CATCH {
        default {
          # Silently discard exceptions, since we're trying several editors
          # that may not exist so "not found" errors are to be expected.
        }
      }

      return $exitcode if $exitcode.defined;
    }

    die "No working editor found";
  }

  multi method edit(Proc::Editor:D: Str $text?, IO::Path :$file, Bool :$keep) {
    my $temporary-file = $file // $.temporary-file;

    LEAVE {
      $temporary-file.unlink unless $keep;
    }

    $temporary-file.spurt($text) if $text.defined;

    my $exitcode = $.edit-file($temporary-file);

    if $exitcode == 0 {
      return $temporary-file.slurp;
    }
    else {
      fail "Failed to invoke editor";
    }
  }

  multi method edit(Proc::Editor:U: Str $text?) {
    return Proc::Editor.new.edit($text, |%_);
  }
}

sub edit(|args) is export(:edit) {
  Proc::Editor.edit(|args);
}


root

README

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Editor

NAME

SYNOPSIS

DESCRIPTION

ROUTINES

`edit(...)`

METHODS

`new(:editors(...))`

`edit(Str $text?, IO::Path :$file, Bool :$keep)`

`edit-file(IO::Path $path)`

AUTHOR

COPYRIGHT AND LICENSE

Proc::Editor v0.0.2

Authors

License

Dependencies

Test Dependencies

Provides

Documentation