wikipeg 4.0.2 → 5.0.0

package/VERSION

@@ -1 +1 @@
-4.0.2
+5.0.0

package/lib/compiler/language/javascript.js

@@ -225,7 +225,7 @@ let javascript = {
     if (opts.params.length) {
       keyParts = keyParts.concat(opts.params);
     }
-    let storeRefs = opts.storeRefs.filter(function(part) {
+    const storeRefs = opts.storeRefs.filter(function(part) {
       return part !== '';
     }).map(function(part) {
       return '  ' + part;

package/lib/peg.js

@@ -5,7 +5,7 @@ var arrays  = require("./utils/arrays"),
 
 var PEG = {
   /* WikiPEG version (uses semantic versioning). */
-  VERSION: "4.0.2",
+  VERSION: "5.0.0",
 
   GrammarError: require("./grammar-error"),
   parser:       require("./parser"),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wikipeg",
-	"version": "4.0.2",
+	"version": "5.0.0",
 	"description": "Parser generator for JavaScript and PHP",
 	"license": "MIT",
 	"homepage": "https://gerrit.wikimedia.org/r/plugins/gitiles/wikipeg/",
@@ -40,7 +40,7 @@
 		"url": "https://gerrit.wikimedia.org/r/wikipeg"
 	},
 	"devDependencies": {
-		"eslint": "8.31.0",
+		"eslint": "8.57.0",
 		"jasmine-node": "3.0.0"
 	},
 	"engines": {

package/src/DefaultTracer.php

@@ -5,31 +5,31 @@ namespace Wikimedia\WikiPEG;
 use InvalidArgumentException;
 
 class DefaultTracer implements Tracer {
-	private $indentLevel = 0;
+	protected int $indentLevel = 0;
 
-	public function trace( $event ) {
+	public function trace( array $event ): void {
 		switch ( $event['type'] ) {
-		case 'rule.enter':
-			$this->log( $event );
-			$this->indentLevel++;
-			break;
+			case 'rule.enter':
+				$this->log( $event );
+				$this->indentLevel++;
+				break;
 
-		case 'rule.match':
-			$this->indentLevel--;
-			$this->log( $event );
-			break;
+			case 'rule.match':
+				$this->indentLevel--;
+				$this->log( $event );
+				break;
 
-		case 'rule.fail':
-			$this->indentLevel--;
-			$this->log( $event );
-			break;
+			case 'rule.fail':
+				$this->indentLevel--;
+				$this->log( $event );
+				break;
 
-		default:
-			throw new InvalidArgumentException( "Invalid event type {$event['type']}" );
+			default:
+				throw new InvalidArgumentException( "Invalid event type {$event['type']}" );
 		}
 	}
 
-	private function log( $event ) {
+	protected function log( array $event ) {
 		print str_pad(
 			'' . $event['location'],
 			20
@@ -40,7 +40,7 @@ class DefaultTracer implements Tracer {
 			. "\n";
 	}
 
-	private function formatArgs( $argMap ) {
+	protected function formatArgs( ?array $argMap ): string {
 		if ( !$argMap ) {
 			return '';
 		}

package/src/PEGParserBase.php

@@ -2,29 +2,31 @@
 
 namespace Wikimedia\WikiPEG;
 
+use stdClass;
+
 abstract class PEGParserBase {
-	protected static $FAILED;
-	protected static $UNDEFINED;
-	protected $currPos;
-	protected $savedPos;
-	protected $input;
-	protected $inputLength;
-	protected $options;
+	protected static ?stdClass $FAILED = null;
+	protected static ?stdClass $UNDEFINED = null;
+	protected int $currPos;
+	protected int $savedPos;
+	protected string $input;
+	protected int $inputLength;
+	protected array $options;
+	/** @var array */
 	protected $cache;
 
 	/** @var array<int,array{line:int,column:int,seenCR:bool}> */
-	protected $posDetailsCache;
-	protected $maxFailPos;
-	protected $maxFailExpected;
+	protected array $posDetailsCache;
+	protected int $maxFailPos;
+	protected array $maxFailExpected;
 
 	/** @var array Associative arrays of expectation info */
 	protected $expectations;
 
 	/** @var Expectation[] */
-	private $expectationCache;
+	private array $expectationCache;
 
-	/** @var Tracer */
-	protected $tracer;
+	protected Tracer $tracer;
 
 	public function __construct() {
 		if ( !self::$FAILED ) {
@@ -35,7 +37,8 @@ abstract class PEGParserBase {
 		}
 	}
 
-	protected function traceCall( $parseFunc, $name, $argNames, $args ) {
+	/** @return mixed */
+	protected function traceCall( callable $parseFunc, string $name, array $argNames, array $args ) {
 		$argMap = [];
 		foreach ( $args as $i => $argValue ) {
 			$argMap[$argNames[$i]] = $argValue;
@@ -47,7 +50,7 @@ abstract class PEGParserBase {
 			'location' => $this->computeLocation( $startPos, $startPos ),
 			'args' => $argMap
 		] );
-		$result = call_user_func_array( $parseFunc, $args );
+		$result = $parseFunc( ...$args );
 		if ( $result !== self::$FAILED ) {
 			$this->tracer->trace( [
 				'type' => 'rule.match',
@@ -65,11 +68,11 @@ abstract class PEGParserBase {
 		return $result;
 	}
 
-	protected function text() {
+	protected function text(): string {
 		return substr( $this->input, $this->savedPos, $this->currPos - $this->savedPos );
 	}
 
-	protected function location() {
+	protected function location(): LocationRange {
 		return $this->computeLocation( $this->savedPos, $this->currPos );
 	}
 
@@ -99,7 +102,7 @@ abstract class PEGParserBase {
 		);
 	}
 
-	public static function charAt( $s, $byteOffset ) {
+	public static function charAt( string $s, int $byteOffset ): string {
 		if ( !isset( $s[$byteOffset] ) ) {
 			return '';
 		}
@@ -117,7 +120,7 @@ abstract class PEGParserBase {
 		return $char;
 	}
 
-	public static function charsAt( $s, $byteOffset, $numChars ) {
+	public static function charsAt( string $s, int $byteOffset, int $numChars ): string {
 		$ret = '';
 		for ( $i = 0; $i < $numChars; $i++ ) {
 			$ret .= self::consumeChar( $s, $byteOffset );
@@ -125,7 +128,7 @@ abstract class PEGParserBase {
 		return $ret;
 	}
 
-	public static function consumeChar( $s, &$byteOffset ) {
+	public static function consumeChar( string $s, int &$byteOffset ): string {
 		if ( !isset( $s[$byteOffset] ) ) {
 			return '';
 		}
@@ -143,6 +146,10 @@ abstract class PEGParserBase {
 		return $char;
 	}
 
+	/**
+	 * @param mixed $value
+	 * @return mixed
+	 */
 	public static function &newRef( $value ) {
 		return $value;
 	}
@@ -165,7 +172,8 @@ abstract class PEGParserBase {
 		while ( $p < $pos ) {
 			$ch = self::charAt( $this->input, $p );
 			if ( $ch === "\n" ) {
-				if ( !$details['seenCR'] ) { $details['line']++;
+				if ( !$details['seenCR'] ) {
+					$details['line']++;
 				}
 				$details['column'] = 1;
 				$details['seenCR'] = false;
@@ -185,7 +193,7 @@ abstract class PEGParserBase {
 		return $details;
 	}
 
-	protected function computeLocation( $startPos, $endPos ) {
+	protected function computeLocation( int $startPos, int $endPos ): LocationRange {
 		if ( $endPos > $this->inputLength ) {
 			$endPos--;
 		}
@@ -202,7 +210,7 @@ abstract class PEGParserBase {
 		);
 	}
 
-	protected function fail( $expected ) {
+	protected function fail( int $expected ) {
 		if ( $this->currPos < $this->maxFailPos ) {
 			return;
 		}
@@ -234,7 +242,7 @@ abstract class PEGParserBase {
 		return $expanded;
 	}
 
-	private function buildMessage( $expected, $found ) {
+	private function buildMessage( array $expected, ?string $found ): string {
 		$expectedDescs = [];
 
 		foreach ( $expected as $info ) {
@@ -251,7 +259,9 @@ abstract class PEGParserBase {
 		return "Expected " . $expectedDesc . " but " . $foundDesc . " found.";
 	}
 
-	protected function buildException( $message, $expected, $found, $location ) {
+	protected function buildException(
+		?string $message, ?array $expected, ?string $found, LocationRange $location
+	): SyntaxError {
 		if ( $expected !== null ) {
 			sort( $expected );
 			$expected = array_unique( $expected );
@@ -271,7 +281,7 @@ abstract class PEGParserBase {
 		);
 	}
 
-	protected function buildParseException() {
+	protected function buildParseException(): SyntaxError {
 		$char = self::charAt( $this->input, $this->maxFailPos );
 		return $this->buildException(
 			null,
@@ -284,7 +294,7 @@ abstract class PEGParserBase {
 	protected function initialize() {
 	}
 
-	protected function initInternal( $input, $options ) {
+	protected function initInternal( string $input, array $options ) {
 		$this->currPos = 0;
 		$this->savedPos = 0;
 		$this->input = $input;
@@ -299,5 +309,6 @@ abstract class PEGParserBase {
 		$this->initialize();
 	}
 
-	abstract public function parse( $input, $options = [] );
+	/** @return mixed */
+	abstract public function parse( string $input, array $options = [] );
 }

package/src/SyntaxError.php

@@ -3,9 +3,9 @@
 namespace Wikimedia\WikiPEG;
 
 class SyntaxError extends \Exception implements \JsonSerializable {
-	public $expected;
-	public $found;
-	public $location;
+	public array $expected;
+	public ?string $found;
+	public LocationRange $location;
 
 	/**
 	 * @param string $message
@@ -13,7 +13,7 @@ class SyntaxError extends \Exception implements \JsonSerializable {
 	 * @param string|null $found
 	 * @param LocationRange $location
 	 */
-	public function __construct( string $message, array $expected, $found, LocationRange $location ) {
+	public function __construct( string $message, array $expected, ?string $found, LocationRange $location ) {
 		parent::__construct( $message );
 		$this->expected = $expected;
 		$this->found    = $found;

package/src/Tracer.php

@@ -3,5 +3,5 @@
 namespace Wikimedia\WikiPEG;
 
 interface Tracer {
-	public function trace( $event );
+	public function trace( array $event ): void;
 }