veda-new-package - Create a new skeleton package
veda new-package pkg-name [--language skill
|scheme
] [--prefix prefix]
Creates a new package pkg-name following the Veda guidelines.
The main skeleton file is populated with bogus information and a basic example to be updated/edited out; each of these locations is marked with a TODO
note.
A simple, basic test suite is also generated. It includes three tiny test cases, one of which is failing for demonstration purposes.
skill
|scheme
Specify main language for the package, either skill
for SKILL or scheme
for SKILL++. Other languages and file types can still be used, but this initial choice determines the file extension of the package's titular file (.il
or .ils
).
Specify prefix as the global namespace prefix for exported symbols. Cadence recommends the use of a capitalized prefix to avoid clashes with built-in identifiers, which have all-lowercase prefixes; e.g. AcmeRocket
for Acme Corporation's rocket package.
Defaults to My
followed by the capitalized "words" in package, e.g. MyFooBar
for package foo-bar
.
Basic package creation:
$ veda new-package rocket --language scheme --prefix AcmeRocket
Create rocket
Create rocket/rocket.ils
Create rocket/rocket-test.ils
Examining the TODO notes:
$ grep -nr TODO rocket/
rocket/rocket.ils:1:;;; rocket.ils --- TODO: Short package description
rocket/rocket.ils:3:;; Copyright (C) 2013 TODO: Copyright notice.
rocket/rocket.ils:5:;; @author TODO: Firstname Lastname <email@example.com>
rocket/rocket.ils:7:;; TODO: Standard copyright banner.
rocket/rocket.ils:11:;; TODO: Long package description/commentary.
rocket/rocket.ils:34: ;; TODO: Remove/replace by real code.
rocket/rocket.ils:44: ;; TODO: Remove/replace by real export.