PHPStanのエラーをprettyにしようとしている

Transcript

1. PHPStanのエラーをprettyにしようとしている Natsuki
2. PHPStan使ってますか public ?int $age return $this->age + 1; <?php class User { public function __construct( public string $name, ) {} public function nextAge(): int { } }
3. VSCodeのエラーは見づら過ぎる!! /** * @return array{ * id: int, * name: string, * // ... * } */ function getProfile(): array { return [ 'id' => 123, 'name' => 'John Doe', // ... ]; }
4. pretty-ts-errorsみたいなのが欲しい
5. エラー文をパスーすればいいのでは(1) php-yacc 第179回 PHP勉強会＠東京でのきんじょうさんの話 オフラインです
6. エラー文をパスーすればいいのでは(2) racc Umeda.rbにて わいださん のraccの話 ぺちこん関西2025でのトーク LRパーサーとか難しいのでなんとなくの理解
7. パーサーを使わないアプローチ パーサーは作らずエラーパターンからマッチさせる /Function 関数名 should return 型(array{...}) but returns 型(array{...})./ エラーの種類だけ、パターンマッチで拾う エラーパターンの変更を追従するのが大変 & プラグインの数だけ対応が必要 => 汎用的にエラー文をパースできた方がいい
8. ちなみにpretty-ts-errorsは正規表現 https://github.com/yoavbls/pretty-ts- errors/blob/8527285178e9a88c80ad63fa7f0129192b67bad2/packages/formatter/ TSはエラーパターンが決まってるからできる `${pre}${formatTypeBlock("", type, codeBlock)}: <ul>${post .split(", ") .filter(Boolean) .map((prop: string) => `<li>${prop}</li>`) .join("")}</ul>` message .replaceAll( /(is missing the following properties from type\s?)'(.*)': ((?:#?\w+, )*(?:(?!and)\w+)?)/g, (_, pre, type, post) => )
9. Chevrotain TypeScript製のパーサージェネレーター マメジカ
10. 例
11. 例 this.RULE("object", () => { this.CONSUME(LCurly); this.MANY_SEP({ SEP: Comma, DEF: () => { this.SUBRULE(this.objectItem); }, }); this.CONSUME(RCurly); }); class JsonParser extends CstParser { constructor() { this.RULE("json", () => { this.OR([ { ALT: () => this.SUBRULE(this.object) }, { ALT: () => this.SUBRULE(this.array) }, ]); }); this.RULE("objectItem", () => { this.CONSUME(StringLiteral); this.CONSUME(Colon); this.SUBRULE(this.value);
12. パーサーの定義の前に字句解析(Lexer) const True = createToken({ name: "True", pattern: /true/ }); const False = createToken({ name: "False", pattern: /false/ }); const Null = createToken({ name: "Null", pattern: /null/ }); const LCurly = createToken({ name: "LCurly", pattern: /{/ }); const RCurly = createToken({ name: "RCurly", pattern: /}/ });
13. phpstan-error-parserを作っています
14. 使い方 import { parse } from 'phpstan-error-parser'; const result = parse('PHPDoc tag @mixin contains unresolvable type.') [ { type: 'common_word', value: 'PHPDoc', location: { startColumn: 0, endColumn: 6, }, }, { type: 'common_word', value: 'tag', location: { startColumn: 7, endColumn: 10, }, }, { type: 'doc_tag', value: '@mixin',
15. VSCode拡張の組み込み アプローチは二つ pretty-ts-errorsのように別拡張として提供 phpstan-vscode自体に組み込む
16. pretty-ts-errorsとphpstan-vscodeがエラーを表示 している仕組み pretty-ts-errors ⇒ Diagnostic phpstan-vscode ⇒ HoverProvider
17. Diagnostic(診断) 場所とメッセージを渡すとエラー表示してくれる https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic phpstan-vscodeはPHPStanの結果をこれでVSCodeに渡している messageにMarkdownを渡せばリッチな表示ができる？ ⇒ できない🙅 interface Diagnostic { range: Range; severity?: DiagnosticSeverity; source?: string; message: string; }
18. HoverProvider ホバーイベントに応じてメッセージを返す https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover `Hover`ではcontentsにMarkdownを渡せばリッチな表示ができる❗️❗️ contents: MarkedString | MarkedString[] | MarkupContent; interface Hover { /** * The hover's content */ /** * An optional range is a range inside a text document * that is used to visualize a hover, e.g. by changing the background color. */ range?: Range; }
19. pretty-ts-errorsでもそれによるDiscussionがある https://github.com/yoavbls/pretty-ts-errors/discussions/43
20. LSP 3.18 ならDiagnosticにもMarkdownが使える https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#diagnostic いつになるか分からないので 別拡張としてphpstan-error-parserでパースして、HoverProviderで実装する予 定 おしまい