Image

head

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


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<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

B<RakupodObject> - Provides a routine to extract the '$=pod' object from an external Rakupod source


=begin code :lang<raku>

use RakupodObject;

=end code


B<RakupodObject> is a module that enables easy access to the Rakupod
object represented by the Raku variable C<$=pod>. That variable holds
the compiled Rakupod tree in a Raku source file. It is used by external
programs whose purpose is to process the Rakupod into other objects,
primarily other forms of documentation.


The module exports two multi subroutines.


item

Credits

The author is indebted to the Raku expert B<Vadim Belman> (AKA
C<@vrurg>) who provided the routine during the construction of some Rakupod
tests several years ago. The routine, in its original form, can be
seen in file
L<https://github.com/raku/roast/blob/master/S26-documentation/12-non-breaking-space.t>.


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


sub EXPORT(Version:D $v, Str $user-message?, Str() $opts = '') {
    my constant @valid-opts = <rakudo-only  no-where>;
    my constant $message = 'This program requires Rakudo compiler';
    my $where-to = (try $*W.current_file) // '<unknown file>';

    (my %opts = $opts.lc.words »=>» 1).keys.grep(none @valid-opts) and die
        "Only @valid-opts.map({"'$_'"}).join(', ') are valid as options to"
          ~ " RakudoPrereq but got %opts.keys.sort.map({"'$_'"}).join(', ')"
          ~ " at $where-to";

    my $out = ($*RAKU.compiler.name ne 'rakudo' and %opts<rakudo-only>)
        ?? ($user-message || $message)
        !! ($*RAKU.compiler.version before $v)
            ?? ($user-message || "$message version $v.raku() or newer; this is"
              ~ " $*RAKU.compiler.version.raku()")
            !! return Map.new;  # okidoki

    $out ~= "\nat $where-to" unless %opts<no-where>;
    note $out;
    exit 1;
}



RakudoPrereq - Specify minimum required versions of Rakudo


=begin code :lang<raku>

use RakudoPrereq v2021.04; # specify minimum Rakudo version 2021.04

# specify minimum Rakudo version 2021.04, with custom message
# when user's Rakudo is too old
use RakudoPrereq v2021.04, 'Your Raku is way too old, bruh!';

# specify minimum Rakudo version 2021.04, use default message and die
# when non-Rakudo compiler is used
use RakudoPrereq v2021.04, '', 'rakudo-only';

# specify minimum Rakudo version 2021.04, use custom message and die
# when non-Rakudo compiler is used
use RakudoPrereq v2021.04, 'your compiler is no good', 'rakudo-only';

# specify minimum Rakudo version 2021.04, use default message and die
# when non-Rakudo compiler is used and don't print location of `use`
use RakudoPrereq v2021.04, '', 'rakudo-only no-where';

=end code


Need to black-list non-Rakudo compilers or some Rakudo versions that implement
the same language version? This module is for you!


If the program is run on a Rakudo that's too old, the module will print a
message and exit with status `1`


The entire API is via the arguments specified on the `use RakudoPrereq` line.


The first argument is required and is the L<C<Version>|https://docs.raku.org/type/Version>
object specifying the minimum required Rakudo version.


By default, the module will print a generic message before exiting,
you can specify a custom message here. Default message will be printed
if the specified custom message is an empty string.


By default, the module would not fail if the compiler is not Rakudo.
Specify this option if you want to fail for non-Rakudo compilers as
well, regardless of their version.


Both the default and custom message will have the location of where
the C<use RakudoPrereq> that caused failure is at. Specify this argument
if you want to surpress that information.


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


RakudoPrereq

The Raku Knowledge Base


=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<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=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>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=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/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


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


README

NAME

SYNOPSIS

DESCRIPTION

USAGE

Minimum Rakudo version

Custom message

String with options

rakudo-only

no-where

AUTHOR

COPYRIGHT AND LICENSE

RakudoPrereq v1.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation