facebook/hack-codegen

Hack Codegen is a library for programatically generating Hack code

Thursday, July 5, 2018
by alejandromarcu
Repository
60 Watchers
307 Stars
9,422 Installations

Hack
6 Dependents
0 Suggesters
89 Forks
9 Open issues
27 Versions
53 % Grown

The README.md

Hack Codegen

Hack Codegen is a library for easily generating Hack code and writing it into signed files that prevent undesired modifications. The idea behind writing code that writes code is to raise the level of abstraction and reduce coupling. You can use your own way of describing a problem and generate the corresponding code. E.g. see examples/dorm. In this example, we use a schema to describe the structure of the data, and we use Hack Codegen to write the matching code., _(*1)

Examples

The DORM example shows how to use the different aspects of the code generation in a simplified real-life example. The included tests also exemplify the usage of the different components., _(*2)

Requirements

Hack Codegen requires: * HHVM * Composer, _(*3)

Installing Hack Codegen

This package can be installed via composer:, _(*4)

composer require facebook/hack-codegen

Usage

Include the autoload file generated by composer and you are ready to start using it. For example:, _(*5)

<?hh
require 'vendor/autoload.php';

use Facebook\HackCodegen\HackCodegenFactory;

$cg = new HackCodegenFactory(new HackCodegenConfig());

echo $cg->codegenFile('HelloWorld.php')
  ->addClass(
    $cg->codegenClass('HelloWorld')
      ->addMethod(
        $cg->codegenMethod('sayHi')
          ->setReturnType('void')
          ->setBody(
            $cg->codegenHackBuilder()
              ->addAssignment(
                '$some_vector',
                Vector { 1, 2, 3 },
                HackBuilderValues::vector(
                  HackBuilderValues::export(),
                ),
              )
              ->addAssignment(
                '$debug_info',
                Map { 'file' => '__FILE__', 'line' => '__LINE__' },
                HackBuilderValues::map(
                  HackBuilderKeys::export(),
                  HackBuilderValues::literal(),
                ),
              )
              ->addAssignment(
                '$some_vector_of_vectors',
                Vector { Vector { 1, 2, 3 }, Vector { 4, 5, 6 } },
                HackBuilderValues::vector(
                  HackBuilderValues::vector(
                    HackBuilderValues::export(),
                  ),
                ),
              )
              ->addLine('echo "hello world\n";')
              ->getCode();
          );
      )
  )->save();

Configuration

You can configure some options such as the maximum line width, spacing and headers by implementing IHackCodegenConfig and passing an instance to HackCodegenFactory's constructor., _(*6)

License

Hack Codegen is MIT-licensed., _(*7)

The Versions

05/07 2018

v3.x-dev

3.9999999.9999999.9999999-dev

Hack Codegen is a library for programatically generating Hack code

library hack-codegen

Hack Codegen is a library for programatically generating Hack code

facebook/hack-codegen

The README.md

Hack Codegen

Examples

Requirements

Installing Hack Codegen

Usage

Configuration

License

The Versions

v3.x-dev

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.1.1

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

dev-master

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.1.0

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.0.8

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.0.6

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.0.7

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.0.5

The Requires

The Development Requires

by Gaurav Kumar

by Drew Hoskins

by Alejandro Marcu

by Matthieu Martin

by Fred Emmott

v3.0.3

The Requires

The Development Requires

by Gaurav Kumar