this-mod - Return name of Perl module associated with the current directory
This document describes version 0.023 of this-mod (from Perl distribution App-ThisDist), released on 2024-01-06.
% 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`
This script tries these methods when guessing Perl module name associated with current directory. First it tries to find the associated Perl distribution name:
Distribution metadata {MYMETA,META}.{json,yml}
Makefile.PL, Makefile, Build.PL
Name in dist.ini (Dist::Zilla configuration file), if the file is available
After it gets the distribution (e.g. Foo-Bar) it then converts it to module name syntax (i.e. 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 --quiet) and exit with non-zero status.
Foo-Bar
Foo::Bar
--quiet
Remove the specified namespace prefix.
Bool. If set to true, will print debugging statement to stderr.
String. Set default for --namespace-prefix option.
--namespace-prefix
Please visit the project's homepage at https://metacpan.org/release/App-ThisDist.
Source repository is at https://github.com/perlancar/perl-App-ThisDist.
dir2mod
this-dist
this-mod-on-metacpan
Some scripts like pmman and pmpath (from App::PMUtils) or list-dist-contents and dist-has-deb (from App::DistUtils) already default to "current module" or "current distribution" so instead of saying:
% pmman `this-mod`
you can just say:
% pmman
perlancar <perlancar@cpan.org>
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 Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, 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.
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.
Please report any bugs or feature requests on the bugtracker website 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.
To install App::ThisDist, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ThisDist
CPAN shell
perl -MCPAN -e shell install App::ThisDist
For more information on module installation, please visit the detailed CPAN module installation guide.