Cascading Comments
An index of Laravel's cascading comments.
Visit the site at cascading-comments.sjorso.com.
About
This is a cascading comment:
Lines 26 to 30 in 2002a25
Each line is three characters shorter than the previous line. The last line is two characters shorter and ends with punctuation. If a comment follows these rules exactly, we consider it a "perfect" cascading comment.
These types of comments are everywhere in Laravel's source code. The skeleton, framework, and most first-party packages have them. This project finds and indexes all of these comments per Laravel release.
Technical overview
The cron runs three jobs:
- PollReleasesJob - Uses the GitHub API to find new release for repositories we're watching
- DownloadReleaseJob - Downloads the zip of new releases
- ProcessReleaseJob - Finds cascading comments in a release and stores them in the database
These files are interesting:
- GithubApi - Makes GraphQL calls to get all releases of a repository
- ReleaseFile - Finds all cascading comments in a file
- CascadingComment - Detects if a cascading comment is perfect