4 ms·

Mago author here. Thanks for the feedback. You're right that the README should be clearer about the beta status and the current feature set. That's a great sug

Mago author here. Thanks for the feedback. You're right that the README should be clearer about the beta status and the current feature set. That's a great suggestion, and I'll get that updated. Regarding the errors you saw, I suspect the main culprit isn't a general lack of PHPDoc parsing, but rather the two biggest remaining features we're actively working on: support for magic _@method_ and _@property_ tags. Mago has full support for generics (@template), assertions (@psalm-assert*), conditional types, etc., but the absence of those two is definitely a major source of noise on established projects right now. They are our top priority and should land in the next beta release. On the topic of feature parity, you're right that it's a moving target. Our goal isn't to be a 1-to-1 clone of Psalm or PHPStan, but a different tool with its own strengths (see: https://github.com/carthage-software/mago/discussions/379 https://github.com/carthage-software/mago/discussions/379). For example, Mago will flag code like `[0 => $a, $b] = ["a", "b"]` as an error, which other tools currently do not. We're very aware of the current noise level. We test Mago daily against massive, multi-million-line codebases. On one such project, the first beta reported ~250,000 errors; we're now down to ~30,000. While still a lot, it shows how quickly we're closing the gap on false positives. Thanks again for the valuable feedback. It's a long road, but we're confident we can reach and surpass the current standards in a very short time.

idoubtit 1y ago
Thanks for explaining your goal and some of the context. I suggest that stating them prominently would help the project. When I read Mago's home page, I downloaded the latest release, followed the "Getting started" process on a local repository, then nearly lost interest when I saw the amount of false errors. If I had first read "here is our goal, with this roadmap, this kind of validation on real projects, and this position toward existing well-known tools", I would have been much more willing to follow the project and accept its false positives. As a side note, for my first try with Mago, I think its lack of parsing `@property` was a major source of false errors, because the source code it analyzed had a few omnipresent classes that used it. BTW, Mago panicked when I tried to lint another repository... I'll open a issue.
- azjezz2 1y ago
  Thank you in advance for opening an issue for the panic—that's super helpful. You are 100% right about the documentation and managing expectations on the home page. That's a failure on my part, and based on your feedback, I'll make it a priority to be much clearer about the project's beta status, goals, and roadmap. The lack of @property and @method support was the single biggest source of noise on established codebases. The good news is that this is exactly what we've been focused on, and support for both was just merged in the past few hours: @method support is now quite robust: - https://github.com/carthage-software/mago/commit/c76795c30de1db190fd8b311d446327e3e5c1327 https://github.com/carthage-software/mago/commit/c76795c30de... - https://github.com/carthage-software/mago/commit/dc333edb2613e427d4a850b8ba41ed529726e367 https://github.com/carthage-software/mago/commit/dc333edb261... @property support is about 95% there, and we're ironing out the last few edge cases as we speak: - https://github.com/carthage-software/mago/commit/9e8d30b0672af57db7d2f9894d4f286ee6825a1f https://github.com/carthage-software/mago/commit/9e8d30b0672... - https://github.com/carthage-software/mago/commit/0330791a9d343ba9ddfd6fab1fb7278d21afc5e0 https://github.com/carthage-software/mago/commit/0330791a9d3... Hopefully, the next release will provide a much better experience out of the box. Thanks again for taking the time to write this up!

idoubtit 1y ago

Thanks for explaining your goal and some of the context. I suggest that stating them prominently would help the project. When I read Mago's home page, I downloaded the latest release, followed the "Getting started" process on a local repository, then nearly lost interest when I saw the amount of false errors. If I had first read "here is our goal, with this roadmap, this kind of validation on real projects, and this position toward existing well-known tools", I would have been much more willing to follow the project and accept its false positives. As a side note, for my first try with Mago, I think its lack of parsing `@property` was a major source of false errors, because the source code it analyzed had a few omnipresent classes that used it. BTW, Mago panicked when I tried to lint another repository... I'll open a issue.

azjezz2 1y ago
Thank you in advance for opening an issue for the panic—that's super helpful. You are 100% right about the documentation and managing expectations on the home page. That's a failure on my part, and based on your feedback, I'll make it a priority to be much clearer about the project's beta status, goals, and roadmap. The lack of @property and @method support was the single biggest source of noise on established codebases. The good news is that this is exactly what we've been focused on, and support for both was just merged in the past few hours: @method support is now quite robust: - https://github.com/carthage-software/mago/commit/c76795c30de1db190fd8b311d446327e3e5c1327 https://github.com/carthage-software/mago/commit/c76795c30de... - https://github.com/carthage-software/mago/commit/dc333edb2613e427d4a850b8ba41ed529726e367 https://github.com/carthage-software/mago/commit/dc333edb261... @property support is about 95% there, and we're ironing out the last few edge cases as we speak: - https://github.com/carthage-software/mago/commit/9e8d30b0672af57db7d2f9894d4f286ee6825a1f https://github.com/carthage-software/mago/commit/9e8d30b0672... - https://github.com/carthage-software/mago/commit/0330791a9d343ba9ddfd6fab1fb7278d21afc5e0 https://github.com/carthage-software/mago/commit/0330791a9d3... Hopefully, the next release will provide a much better experience out of the box. Thanks again for taking the time to write this up!