This is the rock Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:36:49 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
rockAsset manager for Common Lisp.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:eudoxia0/rock.git)
MIT
# Rock: Assets for Common Lisp web apps
[](https://travis-ci.org/eudoxia0/rock)
Rock is an asset manager for Common Lisp. It’s basically a combination of
[Bower][bower] and [webassets][webassets].
Rock takes care of downloading specific versions of libraries – jQuery,
Bootstrap, FontAwesome – and bundling their files together so you can compile
all your JavaScript and CSS into single files.
[bower]: http://bower.io/
[webassets]: http://webassets.readthedocs.org/en/latest/index.html
# Features
* **Library Manager**: Download specific versions of the most common
libraries. You can have multiple versions of the same library, for example,
for migrating an application one subset at a time.
* **Asset Bundling**: Compile the JS/CSS files of different libraries and your
own files into a single file. You can produce many bundles per application,
for example, a bundle with an old version of different libraries, and a bundle
with newer versions, for migrating a large application one subset at a time.
# License
Copyright (c) 2014-2015 Fernando Borretti (eudoxiahp@gmail.com)
Licensed under the MIT License.
0.1
trivial-download (system).
trivial-extract (system).
trivial-types (system).
asdf (system).
anaphora (system).
src (module).
Modules are listed depth-first from the system components tree.
rock/srcrock (system).
package.lisp (file).
files.lisp (file).
assets.lisp (file).
known-assets.lisp (file).
environments.lisp (file).
interface.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
rock/rock.asdrock/src/package.lisprock/src/files.lisprock/src/assets.lisprock/src/known-assets.lisprock/src/environments.lisprock/src/interface.lisprock/src/files.lispsrc (module).
concatenate-files (function).
download (function).
rock/src/assets.lispsrc (module).
*assets* (special variable).
<asset-version> (class).
<asset> (class).
<bootstrap-cdn-asset> (class).
<cdnjs-asset> (class).
<common-asset> (class).
<github-asset> (class).
<google-asset> (class).
<web-asset> (class).
asset (reader method).
base-url (reader method).
css (reader method).
defasset (macro).
file-url (method).
files (reader method).
files (reader method).
find-asset (function).
format-string (generic function).
js (reader method).
name (reader method).
username (reader method).
version (reader method).
version-commit (method).
version-string (function).
versions (reader method).
rock/src/environments.lispsrc (module).
*environments* (special variable).
<bundle> (class).
<environment> (class).
asset-directory (method).
asset-directory-name (method).
asset-local-pathname (method).
assets (reader method).
assets-directory (reader method).
build-bundle (method).
build-env (method).
bundles (reader method).
dependencies (reader method).
destination (reader method).
download-asset (method).
download-file-list (method).
env-build-directory (method).
env-relative-pathname (method).
files (reader method).
full-assets-directory (method).
get-env (function).
kind (reader method).
system-name (reader method).
rock/src/interface.lispsrc (module).
make-asset (macro).
make-bundle (macro).
Packages are listed by definition order.
rockanaphora.
common-lisp.
trivial-types.
*assets* (special variable).
*environments* (special variable).
<asset-version> (class).
<asset> (class).
<bootstrap-cdn-asset> (class).
<bundle> (class).
<cdnjs-asset> (class).
<common-asset> (class).
<environment> (class).
<github-asset> (class).
<google-asset> (class).
<web-asset> (class).
asset (generic reader).
asset-directory (generic function).
asset-directory-name (generic function).
asset-local-pathname (generic function).
assets (generic reader).
assets-directory (generic reader).
base-url (generic reader).
build-bundle (generic function).
build-env (generic function).
bundles (generic reader).
concatenate-files (function).
css (generic reader).
defasset (macro).
dependencies (generic reader).
destination (generic reader).
download (function).
download-asset (generic function).
download-file-list (generic function).
env-build-directory (generic function).
env-relative-pathname (generic function).
file-url (generic function).
files (generic reader).
find-asset (function).
format-string (generic function).
full-assets-directory (generic function).
get-env (function).
js (generic reader).
kind (generic reader).
make-asset (macro).
make-bundle (macro).
name (generic reader).
system-name (generic reader).
username (generic reader).
version (generic reader).
version-commit (generic function).
version-string (function).
versions (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define an environment.
rock.
Concatenate the files in ‘files‘ (A list of pathnames) into ‘target‘. Ensure the parent directories of ‘target‘ exist.
rock.
rock.
<asset-version>)) ¶automatically generated reader method
rock.
<asset-version>) (env <environment>)) ¶The directory of an asset version within an environment.
rock.
<asset-version>)) ¶rock.
<asset-version>) (env <environment>) (file string)) ¶The local pathname of an asset version’s file in an environment.
rock.
<environment>)) ¶automatically generated reader method
rock.
<web-asset>)) ¶The base URL for the files in the file slot.
rock.
<bundle>) (env <environment>)) ¶rock.
<environment>)) ¶Build an environment: Download all dependencies and build all its bundles.
rock.
<environment>)) ¶automatically generated reader method
rock.
<common-asset>)) ¶A list of CSS files.
css.
rock.
<environment>)) ¶automatically generated reader method
rock.
<asset-version>) (env <environment>)) ¶Download all the files in an asset.
rock.
<asset-version>) (env <environment>) files) ¶rock.
<environment>)) ¶rock.
<environment>) (path pathname)) ¶A pathname relative to an environment’s assets directory.
rock.
<asset-version>) filepath) ¶The URL to a ‘filepath‘ in an asset version ‘asset-v‘.
rock.
<bundle>)) ¶automatically generated reader method
<web-asset>)) ¶A list of general assets.
<common-asset>)) ¶A list of general assets.
The format string for a asset’s URL with the library name, but without the version and filepath.
rock.
<github-asset>)) ¶<cdnjs-asset>)) ¶<bootstrap-cdn-asset>)) ¶<google-asset>)) ¶rock.
<environment>)) ¶The absolute path to an environment’s assets directory.
rock.
<common-asset>)) ¶A list of JavaScript files.
js.
rock.
<common-asset>)) ¶The name of the asset as a string.
name.
rock.
<environment>)) ¶automatically generated reader method
rock.
<github-asset>)) ¶automatically generated reader method
rock.
<asset-version>)) ¶automatically generated reader method
rock.
<github-asset>) version) ¶rock.
<common-asset>)) ¶A list of versions (Each a keyword like ‘:1.2.3‘).
A particular version of an asset.
rock.
A bundle is a collection of assets and static files. Those
files, and the files corresponding to the bundle’s kind in each asset, will be
concatenated together into the destination pathname.
rock.
A ‘:js‘ bundle or a ‘:css‘ bundle.
keyword
:kind
kind.
This slot is read-only.
The assets from the environment that will be bundled.
(trivial-types:proper-list rock::<asset-version>)
:assets
This slot is read-only.
(trivial-types:proper-list pathname)
:files
This slot is read-only.
The pathname of the compiled bundle.
pathname
:destination
This slot is read-only.
The most common kind of asset: A collection of files with multiple versions.
rock.
The name of the asset as a string.
string
:name
name.
This slot is read-only.
A list of JavaScript files.
(trivial-types:proper-list string)
:js
js.
This slot is read-only.
A list of CSS files.
(trivial-types:proper-list string)
:css
css.
This slot is read-only.
A list of general assets.
(trivial-types:proper-list string)
:files
This slot is read-only.
rock.
keyword
:system-name
This slot is read-only.
pathname
#p"assets/"
:assets-directory
This slot is read-only.
(trivial-types:proper-list rock::<asset-version>)
:dependencies
This slot is read-only.
A collection of files to download from some base URL. Useful for downloading images, etc.
| Jump to: | A B C D E F G J K M N S U V |
|---|
| Jump to: | A B C D E F G J K M N S U V |
|---|
| Jump to: | *
A B C D F J K N S U V |
|---|
| Jump to: | *
A B C D F J K N S U V |
|---|
| Jump to: | <
A C E F I K M P R S |
|---|
| Jump to: | <
A C E F I K M P R S |
|---|