Kwalitee Indicators
Core indicators
These indicators are for important issues everyone should fix if found. These are also used to calculate your score and ranking.
| Name | Description | Fail (Latest) |
Fail (CPAN) |
Fail (BackPAN) |
|---|---|---|---|---|
| buildtool_not_executable | The build tool (Build.PL/Makefile.PL) is executable. This is bad because you should specify which perl you want to use while installing. (defined in Module::CPANTS::SiteKwalitee::Files) |
902 (3.17 %) |
4057 (3.93 %) |
15389 (5.3 %) |
| distname_matches_name_in_meta | The distribution name (eg. 'Foo-Bar' of Foo-Bar-1.42.tar.gz) does not match the 'name' field in META files. (defined in Module::CPANTS::SiteKwalitee::Distname) |
95 (0.33 %) |
381 (0.37 %) |
1950 (0.67 %) |
| extractable | This distribution doesn't extract well due to several reasons such as unsupported archive type (CPANTS only supports tar.gz, tgz and zip archives), file permissions, broken links, invalid filenames, and so on. Most of other kwalitee metrics should be ignored. (defined in Module::CPANTS::SiteKwalitee::Extraction) |
13 (0.05 %) |
50 (0.05 %) |
365 (0.13 %) |
| extracts_nicely | This distribution doesn't create a directory and extracts its content into this directory. Instead, it creates more than one directories (some of which are probably system-specific hidden files/directories), or it spews its content into the current directory, making it really hard/annoying to remove the unpacked package. (defined in Module::CPANTS::SiteKwalitee::Extraction) |
62 (0.22 %) |
128 (0.12 %) |
514 (0.18 %) |
| has_abstract_in_pod | No abstract (short description of a module) is found in pod from this distribution. (defined in Module::CPANTS::Kwalitee::Pod) |
983 (3.46 %) |
3440 (3.33 %) |
10933 (3.77 %) |
| has_buildtool | Makefile.PL and/or Build.PL are missing. This makes installing this distribution hard for humans and impossible for automated tools like CPAN/CPANPLUS/cpanminus. (defined in Module::CPANTS::Kwalitee::Files) |
132 (0.46 %) |
335 (0.32 %) |
1331 (0.46 %) |
| has_changelog | The distribution hasn't got a Changelog (named something like m/^chang(es?|log)|history$/i). A Changelog helps people decide if they want to upgrade to a new version. (defined in Module::CPANTS::Kwalitee::Files) |
2010 (7.07 %) |
6286 (6.09 %) |
22844 (7.87 %) |
| has_human_readable_license | This distribution does not have a license defined in the documentation or in a file called LICENSE (defined in Module::CPANTS::Kwalitee::License) |
1973 (6.94 %) |
6231 (6.04 %) |
26077 (8.99 %) |
| has_license_in_source_file | Does not have license information in any of its source files (defined in Module::CPANTS::Kwalitee::License) |
3186 (11.2 %) |
10703 (10.37 %) |
37717 (13 %) |
| has_manifest | The file "MANIFEST" is missing from this distribution. The MANIFEST lists all files included in the distribution. (defined in Module::CPANTS::Kwalitee::Files) |
357 (1.26 %) |
1139 (1.1 %) |
3540 (1.22 %) |
| has_meta_yml | The file "META.yml" is missing from this distribution. META.yml is needed by people maintaining module collections (like CPAN), for people writing installation tools, or just people who want to know some stuff about a distribution before downloading it. (defined in Module::CPANTS::Kwalitee::Files) |
1613 (5.67 %) |
5461 (5.29 %) |
24159 (8.33 %) |
| has_proper_version | The version number isn't a number. It probably contains letter besides a leading 'v', which it shouldn't (defined in Module::CPANTS::SiteKwalitee::DistVersion) |
109 (0.38 %) |
459 (0.44 %) |
4617 (1.59 %) |
| has_readme | The file "README" is missing from this distribution. The README provides some basic information to users prior to downloading and unpacking the distribution. (defined in Module::CPANTS::Kwalitee::Files) |
1831 (6.44 %) |
7175 (6.95 %) |
19497 (6.72 %) |
| has_tests | This distribution doesn't contain either a file called 'test.pl' or a directory called 't'. This indicates that it doesn't contain even the most basic test-suite. This is really BAD! (defined in Module::CPANTS::Kwalitee::Files) |
1121 (3.94 %) |
3583 (3.47 %) |
8917 (3.07 %) |
| has_version | The distribution filename (eg. Foo-Bar-1.42.tar.gz) does not include a version number (or something that looks like a reasonable version number to CPAN::DistnameInfo) (defined in Module::CPANTS::SiteKwalitee::DistVersion) |
54 (0.19 %) |
78 (0.08 %) |
338 (0.12 %) |
| main_module_version_matches_dist_version | The version and/or name of the main module in this distribution doesn't match the distribution version and/or name. (defined in Module::CPANTS::SiteKwalitee::Version) |
1426 (5.01 %) |
5404 (5.24 %) |
18290 (6.3 %) |
| manifest_matches_dist | MANIFEST does not match the contents of this distribution. (defined in Module::CPANTS::Kwalitee::Manifest) |
1347 (4.74 %) |
5517 (5.35 %) |
15680 (5.4 %) |
| meta_json_conforms_to_known_spec | META.json does not conform to any recognised META Spec. (defined in Module::CPANTS::Kwalitee::MetaYML) |
151 (0.53 %) |
675 (0.65 %) |
1523 (0.52 %) |
| meta_json_is_parsable | The META.json file of this distribution could not be parsed by the version of JSON parser CPANTS is using. (defined in Module::CPANTS::Kwalitee::MetaYML) |
22 (0.08 %) |
70 (0.07 %) |
131 (0.05 %) |
| meta_yml_conforms_to_known_spec | META.yml does not conform to any recognised META.yml Spec. (defined in Module::CPANTS::Kwalitee::MetaYML) |
1495 (5.26 %) |
5484 (5.32 %) |
20341 (7.01 %) |
| meta_yml_is_parsable | The META.yml file of this distribution could not be parsed by the version of CPAN::Meta::YAML.pm CPANTS is using. (defined in Module::CPANTS::Kwalitee::MetaYML) |
79 (0.28 %) |
256 (0.25 %) |
1262 (0.43 %) |
| no_broken_auto_install | This distribution uses an old version of Module::Install. Versions of Module::Install prior to 0.89 do not detect correctly that CPAN/CPANPLUS shell is used. (defined in Module::CPANTS::Kwalitee::BrokenInstaller) |
210 (0.74 %) |
827 (0.8 %) |
3387 (1.17 %) |
| no_broken_module_install | This distribution uses an obsolete version of Module::Install. Versions of Module::Install prior to 0.61 might not work on some systems at all. Additionally if your Makefile.PL uses the 'auto_install()' feature, you need at least version 0.64. Also, 1.04 is known to be broken. (defined in Module::CPANTS::Kwalitee::BrokenInstaller) |
161 (0.57 %) |
542 (0.53 %) |
1993 (0.69 %) |
| no_files_to_be_skipped | This distribution contains files that should be skipped by MANIFEST.SKIP. (defined in Module::CPANTS::Kwalitee::Files) |
493 (1.73 %) |
2072 (2.01 %) |
7352 (2.53 %) |
| no_generated_files | This distribution has files/directories that should be generated at build time, not distributed by the author. (defined in Module::CPANTS::SiteKwalitee::Files) |
148 (0.52 %) |
662 (0.64 %) |
1844 (0.64 %) |
| no_mymeta_files | This distribution contains MYMETA.* files which should be used only locally. This metric should be integrated into 'no_generated_files' eventually, but as MYMETA.* files are recent inventions, you might need to take special care if MANIFEST.SKIP exists in your distribution. Hence this metric. (defined in Module::CPANTS::SiteKwalitee::MyMeta) |
210 (0.74 %) |
1057 (1.02 %) |
3663 (1.26 %) |
| no_pax_headers | This distribution is archived with PAX extended headers, which may be useful under some environments, but may also make extraction fail under other environments (Archive::Tar ignores PAX information as well). (defined in Module::CPANTS::SiteKwalitee::Extraction) |
492 (1.73 %) |
1895 (1.84 %) |
2646 (0.91 %) |
| no_pod_errors | The documentation for this distribution contains syntactic errors in its POD. Note that this metric tests all .pl, .pm and .pod files, even if they are in t/. See 'pod_message' in the dist error view for more info. (defined in Module::CPANTS::SiteKwalitee::Pod) |
1276 (4.49 %) |
7617 (7.38 %) |
29577 (10.19 %) |
| no_symlinks | This distribution includes symbolic links (symlinks). This is bad, because there are operating systems that do not handle symlinks. (defined in Module::CPANTS::Kwalitee::Files) |
13 (0.05 %) |
29 (0.03 %) |
100 (0.03 %) |
| portable_filenames | This distribution has at least one file with non-portable characters in its filename, which may cause problems under some environments. (defined in Module::CPANTS::SiteKwalitee::Files) |
30 (0.11 %) |
230 (0.22 %) |
845 (0.29 %) |
| prereq_matches_use | This distribution uses a module or a dist that's not listed as a prerequisite. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
1688 (5.94 %) |
8425 (8.17 %) |
23410 (8.07 %) |
| use_strict | This distribution does not 'use strict;' (or its equivalents) in all of its modules. Note that this is not about the actual strictness of the modules. It's bad if nobody can tell whether the modules are strictly written or not, without reading the source code of your favorite clever module that actually enforces strictness. In other words, it's bad if someone feels the need to add 'use strict' to your modules. (defined in Module::CPANTS::Kwalitee::Uses) |
3022 (10.63 %) |
12878 (12.48 %) |
43263 (14.91 %) |
Extra indicators
These indicators are for less important (or more controversial) issues that you might or might not want to ignore. These are not used while calculating your ranking.
| Name | Description | Fail (Latest) |
Fail (CPAN) |
Fail (BackPAN) |
|---|---|---|---|---|
| consistent_version | This distribution has .pm files with inconsistent versions. (defined in Module::CPANTS::SiteKwalitee::Version) |
1319 (4.64 %) |
8021 (7.77 %) |
31695 (10.92 %) |
| has_known_license_in_source_file | Does not have license information in any of its source files, or the information is not recognized by Software::License (defined in Module::CPANTS::Kwalitee::License) |
4253 (14.95 %) |
14885 (14.43 %) |
50034 (17.25 %) |
| has_meta_json | The file "META.json" is missing from this distribution. META.json has better information than META.yml and is preferred by people maintaining module collections (like CPAN), for people writing installation tools, or just people who want to know some stuff about a distribution before downloading it. (defined in Module::CPANTS::Kwalitee::Files) |
9179 (32.27 %) |
36745 (35.61 %) |
125040 (43.1 %) |
| has_tests_in_t_dir | This distribution contains either a file called 'test.pl' (the old test file) or is missing a directory called 't'. This indicates that it uses the old test mechanism or it has no test-suite. (defined in Module::CPANTS::Kwalitee::Files) |
1806 (6.35 %) |
6468 (6.27 %) |
19332 (6.66 %) |
| meta_yml_declares_perl_version | This distribution does not declare the minimum perl version in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
12309 (43.28 %) |
43932 (42.58 %) |
123392 (42.53 %) |
| meta_yml_has_license | This distribution does not have a license defined in META.yml. (defined in Module::CPANTS::Kwalitee::License) |
5154 (18.12 %) |
16985 (16.46 %) |
60465 (20.84 %) |
| no_abstract_stub_in_pod | A well-known abstract stub (typically generated by an authoring tool) is found in this distribution. (defined in Module::CPANTS::Kwalitee::Pod) |
18 (0.06 %) |
104 (0.1 %) |
313 (0.11 %) |
| no_dot_dirs | This distribution has a dot directory, which most probably derives from a version control system. (defined in Module::CPANTS::SiteKwalitee::Files) |
136 (0.48 %) |
798 (0.77 %) |
1225 (0.42 %) |
| no_dot_underscore_files | This distribution has dot underscore files which may cause various problems. (defined in Module::CPANTS::SiteKwalitee::Files) |
32 (0.11 %) |
104 (0.1 %) |
436 (0.15 %) |
| no_invalid_versions | This distribution has .pm files with an invalid version. (defined in Module::CPANTS::SiteKwalitee::Version) |
121 (0.43 %) |
890 (0.86 %) |
3310 (1.14 %) |
| no_local_dirs | This distribution contains a well-known directory for local use (i.e. not suitable for a public distribution). (defined in Module::CPANTS::SiteKwalitee::Files) |
7 (0.02 %) |
34 (0.03 %) |
70 (0.02 %) |
| no_maniskip_error | This distribution's MANIFEST.SKIP has a problematic entry. (defined in Module::CPANTS::Kwalitee::Files) |
9 (0.03 %) |
61 (0.06 %) |
196 (0.07 %) |
| no_missing_files_in_provides | Provides field in the META.yml lists a file that does not found in the distribution. (defined in Module::CPANTS::Kwalitee::FindModules) |
31 (0.11 %) |
186 (0.18 %) |
453 (0.16 %) |
| no_stdin_for_prompting | This distribution is using direct call from STDIN instead of prompt(). Make sure STDIN is not used in Makefile.PL or Build.PL. (defined in Module::CPANTS::Kwalitee::Files) |
42 (0.15 %) |
508 (0.49 %) |
2817 (0.97 %) |
| no_unauthorized_packages | Apparently this distribution has unauthorized packages now. (defined in Module::CPANTS::SiteKwalitee::Permissions) |
593 (2.09 %) |
3130 (3.03 %) |
13322 (4.59 %) |
| proper_libs | There is more than one .pm file in the base dir, or the .pm files are not in lib/ directory. (defined in Module::CPANTS::Kwalitee::FindModules) |
385 (1.35 %) |
2479 (2.4 %) |
9749 (3.36 %) |
| test_prereq_matches_use | This distribution uses a module or a dist in its test suite that's not listed as a test prerequisite. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
800 (2.81 %) |
4200 (4.07 %) |
10253 (3.53 %) |
| use_warnings | This distribution does not 'use warnings;' (or its equivalents) in all of its modules. Note that this is not about that your modules actually warn when something bad happens. It's bad if nobody can tell if a module warns or not, without reading the source code of your favorite module that actually enforces warnings. In other words, it's bad if someone feels the need to add 'use warnings' to your modules. (defined in Module::CPANTS::Kwalitee::Uses) |
7019 (24.68 %) |
27660 (26.81 %) |
90749 (31.28 %) |
| valid_signature | This dist failed its Module::Signature verification and does not to install automatically through the CPAN client if Module::Signature is installed. Note: unsigned dists will automatically pass this kwalitee check. (defined in Module::CPANTS::SiteKwalitee::Signature) |
976 (3.43 %) |
4332 (4.2 %) |
11590 (3.99 %) |
Experimental indicators
These indicators are mainly for issues that are too new or too picky and there are a lot of failing distributions on the CPAN, or just to gather information. These are not used while calculating your score and ranking.
| Name | Description | Fail (Latest) |
Fail (CPAN) |
Fail (BackPAN) |
|---|---|---|---|---|
| configure_prereq_matches_use | This distribution uses a module or a dist in its Makefile.PL/Build.PL that's not listed as a configure prerequisite. (defined in Module::CPANTS::SiteKwalitee::Prereq) |
205 (0.72 %) |
978 (0.95 %) |
2690 (0.93 %) |
| has_separate_license_file | This distribution does not have a LICENSE or LICENCE file in its root directory. (defined in Module::CPANTS::Kwalitee::License) |
12090 (42.51 %) |
46137 (44.72 %) |
143641 (49.51 %) |
| meta_yml_has_provides | This distribution does not have a list of provided modules defined in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
17905 (62.95 %) |
66259 (64.22 %) |
183712 (63.32 %) |
| meta_yml_has_repository_resource | This distribution does not have a link to a repository in META.yml. (defined in Module::CPANTS::Kwalitee::MetaYML) |
9090 (31.96 %) |
34120 (33.07 %) |
107837 (37.17 %) |