name: Autocode
version: 0.22.0
description: code automation for every language, framework and platform
repository: https://github.com/crystal/autocode
author:
  name: Chris Tate
  email: chris@crystal.sh
  url: https://crystal.sh
copyright: 2015 Crystal
imports:
  crystal/authors: ~0.3.3
  crystal/bower: ~0.4.1
  crystal/git: ~0.2.0
  crystal/grunt: ~0.3.1
  crystal/npm: ~0.4.0
  crystal/readme: ~0.5.1
  crystal/travis: ~0.3.0
exports:
  ConfigSchema:
    schema:
      type: object
      properties:
        author:
          type: object
          properties:
            name:
              title: Name
              type: string
            email:
              title: Email
              type: string
            url:
              title: URL
              type: string
        copyright:
          title: Copyright
          type: string
        description:
          description: This project's description.
          title: Description
          type: string
        exports:
          type: object
          additionalProperties:
            type: object
            properties:
              description:
                type: string
              engine:
                type: string
              example:
                type: string
              helper:
                type:
                  - string
                  - object
                additionalProperties:
                  type: string
              processor:
                type: string
              generator:
                type: string
              schema:
                type:
                  - object
                  - string
              spec:
                type:
                  - array
                  - object
                  - string
              type:
                required: true
                type: string
        imports:
          type: object
          additionalProperties:
            type:
              - string
              - object
            properties:
              aliases:
                type: object
                additionalProperties:
                  type: string
              version:
                type: string
        name:
          description: This project's name.
          title: Name
          type: string
        version:
          description: This project's version.
          title: Version
          type:
            - number
            - string
    type: schema
