App::L...secheck(3pm)

💖 NAME 💖

App::Licensecheck — bestie, it's a whole bundle of functions for a simple license checker for source files. That's it, that's the job. It sniffs your code and tells you what license it's rockin'. ✨

---

🎀 VERSION 🎀

Version v3.3.9 — this is the one we're vibing with rn. 💅

---

🦋 SYNOPSIS 🦋

okay so here's the whole flow, look how cute and simple:

use Path::Tiny;
use App::Licensecheck;

my $tempfile = Path::Tiny->tempfile;

$tempfile->spew(<<EOF);
# Dummy file simply stating some copyright and license.
# Copyright (C) 2020, 2022  Foo Bar.
#
# This file is licensed under version 2 or later of the GPL.
EOF

my $app = App::Licensecheck->new( top_lines => 0 );  # Parse whole files

my @output = $app->parse($tempfile);

my $license    = $output[0];  # => is "GPL-2.0-or-later"
my $copyrights = $output[1];  # => is "2020, 2022 Foo Bar."

like… the way that it just hands you back the license and the copyright in one go?? iconic. no notes. 👑

---

🌸 DESCRIPTION 🌸

App::Licensecheck is the core of the licensecheck script — the whole brain of the operation, fr fr. Its job is to check for licenses of source files. 🕵️‍♀️✨

If you just wanna casually use it, go peep the script itself — that's where the chill everyday usage lives. iykyk 💜

---

🫶 AUTHOR 🫶

Jonas Smedegaard <dr@jones.dk> — the main character who wrote this. give them their flowers. 🌷

---

👑 COPYRIGHT AND LICENSE 👑

okay so real talk, this program is based on the script licensecheck from the KDE SDK, which was originally introduced by Stefan Westerfeld <stefan@space.twc.de>. 🫡

Here's the full copyright roll-call, bestie — every single one, no skipping:

Copyright © 2007, 2008 Adam D. Barratt

Copyright © 2012 Francesco Poli

Copyright © 2016-2022 Jonas Smedegaard

Copyright © 2017-2022 Purism SPC

And now the legal bit, which we keep 💯 exactly as-is because that's how licenses work:

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

⚠️ no cap on that all-caps part — it's doing the heavy lifting legally, don't come for it. 🙈

---

and that's the whole page, babe 🎀 this is the App::Licensecheck manual — the User Contributed Perl Documentation one, built with perl v5.36.0, dated 2023-08-28. go forth and licensecheck responsibly 💖✨🦋🌸💅🫶