Specs

Your project's input.

Specs define how your application should work.

They are written in YAML. Their structure and validate are determined by Schemas.

Export a Spec

To create a Spec, go to Exports and click Create Export:

Enter a Name and Description and select "Spec" as the Type.

Examples

Here is an example spec for the php.config module which generates a php.ini file:

INPUT: config.yml

imports:
  crystal/php: ~0.2.1
outputs:
  - generator: php.ConfigGenerator
    spec:
      include_path: .:/usr/local/lib/php
      register_globals: false
      track_errors: yes

OUTPUT: php.ini

include_path = .:/usr/local/lib/php
register_globals = false
track_errors = yes

Here is an example spec for the npm.package module which generates a package.json file:

INPUT: config.yml

imports:
  crystal/npm: ~0.2.5
outputs:
  - generator: npm.PackageGenerator
    spec:
      name: my-module
      version: 0.1.0
      dependencies:
        bluebird: latest

OUTPUT: package.json

{
  "name": "my-module",
  "version": "0.1.0",
  "dependencies": {
    "bluebird": "latest"
  }
}

Here is an example spec for the bower.package module which generates a bower.json file:

INPUT: config.yml

imports:
  crystal/bower: ~0.3.5
outputs:
  - generator: bower.PackageGenerator
    spec:
      name: my-module
      version: 0.1.0
      dependencies:
        jquery: latest

OUTPUT: bower.json

{
  "name": "my-module",
  "version": "0.1.0",
  "dependencies": {
    "jquery": "latest"
  }
}