logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Mojolicious::Plugin::AssetPack - Compress and convert CSS, Less, Sass, JavaScript and CoffeeScript files

Attributes

minify
         $bool = $self->minify;
         $self = $self->minify($bool);

       Set  this  to  true  to  combine  and  minify  the  assets. Defaults to false if "mode" in Mojolicious is
       "development" and true otherwise.

   route
         $route = $self->route;
         $self = $self->route($route);

       A Mojolicious::Routes::Route object used to serve assets. The default route  responds  to  HEAD  and  GET
       requests and calls serve_asset() on "store" to serve the asset.

       The default route will be built and added to the application when "process" is called the first time.

   store
         $obj = $self->store;
         $self = $self->store(Mojolicious::Plugin::AssetPack::Store->new);

       Holds a Mojolicious::Plugin::AssetPack::Store object used to locate, store and serve assets.

   tag_for
       Deprecated. Use "renderer" in Mojolicious::Plugin::AssetPack::Asset instead.

   ua
         $ua = $self->ua;

       Holds  a  Mojo::UserAgent  which can be used to fetch assets either from local application or from remote
       web servers.

Author

       Jan Henning Thorsen - "jhthorsen@cpan.org"

       Alexander Rymasheusky

       Mark Grimes - "mgrimes@cpan.org"

       Per Edin - "info@peredin.com"

       Viktor Turskyi

perl v5.40.0                                       2024-12-07                Mojolicious::Plugin::AssetPack(3pm)

Description

       Mojolicious::Plugin::AssetPack is a Mojolicious plugin for processing static assets. The idea is that
       JavaScript and CSS files should be served as one minified file to save bandwidth and roundtrip time to
       the server.

       There are many external tools for doing this, but integrating them with Mojolicious can be a struggle:
       You want to serve the source files directly while developing, but a minified version in production. This
       assetpack plugin will handle all of that automatically for you.

       Your application creates and refers to an asset by its topic (virtual asset name).  The process of
       building actual assets from their components is delegated to "pipe objects".

Guides

       Mojolicious::Plugin::AssetPack::Guides::Tutorial
         The tutorial will give an introduction to how AssetPack can be used.

       Mojolicious::Plugin::AssetPack::Guides::Developing
         The  "developing"  guide  will  give insight on how to do effective development with AssetPack and more
         details about the internals in this plugin.

       Mojolicious::Plugin::AssetPack::Guides::Cookbook
         The cookbook has various receipes on how to cook with AssetPack.

Helpers

asset
         $self = $app->asset;
         $self = $c->asset;
         $bytestream = $c->asset($topic, @args);
         $bytestream = $c->asset("app.css", media => "print");

       asset()  is  the  main  entry  point  to  this  plugin.  It  can   either   be   used   to   access   the
       Mojolicious::Plugin::AssetPack instance or as a tag helper.

       The helper name "asset" can be customized by specifying "helper" when registering the plugin.

Methods

pipe
         $obj = $self->pipe($name);
         $obj = $self->pipe("Css");

       Will return a registered pipe by $name or "undef" if none could be found.

   process
         $self = $self->process($topic => @assets);
         $self = $self->process($definition_file);

       Used to process assets. A $definition_file can be used to define $topic and @assets in a separate file.

       $definition_file defaults to "assetpack.def".

   processed
         $collection = $self->processed($topic);

       Can    be    used    to    retrieve    a    Mojo::Collection    object,     with     zero     or     more
       Mojolicious::Plugin::AssetPack::Asset objects.

   register
         $self->register($app, \%config);

       Used to register the plugin in the application. %config can contain:

       • helper

         Name of the helper to add to the application. Default is "asset".

       • pipes

         This argument is mandatory and need to contain a complete list of pipes that is needed. Example:

           $app->plugin(AssetPack => {pipes => [qw(Sass Css Combine)]);

       • proxy

         A  hash  of  proxy  settings.  Set  this to 0 to disable proxy detection.  Currently only "no_proxy" is
         supported, which will set which requests that should bypass the  proxy  (if  any  proxy  is  detected).
         Default is to bypass all requests to localhost.

         See "detect" in Mojo::UserAgent::Proxy for more information.

Name

       Mojolicious::Plugin::AssetPack - Compress and convert CSS, Less, Sass, JavaScript and CoffeeScript files

See Also

       Mojolicious::Plugin::Webpack.

Synopsis

Application
         use Mojolicious::Lite;

         # Load plugin and pipes in the right order
         plugin AssetPack => {pipes => [qw(Less Sass Css CoffeeScript Riotjs JavaScript Combine)]};

         # define asset
         app->asset->process(
           # virtual name of the asset
           "app.css" => (

             # source files used to create the asset
             "sass/bar.scss",
             "https://github.com/Dogfalo/materialize/blob/master/sass/materialize.scss",
           )
         );

   Template
         <html>
           <head>
             %= asset "app.css"
           </head>
           <body><%= content %></body>
         </html>

See Also