GitXplorerGitXplorer
f

hack-error-suppressor

public
1 stars
1 forks
0 issues

Commits

List of commits on branch master.
Verified
e11515663b083e21bce1b5eee57c2116f6317210

Update README to indicate incative status

ffredemmott committed 6 years ago
Verified
cb145c771b50f4f4eeec8c9cac4740df3d486a12

Fetch the backtrace using debug_backtrace()

ffredemmott committed 8 years ago
Verified
0bb3b607067f87f9bd0cf5f6f2ade560d0c6fc00

Use file and line, not function, to identify backtrace args

ffredemmott committed 8 years ago
Verified
ba535ee1bff0ebc1db4f5f92176da13cfaface5b

Fix delegation to standard error handler.

ffredemmott committed 8 years ago
Verified
2b227695fc02d77a771646b30f844dc47302c331

Change TravisCI config to use docker

ffredemmott committed 8 years ago
Verified
acaba332c5597455b9900388b00b11a53d773a93

Also support suppressing the "no .hhconfig" message

ffredemmott committed 8 years ago

README

The README file for this repository.

INACTIVE PROJECT

THIS PROJECT IS NO LONGER ACTIVE; it is not needed with HHVM 3.25 and later.

Hack Error Suppressor Build Status

Unless the hhvm.hack.lang.look_for_typechecker ini setting is set to false, by default HHVM will try to run the typechecker when loading any Hack files, and raise a catchable runtime fatal error.

This is a PHP library that makes it convenient to temporarily disable this behavior.

When This Is Useful

HHVM's behavior is problematic when:

  • HHVM can't work out where the project root is - for example, if you're trying to run Hack code from a composer plugin
  • If your Hack code needs to operate on an incomplete project - for example, if you wish to write Hack code to fetch dependencies
  • If your Hack code needs to operate on known-bad projects - for example, when updating generated code, the code may be inconsistent while your codegen is in process

When You Shouldn't Use This

It's probably not appropriate if any of these are true:

  • it's used outside of a build/install or codegen process
  • it's used when using generated code
  • it's called during normal use of your software, rather than just by developers
  • it's used outside of the CLI

Typechecker errors are real problems with code, and mean that things are broken; ignoring enforcement is only a good idea if you are expecting your code to be running on a temporarily-broken codebase, and your code fixes it.

Installation

$ composer require fredemmott/hack-error-suppressor

Usage

You must enable error suppression before any Hack code is loaded.

You can explicitly enable and disable the suppression:

<?php
use FredEmmott\HackErrorSuppressor;

$it = new HackErrorSuppressor();
$it->enable();
call_some_hack_code();
$it->disable();

You can also enable the suppression with a scope:

<?php

use FredEmmott\ScopedHackErrorSuppressor;

function do_unsafe_stuff() {
  $suppressor = new ScopedHackErrorSuppressor();
  call_some_hack_code(); // this works
}

do_unsafe_stuff();
call_some_hack_code(); // this fails, as we're out of scope

Using Outside Of The CLI

This is disallowed by default; if you're absolutely certain you need to do this (keeping in mind that typechecker errors are real problems with your code, not just lint) you can disable the check:

FredEmmott\HackErrorSuppressor::allowRealRequestsAgainstBrokenCode();