https://github.com/atoomic/perl-critic-policy-preferredmodules

Custom package recommendations
https://github.com/atoomic/perl-critic-policy-preferredmodules

Last synced: about 2 months ago
JSON representation

Custom package recommendations

• Host: GitHub
• URL: https://github.com/atoomic/perl-critic-policy-preferredmodules
• Owner: atoomic
• Created: 2022-01-24T16:04:13.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-26T23:37:17.000Z (almost 3 years ago)
• Last Synced: 2024-10-13T11:34:33.569Z (3 months ago)
• Language: Perl
• Size: 32.2 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes

Awesome Lists containing this project

README

        
# NAME

Perl::Critic::Policy::PreferredModules - Provide custom package recommendations

# VERSION

version 0.005

# DESCRIPTION

Every project has its own rules for preferring specific packages over others.

This Policy tries to be \`un-opinionated\` and let the user provide a module

preferences with an explanation and/or suggested alternative.

# MODULES

# CONFIGURATION

To use [Perl::Critic::Policy::PreferredModules](https://metacpan.org/pod/Perl%3A%3ACritic%3A%3APolicy%3A%3APreferredModules) you have first to enable it in your

 `.perlcriticrc` file by providing a `preferred_modules.ini` configuration file:

```perl

[PreferredModules]

config = /path/to/preferred_modules.ini

# you can also use '~' in the path for $HOME

#config = ~/.preferred_modules

```

The  `preferred_modules.ini` file is using the [Config::INI](https://metacpan.org/pod/Config%3A%3AINI) format and can looks like this

```perl

[Do::Not::Use]

prefer = Another::Package

reason = "Please use Another::Package rather than Do::Not::Use"

[Avoid::Using::This]

[And::Also::That]

[No:Reason]

prefer=A::Better:Module

[Only::Reason]

reason="If you use this module, a puppy might die."

```

# SEE ALSO

[Perl::Critic](https://metacpan.org/pod/Perl%3A%3ACritic)

# AUTHOR

Nicolas R 

# COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by cPanel, L.L.C.

This is free software; you can redistribute it and/or modify it under

the same terms as the Perl 5 programming language system itself.