On this page:
2.1 Module scaffold/  planks
readme-types
license-types
package-types
expand-package
expand-collection
expand-module
expand-test-module
expand-scribblings
expand-a-plank
list-planks
plank-argument-defaults
2.2 Internal Arguments

2 Reference

This section describes the modules that comprise the plank configurations (scaffold/planks). These plank configurations allow for programmatic construction of the planks by other tools.

2.1 Module scaffold/planks

 (require scaffold/planks) package: racket-scaffold

Each plank function takes an arguments parameter that not only provides the context for the templates but also any options for the plank structure as well.

(require scaffold/planks)
(expand-module (hash-set (plank-argument-defaults)
                         "content-name"
                         "my-module"))

Returns a list of strings that represent the allowed file formats for readme files generated in a package; for example markdown or text.

Returns a hash of name-to-file pairs that map user-friendly input names (e.g. MIT or Apache-2.0, etc.) to the specific file names for the license file generated in a package.

Returns a list of strings that represent the supported structure types for packages (see expand-package for details).

procedure

(expand-package arguments)  void?

  arguments : hash?
Used by raco scaffold package, see Create a Package.

procedure

(expand-collection arguments)  void?

  arguments : hash?
Used by raco scaffold collection, see Create a Collection.

procedure

(expand-module arguments)  void?

  arguments : hash?
Used by raco scaffold module, see Create a Module.

procedure

(expand-test-module arguments)  void?

  arguments : hash?
Used by raco scaffold testmodule, see Create a Test Module.

procedure

(expand-scribblings arguments)  void?

  arguments : hash?
Used by raco scaffold scribble, see Create a Scribble.

procedure

(expand-a-plank arguments)  void?

  arguments : hash?

procedure

(list-planks)  (listof string?)

This function returns a list of package, and user, provided planks in the form of *.plank files. This function searches both locations and returns a sorted list of all names.

Return a hash that

2.2 Internal Arguments

The following table lists the arguments passed into the plank functions in Module scaffold/planks. A hash with default values can be created using the plank-argument-defaults function.

key

 

values

 

default

 

flags

content-description

 

string?

 

 

-d

content-name

 

string?

 

 

module-language

 

?

 

racket/base

 

-L

package-dir

 

path-string?

 

 

?

package-include-private

 

boolean?

 

#t

 

–no-private

package-include-travis

 

boolean?

 

#t

 

–no-travis

package-license

 

Apache-2.0, BSD, GPL-3, LGPL-2.1, MIT

 

MIT

 

-l

package-name

 

string?

 

 

package-readme

 

markdown, text

 

markdown

 

-r

package-structure

 

single, multi, triple

 

multi

 

–single-collection, –triple-collection

package-version

 

string?

 

0.1

 

-V

scribble-structure

 

(), multi-page

 

multi-page

 

–single-scribble

user-args

 

key=value

 

 

-k

user-email

 

string?

 

 

-e, -E

user-id

 

string?

 

 

user-name

 

string?

 

 

-u, -U

year

 

string?