NAME

    Dist::Zilla::Plugin::SyncCPANfile - Sync a cpanfile with the prereqs
    listed in dist.ini

VERSION

    version 0.03

SYNOPSIS

        # in dist.ini
        [SyncCPANfile]
    
        # configure it yourself
        [SyncCPANfile]
        filename = my-cpanfile
        comment  = This is my cpanfile

    Unlike Dist::Zilla::Plugin::CPANFile this plugin does not add a
    cpanfile to the distribution but to the "disk".

CONFIG

 filename

    With this config you can change the filename for the file. It defaults
    to cpanfile.

        [SyncCPANfile]
        filename = my-cpanfile

 comment

    The default comment says, that the cpanfile was generated by this
    plugin. You can define your own comment.

        [SyncCPANfile]
        comment  = This is my cpanfile
        comment  = line 2

 cpan_audit

    When cpan_audit is enabled, the required module version is not defined
    (or 0), and the module has vulnerabilities, the "fixed version" storied
    in CPAN::Audit is used as a minimum version.

      [SyncCPANfile]
      cpan_audit = 1
    
      [Prereqs]
      ExtUtils::MakeMaker = 0

    ExtUtils::MakeMaker has a vulnerability in versions <= 7.21. As the
    minimum version in the dist.ini is 0 and cpan_audit is enabled, the
    cpanfile will use 7.22 as the minimum version (as of June 2023).

    As this depends on the CPAN::Audit database, you should update
    CPAN::Audit regularly.

    For dependencies where a minimum version is defined and the defined
    version is vulnerable a warning is shown.

SEE ALSO

    Dist::Zilla::Plugin::CPANFile, Dist::Zilla::Plugin::GitHubREADME::Badge

AUTHOR

    Renee Baecker <reneeb@cpan.org>

COPYRIGHT AND LICENSE

    This software is Copyright (c) 2021 by Renee Baecker.

    This is free software, licensed under:

      The Artistic License 2.0 (GPL Compatible)

