2017 © Pedro Peláez
 

library hhast

image

hhvm/hhast

  • Thursday, July 19, 2018
  • by fredemmott
  • Repository
  • 11 Watchers
  • 21 Stars
  • 3,715 Installations
  • Hack
  • 21 Dependents
  • 0 Suggesters
  • 15 Forks
  • 19 Open issues
  • 13 Versions
  • 131 % Grown

The README.md

HHAST

Continuous Integration, (*1)

HHAST is a toolkit for processing the AST of Hack files., (*2)

Abstract syntax trees can be an extremely powerful basis for many kinds of tooling beyond compilers and optimization; HHAST is built on top of Hack's Full Fidelity Parser (FFP), providing a Hack object representation of a mutable AST., (*3)

Unlike traditional ASTs, the FFP's AST includes all 'trivia' - such as whitespace and comments - allowing you to fully recreate the file from the AST, or create an updated file after mutating the AST, preserving comments and whitespace., (*4)

HHAST has 3 main APIs:, (*5)

  • a low-level library for inspecting and manipulating the FFP AST
  • a linting framework, with support for auto-fixing linters
  • a migration framework

Linters

screenshot of lint errors, (*6)

Linters are designed for subjective or style changes which do not substantially alter the behavior of the code, and may be rejected on a case-by-case basis. Lint errors can provide a suggested fix, which may be based on an AST mutation, but doesn't have to be., (*7)

We've included several linters as a starting point, including:, (*8)

  • don't use await in a loop
  • methods should be ->lowerCamelCase(), functions should be under_scored()
  • always use braces for control flow
  • always use <<__Override>> where possible

Linters can be used both interactively, or unattended. Autofixing is not supported unattended, however it will exit with non-zero if there are any lint issues, to ease integration with CI systems., (*9)

Editor and IDE Support

screenshot of lint errors in VSCode, (*10)

HHAST is supported by:, (*11)

  • ALE for Vim 8 and neovim
  • atom-ide-hhast for Atom IDE and Nuclide
  • [vscode-hack] for Visual Studio Code

Migrations

screenshot of a migration, (*12)

Migrations are for sweeping changes you want to apply across your entire codebase, and are often more complex. Taking this into account, the migration framework has built-in support for multi-step migrations (unlike linters). AST-aware migrations can be a powerful tool for:, (*13)

  • adjusting for changes to the language (for example, the shape changes described below)
  • replacing deprecated APIs with new ones
  • general clean-up of the codebase

Low-level AST library

See the documentation., (*14)

License

HHAST is MIT-licensed., (*15)

The Versions

19/07 2018

dev-master

9999999-dev

  Sources   Download

MIT

The Requires

 

The Development Requires

17/07 2018

v3.27.2

3.27.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

28/06 2018

v3.27.1

3.27.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

11/06 2018

v3.27.0

3.27.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

10/05 2018

v3.26.0

3.26.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

01/03 2018

v1.0.1

1.0.1.0

  Sources   Download

The Requires

 

The Development Requires

09/02 2018

v1.0

1.0.0.0

  Sources   Download

The Requires

 

The Development Requires

11/01 2018

v0.6

0.6.0.0

  Sources   Download

The Requires

 

The Development Requires

18/12 2017

v0.5

0.5.0.0

  Sources   Download

The Requires

 

The Development Requires

09/11 2017

v0.4

0.4.0.0

  Sources   Download

The Requires

 

The Development Requires

17/10 2017

v0.3

0.3.0.0

  Sources   Download

The Requires

 

The Development Requires

29/09 2017

v0.2

0.2.0.0

  Sources   Download

The Requires

 

The Development Requires

26/09 2017

v0.1

0.1.0.0

  Sources   Download

The Requires

 

The Development Requires