outputs:
  - generator: bower.ConfigGenerator
    spec:
      directory: app/lib/components
  
  - generator: bower.PackageGenerator
    spec:
      name: autocode
      description: $description
      main: lib/autocode.js
      dependencies:
        CodeMirror: 5.7.0
        formulator: 0.6.2
        google-diff-match-patch-js: 1.0.0
        jquery: 2.1.4
        jquery-cookie: 1.4.1
        js-yaml: 3.4.2
        marked: 0.3.5
  
  - generator: git.GitignoreGenerator
    spec:
      items:
        - .DS_Store
        - app/lib/components/
        - app/lib/scripts
        - node_modules/
  
  - generator: grunt.GruntfileGenerator
    spec:
      loadNpmTasks:
        - grunt-contrib-concat
        - grunt-contrib-watch
      registerTask:
        default:
          - concat
      config:
        pkg: package.json
        concat:
          options:
            separator: ;
          dist:
            src:
              - app/src/scripts/autocode.js
              - app/src/scripts/autocode/*.js
              - app/src/scripts/*/**
            dest: app/lib/scripts/autocode.js
        watch:
          files:
            - app/src/scripts/autocode.js
            - app/src/scripts/*/**
          tasks:
            - concat
  
  - generator: npm.NPMIgnoreGenerator
    spec:
      items:
        - cli/src
        - src
  
  - generator: npm.PackageGenerator
    spec: npm.yml
    
  - generator: readme.ReadmeGenerator
    spec:
      logo:
        image: https://rawgit.com/crystal/autocode/master/.autocode/image.svg
        text: $name
        url: http://crystal.sh
      showTableOfContents: true
      sections:
        - name: install
          title: Install
          content: |
            Choose an Interface:
            
            - [Command-Line](#install-cli)
            - [JavaScript (Node.js)](#install-js)
            
            <a name="install-cli"></a>
            
            ## Command-Line
            
            Use [npm](https://npmjs.com) or [Homebrew](https://brew.sh) to install the Command-Line interface of Autocode:
            
            ```sh
            npm install autocode-cli -g # most popular
            brew install autocode # mac only
            ```
            
            <a name="install-js"></a>
            
            ## JavaScript (Node.js)
            
            Use [npm](https://npmjs.com) to install the JavaScript interface of Autocode:
            
            ```sh
            npm install autocode-js
            ```
        - name: hello-world
          title: Hello World
          content: |
            Choose the `Hello World` tutorial for your Autocode installation:
            
            - [Input](#example-input)
              - [Command-Line](#hello-world-cli)
              - [JavaScript (Node.js)](#hello-world-js)
            - [Output](#output)
              - [README.md](#readme)
              - [LICENSE](#license)
            
            ## Input
            
            <a name="#hello-world-cli"></a>
            
            ### Command-Line
            
            If you've installed the Command-Line interface of Autocode, create a file called `.autocode/config.yml` and add these contents:
            
            ```yaml
            name: My App
            description: This is my app.
            path: ./output/myapp
            imports:
              crystal/license: ~0.3.1
              crystal/readme: ~0.5.1
            outputs:
              - generator: license.MITGenerator
                spec:
                  copyright: 2015 Crystal
              - generator: readme.ReadmeGenerator
                spec:
                  name: $name
                  description: $description
            ```
            
            Then use Autocode to build your project:
            
            ```sh
            autocode build
            ```
            
            View the output [here](#output).
            
            <a name="#hello-world-js"></a>
            
            ### JavaScript (Node.js)
            
            If you've installed the JavaScript interface of Autocode, create a file called `helloworld.js` and add these contents:
            
            ```js
            var Autocode = require('autocode-js');
            var project = new Autocode({
              name: 'My App',
              description: 'This is my app.',
              path: './output/myapp',
              imports: {
                'crystal/license': '~0.3.1',
                'crystal/readme': '~0.5.1'
              },
              outputs: [{
                // generate a LICENSE file
                generator: 'license.MITGenerator',
                spec: {
                  copyright: '2015 Crystal'
                }
              },{
                // generate a README.md file
                generator: 'readme.ReadmeGenerator',
                spec: {
                  name: '$name',
                  description: '$description'
                }
              }]
            });
            ```
            
            Now run your `helloworld.js` script:
            
            ```sh
            node helloworld.js
            ```
            
            View the output [here](#output).
            
            <a name="output"></a>
            
            ## Output
            
            Whether you've chosen the Command-Line interface or JavaScript interface, the output will be the same:
            
            - [README.md](#readme)
            - [LICENSE](#license)
            
            <a name="#readme"></a>
            
            ### README.md
            
            ```md
            # My API
            
            this is my API
            ```
            
            <a name="#license"></a>
            
            ### LICENSE
            
            ```md
            The MIT License (MIT)

            Copyright (c) 2015 Crystal

            Permission is hereby granted, free of charge, to any person obtaining a copy
            of this software and associated documentation files (the "Software"), to deal
            in the Software without restriction, including without limitation the rights
            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
            copies of the Software, and to permit persons to whom the Software is
            furnished to do so, subject to the following conditions:

            The above copyright notice and this permission notice shall be included in all
            copies or substantial portions of the Software.

            THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
            IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
            FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
            AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
            LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
            OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
            SOFTWARE.
            ```
        - name: usage
          title: Usage
          content: |
            - [Command-Line](#usage-cli)
            - [JavaScript (Node.js)](#usage-js)
            
            ## Command-Line
            
            ```
            crystal [command]

            Commands:

              build             build project
              config            get project's Crystal Config
              help              get help
              init              initialize project
              install <module>  install module
              run               run project
              search <module>   search for modules
              update            update project's modules
            ```
            
            ## JavaScript (Node.js)
          
            - [Load Autocode](#load-autocode)
            - [Create Project](#create-project)
            - [Save Project](#save-project)
            - [Load Project](#load-project)
            - [Update Project](#update-project)
            - [Build Project](#build-project)
            - [Run Project](#run-project)
            - [Modularize Project](#run-project)
            
            <a name="load-autocode"></a>
            
            ## Load Autocode
            
            ```js
            var Autocode = require('autocode');
            ```
            
            <a name="create-project"></a>

            ## Create Project
            
            ```js
            var project = new Autocode({
              name: 'My App',
              description: 'This is my app.',
              path: './output/myapp',
              imports: {
                'crystal/license': '~0.2.4',
                'crystal/readme': '~0.2.2'
              },
              outputs: [{
                // generate a LICENSE file
                generator: 'license.MITGenerator',
                spec: {
                  copyright: '2015 Crystal'
                }
              },{
                // generate a README.md file
                generator: 'readme.ReadmeGenerator',
                spec: {
                  name: '$name',
                  description: '$description'
                }
              }]
            });
            ```
            
            <a name="save-project"></a>
            
            ## Save Project
            
            ```js
            project.save();
            ```
            
            <a name="load-project"></a>
            
            ## Load Project
            
            ```js
            var project = new Autocode('/path/to/project');
            ```
            
            <a name="update-project"></a>
            
            ## Update Project (and its Imports)
            
            ```js
            project.update();
            ```
            
            <a name="build-project"></a>
            
            ## Build Project
            
            ```js
            project.build({
              // overwrites any manual changes
              force: true
            });
            ```
            
            <a name="run-project"></a>
            
            ## Run Project
            
            ```js
            project.run();
            ```
            
            <a name="modularize-project"></a>
            
            ## Modularize Project
            
            Modularize your project for other projects to use:
            
            ```js
            var mod = new Autocode({
              name: 'My Module',
              description: 'This is my module.',
              path: './output/mymod',
              imports: {
                'crystal/handlebars': '~0.2.3'
              },
              exports: {
                ReadmeGenerator: {
                  engine: 'handlebars.HandlebarsEngine',
                  filename: 'README.md',
                  schema: {
                    type: 'object',
                    properties: {
                      name: {
                        required: true,
                        type: 'string'
                      },
                      description: {
                        required: true,
                        type: 'string'
                      }
                    }
                  },
                  template: "# {{{name}}}\n\n{{{description}}}",
                  type: 'generator'
                }
              }
            });
            ```
        - name: examples
          title: Examples
          content: |
            ### JavaScript
            
            - [Express](https://crystal.sh/editor/crystal/express)
            - [npm](https://crystal.sh/editor/crystal/npm)
            
            ### Python
            
            - [Django](https://crystal.sh/editor/crystal/django)
            - [pip](https://crystal.sh/editor/crystal/pip)
            
            ### Ruby
            
              - [Rails](https://crystal.sh/editor/crystal/rails)
              
            ### Other
            
              - [Docker](https://crystal.sh/editor/crystal/docker)
              - [README](https://crystal.sh/editor/crystal/readme)
        - name: api-ref
          title: API Reference
          content: |
            - [build()](#api-ref-build)
            - [cache()](#api-ref-cache)
            - [generate()](#api-ref-generate)
            - [init()](#api-ref-init)
            - [install()](#api-ref-install)
            - [load()](#api-ref-load)
            - [run()](#api-ref-run)
            - [search()](#api-ref-search)
            - [test()](#api-ref-test)
            - [update()](#api-ref-update)
            - [validate()](#api-ref-validate)
            
            <a name="api-ref-build"></a>
            
            ## build([opts])
            
            Builds your project.
            
            ## Options
            
            <table>
              <tr>
                <td>Name</d>
                <td>Type</td>
              </tr>
              <tr>
                <td>`force`</td>
                <td>boolean</td>
              </tr>
            </table>
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.build({ force: true });
            ```
            
            <a name="api-ref-generate"></a>
            
            ## generate([opts])
            
            Generates your project's files.
            
            ### Options
            
            <table>
              <tr>
                <td>Name</d>
                <td>Type</td>
              </tr>
              <tr>
                <td>`force`</td>
                <td>boolean</td>
              </tr>
            </table>
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.generate({ force: true });
            ```
            
            <a name="api-ref-init"></a>
            
            ## init([opts])
            
            Initializes your project.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.init({
              name: 'My App',
              description: 'This is my app.'
            });
            ```
            
            <a name="api-ref-install"></a>
            
            ## install([opts])
            
            Installs a module.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.install({
              'crystal/readme': '~0.2.2'
            });
            ```
            
            <a name="api-ref-load"></a>
            
            ## load([opts])
            
            Loads your project's configuration.
            
            ### Example
            
            ```js
            var project = new Autocode;
            project.load('/path/to/project');
            ```
            
            <a name="api-ref-run"></a>
            
            ## run([opts])
            
            Runs your project.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.run({ force: true });
            ```
            
            <a name="api-ref-search"></a>
            
            ## search([opts])
            
            Search for modules.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.search({ keywords: 'laravel' });
            ```
            
            <a name="api-ref-test"></a>
            
            ## test([opts])
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.test();
            ```
            
            <a name="api-ref-update"></a>
            
            Test your project.
            
            ## update([opts])
            
            Updates your project.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.update();
            ```
            
            <a name="api-ref-validate"></a>
            
            ## validate()
            
            Validates your project.
            
            ### Example
            
            ```js
            var project = new Autocode('/path/to/project');
            project.validate();
            ```
            
        - name: docs
          title: Official Documentation
          content: |
            View Crystal's Official Documentation here:

            [https://crystal.readme.io](https://crystal.readme.io)
        - name: live-editor
          title: Live Editor
          content: |
            Use Crystal Editor to try Crystal online:

            [https://crystal.sh/editor](https://crystal.sh/editor)
        - name: top-10-features
          title: Top 10 Features
          content: |
            (1) Crystal unifies all technologies with a standardized input written in YAML, JSON, CSON and/or XML.

            (2) Crystal generates code for:

              - Any application: APIs, Apps, Websites, Frontends, Backends + more
              - Any language: JavaScript, PHP, Ruby, Python, Swift, Java + more
              - Any framework: Express, Hapi, Laravel, Yii, Rails, Sinatra, Django + more
              - Any platform: Twitter, Facebook, Mailchimp, Pinterest, Google + more
              - Any runtime/server: Node.js, Apache, Nginx, HAPROXY + more
              - Any CMS: Wordpress, Drupal, Joomla, Plone, Keystone + more
              - Any datastore: MySQL, PostgreSQL, Redis, MongoDB, DynamoDB + more
              - Any file: README, LICENSE, AUTHORS, HOSTS + more
              - ...and any other software!!
              
            (3) Crystal is made up of 8 elements that make code generation more flexible and powerful than ever before:

              - [Specifications](https://crystal.readme.io/v0.8/docs/specifications)
              - [Schematics](https://crystal.readme.io/v0.8/docs/schematics)
              - [Generators](https://crystal.readme.io/v0.8/docs/generators)
              - [Engines](https://crystal.readme.io/v0.8/docs/engines)
              - [Helpers](https://crystal.readme.io/v0.8/docs/helpers)
              - [Processors](https://crystal.readme.io/v0.8/docs/processors)
              - [Transformers](https://crystal.readme.io/v0.8/docs/transformers)
              - [Injectors](https://crystal.readme.io/v0.8/docs/injectors)
              
            (4) Crystal is meant to be used on an ongoing basis - beyond project creation and scaffolding.

            (5) Crystal has its own registry (the [Crystal Hub](https://hub.crystal.sh)) and package manager built-in which makes it easy to search, install and update modules.

            (6) All of Crystal's elements can be modularized and published to the Crystal Hub for you or others to use.

            (7) You can use multiple modules together such as a:

              - README generator for documentation
              - MIT generator for licensing
              - Composer generator for frontend dependencies
              - Bower generator for backend dependencies
              - Laravel generator for business logic
              - Ember generator for UI

            (8) You can add/remove modules to/from a project at anytime.

            (9) To prevent vendor lock-in and becoming dependent of Crystal, it's kept in its own directory: `.autocode/`. If you wish to no longer use Crystal, simply delete this directory and continue using the generated code (and making changes) without Crystal.

            (10) Crystal makes language integration and/or migration easier.
          
  - generator: travis.ConfigGenerator
    spec:
      language: node_js
      node_js:
      - '0.12'
scripts:
  build:
    - description: Install Node.js via nvm.
      command: curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.29.0/install.sh | bash
    - description: Install Bower via npm.
      command: npm install bower -g
    - description: Install CoffeeScript via npm.
      command: npm install coffee-script -g
    - description: Install Forever via npm.
      command: npm install forever -g
    - description: Install http-server via npm.
      command: npm install http-server -g
    - description: Install Grunt CLI via npm.
      command: npm install grunt-cli -g
    - description: Install npm Modules.
      command: npm install
    - description: Install bower Modules.
      command: bower install
    - description: Compile Library.
      command: coffee --compile --output lib/ src/
    - description: Compile CLI Library.
      command: coffee --compile --output cli/lib/ cli/src/
  run:
    - description: Run web server for Autocode app.
      command: nohup cd app/lib http-server -p 8080 &
  stop:
    - description: Stop web server for Autocode app.
      command: lsof -P | grep ':8080' | awk '{print $2}' | xargs kill -9
  test:
    - description: Test Autocode.
      command: npm test