#!perl use 5.010001; use strict; use warnings; use Log::ger::Screen; use App::ThisDist 'this_mod'; use Cwd; use Getopt::Long; our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY our $DATE = '2024-01-06'; # DATE our $DIST = 'App-ThisDist'; # DIST our $VERSION = '0.023'; # VERSION my ($quiet, $namespace_prefix, $extract_version); $namespace_prefix = $ENV{PERL_THIS_MOD_NAMESPACE_PREFIX}; Getopt::Long::Configure("bundling", "no_ignore_case"); GetOptions( "quiet|q" => \$quiet, "namespace-prefix|n=s" => \$namespace_prefix, "extract-version|V" => \$extract_version, ); my $cwd = getcwd(); my $mod = this_mod($cwd, $extract_version); if (defined $mod) { if (defined $namespace_prefix && length $namespace_prefix) { $namespace_prefix =~ s/::\z//; $mod =~ s/\A\Q$namespace_prefix\E(?:::|\z)//i; } print $mod, "\n"; } else { if ($quiet) { } else { warn "this-mod: No perl module name can be associated with current directory '$cwd'\n"; } exit 1; } # ABSTRACT: Return name of Perl module associated with the current directory # PODNAME: this-mod __END__ =pod =encoding UTF-8 =head1 NAME this-mod - Return name of Perl module associated with the current directory =head1 VERSION This document describes version 0.023 of this-mod (from Perl distribution App-ThisDist), released on 2024-01-06. =head1 SYNOPSIS % pwd /home/budi/perl-Foo-Bar % this-mod Foo::Bar Some common usage: # read documentation about the current module % man `this-mod` # open documentation abut the current module on MetaCPAN (but see this-mod-on-metacpan script) % firefox metacpan.org/pod/`this-mod` Some other examples: # (Re)install this module using L<cpanminus|App::cpanminus>: % cpanm -n --reinstall `this-mod` # remove namespace prefix % cd repos/perl-Acme-CPANModules-Symlink % cpanmodules ls-entries `this-mod -n Acme::CPANModules` =head1 DESCRIPTION This script tries these methods when guessing Perl module name associated with current directory. First it tries to find the associated Perl distribution name: =over =item * Distribution metadata {MYMETA,META}.{json,yml} =item * Makefile.PL, Makefile, Build.PL =item * Name in F<dist.ini> (L<Dist::Zilla> configuration file), if the file is available =back After it gets the distribution (e.g. C<Foo-Bar>) it then converts it to module name syntax (i.e. C<Foo::Bar>). If it cannot find an associated Perl distribution name, it will print an error message to stderr (unless being told to be quiet via C<--quiet>) and exit with non-zero status. =head1 OPTIONS =head2 --quiet, -q =head2 --extract-version, -V =head2 --namespace-prefix, -n Remove the specified namespace prefix. =head1 ENVIRONMENT =head2 DEBUG Bool. If set to true, will print debugging statement to stderr. =head2 PERL_THIS_MOD_NAMESPACE_PREFIX String. Set default for C<--namespace-prefix> option. =head1 HOMEPAGE Please visit the project's homepage at L<https://metacpan.org/release/App-ThisDist>. =head1 SOURCE Source repository is at L<https://github.com/perlancar/perl-App-ThisDist>. =head1 SEE ALSO L<dir2mod> L<this-dist> L<this-mod-on-metacpan> Some scripts like L<pmman> and L<pmpath> (from L<App::PMUtils>) or L<list-dist-contents> and L<dist-has-deb> (from L<App::DistUtils>) already default to "current module" or "current distribution" so instead of saying: % pmman `this-mod` you can just say: % pmman =head1 AUTHOR perlancar <perlancar@cpan.org> =head1 CONTRIBUTING To contribute, you can send patches by email/via RT, or send pull requests on GitHub. Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: % prove -l If you want to build the distribution (e.g. to try to install it locally on your system), you can install L<Dist::Zilla>, L<Dist::Zilla::PluginBundle::Author::PERLANCAR>, L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2024, 2023, 2022, 2021, 2020 by perlancar <perlancar@cpan.org>. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 BUGS Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-ThisDist> When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. =cut