The trivial-project Reference Manual

This is the trivial-project Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:34:04 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 trivial-project

A simple project skeleton generator with key-value substitution

Author

StackSmith <>

License

BSD Simplified (2-clause)

Version

1.0.0

Dependencies
  • cl-ppcre (system).
  • alexandria (system).
Source

trivial-project.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 trivial-project/trivial-project.asd

Source

trivial-project.asd.

Parent Component

trivial-project (system).

ASDF Systems

trivial-project.


3.1.2 trivial-project/package.lisp

Source

trivial-project.asd.

Parent Component

trivial-project (system).

Packages

trivial-project.


3.1.3 trivial-project/params.lisp

Dependency

package.lisp (file).

Source

trivial-project.asd.

Parent Component

trivial-project (system).

Internals

3.1.4 trivial-project/trivial-project.lisp

Dependency

params.lisp (file).

Source

trivial-project.asd.

Parent Component

trivial-project (system).

Public Interface

make-project (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-project

Source

package.lisp.

Nickname

tp

Use List
  • alexandria.
  • common-lisp.
Public Interface

make-project (function).

Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-project (&rest params &key name &allow-other-keys)

Create a project named (name must be a string) based on a template and other keys.

Package

trivial-project.

Source

trivial-project.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *extensions*
Package

trivial-project.

Source

params.lisp.

Special Variable: *files*
Package

trivial-project.

Source

params.lisp.

Special Variable: *output-path*
Package

trivial-project.

Source

params.lisp.

Special Variable: *params*
Package

trivial-project.

Source

trivial-project.lisp.


5.2.2 Ordinary functions

Function: all-files-below (directory root)

collect all filenames at or below root, relative to root, as strings

Package

trivial-project.

Source

trivial-project.lisp.

Function: extensions-initialize ()
Package

trivial-project.

Source

params.lisp.

Function: filename-action (enoughpath)
Package

trivial-project.

Source

params.lisp.

Function: files-initialize ()
Package

trivial-project.

Source

params.lisp.

Function: initial-keys (params)
Package

trivial-project.

Source

params.lisp.

Function: local-template ()
Package

trivial-project.

Source

params.lisp.

Function: process-file (srcpath destpath)
Package

trivial-project.

Source

trivial-project.lisp.

Function: process-files ()
Package

trivial-project.

Source

trivial-project.lisp.

Function: process-string (string &optional regex)
Package

trivial-project.

Source

trivial-project.lisp.

Function: set-params-from-file (path &key in)
Package

trivial-project.

Source

params.lisp.

Function: set-params-from-list (list)

set (overwriting) *params* from plist-like list

Package

trivial-project.

Source

params.lisp.


Appendix A Indexes


A.1 Concepts