The skeleton-creator Reference Manual

This is the skeleton-creator Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:53:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 skeleton-creator

Create projects from a skeleton directory.

Maintainer

noloop <>

Author

noloop <>

Home Page

https://github.com/noloop/skeleton-creator

Source Control

(GIT git@github.com:noloop/skeleton-creator.git)

Bug Tracker

https://github.com/noloop/skeleton-creator/issues

License

GPLv3

Version

1.0.0

Dependencies
  • conf (system).
  • cl-fad (system).
  • cl-ppcre (system).
Source

skeleton-creator.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 skeleton-creator/src

Source

skeleton-creator.asd.

Parent Component

skeleton-creator (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 skeleton-creator/skeleton-creator.asd

Source

skeleton-creator.asd.

Parent Component

skeleton-creator (system).

ASDF Systems

skeleton-creator.


4.1.2 skeleton-creator/src/package.lisp

Source

skeleton-creator.asd.

Parent Component

src (module).

Packages

noloop.skeleton-creator.


4.1.3 skeleton-creator/src/utils.lisp

Dependency

package.lisp (file).

Source

skeleton-creator.asd.

Parent Component

src (module).

Internals

4.1.4 skeleton-creator/src/copy-directory.lisp

Dependency

package.lisp (file).

Source

skeleton-creator.asd.

Parent Component

src (module).

Internals

4.1.5 skeleton-creator/src/skeleton-creator.lisp

Dependencies
Source

skeleton-creator.asd.

Parent Component

src (module).

Internals

4.1.6 skeleton-creator/src/license-under.lisp

Dependency

skeleton-creator.lisp (file).

Source

skeleton-creator.asd.

Parent Component

src (module).

Internals

4.1.7 skeleton-creator/src/ui-skeleton-creator.lisp

Dependencies
Source

skeleton-creator.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 noloop.skeleton-creator

Source

package.lisp.

Nickname

skeleton-creator

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: configure-skeleton-creator ()
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: create-new-project (&key force)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: delete-project-directory (project-directory)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: get-configure-directory ()
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: license-project ()
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: set-configure-directory (new-directory)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.


6.2 Internals


6.2.1 Macros

Macro: conc (&rest string-args)

Synthetic sugar for concatenate strings.

Package

noloop.skeleton-creator.

Source

utils.lisp.


6.2.2 Ordinary functions

Function: conf-skeleton-creator (skeleton-creator)

To edit the configurations of the skeleton-creator.conf configuration file.

Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: confirm-changes-p (list-fields list-values)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: copy-default-conf ()
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: copy-directory (origin destination &key overwrite)
Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: copy-skeleton-directory (skeleton-creator destination-directory)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: create-license-file (project-directory licenses-directory license-name)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: create-new-project-interactive (force)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: create-new-project-not-interactive (destination-directory name description &key quiet force)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: create-project (skeleton-creator destination-directory name description)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: delete-project (project-directory)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: dolist-ignores (path destination ignores)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: empty-directory-p (path)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: file-string-replace-markings (path hash-markings)

Return new string from string file after replace markings.

Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: get-conf-dir (skeleton-creator)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: get-date-year-string ()

Returns current year as a string.

Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: get-field (skeleton-creator field)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: get-hash-markings (skeleton-creator)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: get-license-names ()
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: get-notice-path (notices-directory license-name)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: get-string-from-file (file-name)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: get-string-license (licenses-directory license-name)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: init-skeleton-creator (conf-directory)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: license-project-interactive (notices-dir-exists-p)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: license-project-not-interactive (project-directory license-name &key ignores create-license-file-p write-license-notices-p write-in-readme-p quiet)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: license-under (project-directory licenses-directory license-name hash-markings ignores create-license-file-p write-license-notices-p write-in-readme-p)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: list-subtract (list-1 list-2)

Compare elements of list-1 with elements of list-2, return new list with elements of list-2 not contained in list-1. Return immediately for elements differents, the comparison follow order of elements.

Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: merge-directory-with-subtract-path (path origin destination)
Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: merge-file-with-subtract-path (path origin destination)
Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: merge-path-with-new-file-name (path new-file-name)

Merge new-file-name with directory of path, return new path.

Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: not-match-list-ignore (destination-directory ignores)

Returns a lambda that checks whether an element(el) merged to a destination-directory is equal to some element of the ignore list.

Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: pathname-is-file (path)
Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: pathname-subtract (path-1 path-2)

Compare path-1 with path-2, and return new pathname with rest of path-2 at the point where it differentiated.

Package

noloop.skeleton-creator.

Source

copy-directory.lisp.

Function: read-field (field-name)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: replace-markings (skeleton-creator destination-directory)

1 - Replace the file names with the markings values.
2 - Replace the strings within the contents of the files with markings values.
Markings are SK-PROJECT-NAME and SK-PROJECT-DESCRIPTION and all elements of the skeleton.conf configuration file.

Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: replace-markings-in-file (destination-directory hash-markings &optional ignores)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: replace-markings-in-file-names (destination-directory hash-markings &optional ignores)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: require-conf-directory-interactive (fn &key check-license-dir-p)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: set-conf-dir (skeleton-creator new-directory)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: set-field (skeleton-creator field new-value)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: string-empty-p (stg)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: string-match-markings (stg hash-markings)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: string-replace-all (stg old new)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: to-ask (question)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: use-default-conf-p (warning-msg)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: walk-destination-directory (destination-directory fn &optional ignores)
Package

noloop.skeleton-creator.

Source

skeleton-creator.lisp.

Function: write-in-readme (project-directory notices-directory license-name hash-markings)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: write-license-notices (project-directory notices-directory license-name hash-markings ignores)
Package

noloop.skeleton-creator.

Source

license-under.lisp.

Function: write-string-in-file (file-name stg)
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: y-or-n-default-conf (warning-msg fn)
Package

noloop.skeleton-creator.

Source

ui-skeleton-creator.lisp.

Function: yes-or-no? ()
Package

noloop.skeleton-creator.

Source

utils.lisp.

Function: yes-or-no?-fn (fn)
Package

noloop.skeleton-creator.

Source

utils.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   E   F   G   I   L   M   N   P   R   S   T   U   W   Y  
Index Entry  Section

C
conc: Private macros
conf-skeleton-creator: Private ordinary functions
configure-skeleton-creator: Public ordinary functions
confirm-changes-p: Private ordinary functions
copy-default-conf: Private ordinary functions
copy-directory: Private ordinary functions
copy-skeleton-directory: Private ordinary functions
create-license-file: Private ordinary functions
create-new-project: Public ordinary functions
create-new-project-interactive: Private ordinary functions
create-new-project-not-interactive: Private ordinary functions
create-project: Private ordinary functions

D
delete-project: Private ordinary functions
delete-project-directory: Public ordinary functions
dolist-ignores: Private ordinary functions

E
empty-directory-p: Private ordinary functions

F
file-string-replace-markings: Private ordinary functions
Function, conf-skeleton-creator: Private ordinary functions
Function, configure-skeleton-creator: Public ordinary functions
Function, confirm-changes-p: Private ordinary functions
Function, copy-default-conf: Private ordinary functions
Function, copy-directory: Private ordinary functions
Function, copy-skeleton-directory: Private ordinary functions
Function, create-license-file: Private ordinary functions
Function, create-new-project: Public ordinary functions
Function, create-new-project-interactive: Private ordinary functions
Function, create-new-project-not-interactive: Private ordinary functions
Function, create-project: Private ordinary functions
Function, delete-project: Private ordinary functions
Function, delete-project-directory: Public ordinary functions
Function, dolist-ignores: Private ordinary functions
Function, empty-directory-p: Private ordinary functions
Function, file-string-replace-markings: Private ordinary functions
Function, get-conf-dir: Private ordinary functions
Function, get-configure-directory: Public ordinary functions
Function, get-date-year-string: Private ordinary functions
Function, get-field: Private ordinary functions
Function, get-hash-markings: Private ordinary functions
Function, get-license-names: Private ordinary functions
Function, get-notice-path: Private ordinary functions
Function, get-string-from-file: Private ordinary functions
Function, get-string-license: Private ordinary functions
Function, init-skeleton-creator: Private ordinary functions
Function, license-project: Public ordinary functions
Function, license-project-interactive: Private ordinary functions
Function, license-project-not-interactive: Private ordinary functions
Function, license-under: Private ordinary functions
Function, list-subtract: Private ordinary functions
Function, merge-directory-with-subtract-path: Private ordinary functions
Function, merge-file-with-subtract-path: Private ordinary functions
Function, merge-path-with-new-file-name: Private ordinary functions
Function, not-match-list-ignore: Private ordinary functions
Function, pathname-is-file: Private ordinary functions
Function, pathname-subtract: Private ordinary functions
Function, read-field: Private ordinary functions
Function, replace-markings: Private ordinary functions
Function, replace-markings-in-file: Private ordinary functions
Function, replace-markings-in-file-names: Private ordinary functions
Function, require-conf-directory-interactive: Private ordinary functions
Function, set-conf-dir: Private ordinary functions
Function, set-configure-directory: Public ordinary functions
Function, set-field: Private ordinary functions
Function, string-empty-p: Private ordinary functions
Function, string-match-markings: Private ordinary functions
Function, string-replace-all: Private ordinary functions
Function, to-ask: Private ordinary functions
Function, use-default-conf-p: Private ordinary functions
Function, walk-destination-directory: Private ordinary functions
Function, write-in-readme: Private ordinary functions
Function, write-license-notices: Private ordinary functions
Function, write-string-in-file: Private ordinary functions
Function, y-or-n-default-conf: Private ordinary functions
Function, yes-or-no?: Private ordinary functions
Function, yes-or-no?-fn: Private ordinary functions

G
get-conf-dir: Private ordinary functions
get-configure-directory: Public ordinary functions
get-date-year-string: Private ordinary functions
get-field: Private ordinary functions
get-hash-markings: Private ordinary functions
get-license-names: Private ordinary functions
get-notice-path: Private ordinary functions
get-string-from-file: Private ordinary functions
get-string-license: Private ordinary functions

I
init-skeleton-creator: Private ordinary functions

L
license-project: Public ordinary functions
license-project-interactive: Private ordinary functions
license-project-not-interactive: Private ordinary functions
license-under: Private ordinary functions
list-subtract: Private ordinary functions

M
Macro, conc: Private macros
merge-directory-with-subtract-path: Private ordinary functions
merge-file-with-subtract-path: Private ordinary functions
merge-path-with-new-file-name: Private ordinary functions

N
not-match-list-ignore: Private ordinary functions

P
pathname-is-file: Private ordinary functions
pathname-subtract: Private ordinary functions

R
read-field: Private ordinary functions
replace-markings: Private ordinary functions
replace-markings-in-file: Private ordinary functions
replace-markings-in-file-names: Private ordinary functions
require-conf-directory-interactive: Private ordinary functions

S
set-conf-dir: Private ordinary functions
set-configure-directory: Public ordinary functions
set-field: Private ordinary functions
string-empty-p: Private ordinary functions
string-match-markings: Private ordinary functions
string-replace-all: Private ordinary functions

T
to-ask: Private ordinary functions

U
use-default-conf-p: Private ordinary functions

W
walk-destination-directory: Private ordinary functions
write-in-readme: Private ordinary functions
write-license-notices: Private ordinary functions
write-string-in-file: Private ordinary functions

Y
y-or-n-default-conf: Private ordinary functions
yes-or-no?: Private ordinary functions
yes-or-no?-fn: Private ordinary functions


A.3 Variables


A.4 Data types