scriptkitties/perl6-dist-helper

A Perl 6 module to assist in dealing with dists

perl6-dist-helper's Issues

Add a QA sub

This sub would run various quality assurance checks on a module source to report what a module could use to improve its release. See Release::Checklist for some prior art. Some things to check for include:

• Good module name (first-level namespaces are generally bad)
• Tests
  • Are there tests
  • Do the tests succeed
• Does installation of the module succeed
• Documentation
  • A README with
    • Synopsis
    • Examples
    • Copyright information
  • A correct META6.json
    • Presence of some optional but useful fields
    • No unused dependencies
    • Dependency version adverbs
    • Version using a SemVer capable approach
      (I understand not everyone is a huge fan of it as I am, but I've yet to find a better versioning scheme, and assixt can be a little opinionated on its QA. If there are better schemes out there, I'd like to hear, though.)
  • POD blocks for each sub and argument
• Clean tree
  • Use version control to check for lingering files
• Tree meta files
  • Check for a CHANGELOG
  • Check for a LICENSE

Add a USAGE to generate prettier help on the commandline

Validate the SPDX license identifier used in the new command

Quite possibly, the easiest solution would be to create a seperate module for this. If such a module were to be made, and have licenses and their headers available as well, cpan6 could use these to generate a default LICENSE file and add license headers to all other files in the project.

Make `new` also write a `.travis.yml`

Add clean command

This should remove all files referenced by META6.json, but no longer exist, and remove all references in META6.json of files that no longer exist.

Add `upload` command

A command that accepts a .tar.gz file, and uploads it to PAUSE.

`zef install App::Cpan6` fails

App::Cpan6 currently fails to install because of an unoptimal META6.json.

See here: ugexe/zef#211 (comment)
for an explanation of what's wrong.

This is the original error:

-bash-4.4$ zef install App::Cpan6

===> Searching for: App::Cpan6                                                                                    
Use of uninitialized value of type Any in string context.
Methods .^name, .perl, .gist, or .say can be used to stringify it to something meaningful.                        
  in block  at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/C99D66B88914FE999500CE1FA4F
1216BDBA53BE2 (Zef::Client) line 124                     
Use of uninitialized value @identities of type Any in string context.                                             
Methods .^name, .perl, .gist, or .say can be used to stringify it to something meaningful.                        
  in block  at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/C99D66B88914FE999500CE1FA4F
1216BDBA53BE2 (Zef::Client) line 136                     
===> Searching for missing dependencies:                 
No such method 'starts-with' for invocant of type 'Any'  
  in method candidates at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/618E55C192A9FD29
1ABD2BE1F2C756E915C0A4BC (Zef::Repository) line 9        
  in method find-candidates at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/C99D66B8891
4FE999500CE1FA4F1216BDBA53BE2 (Zef::Client) line 108     
  in block  at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/C99D66B88914FE999500CE1FA4F
1216BDBA53BE2 (Zef::Client) line 139                     
  in sub MAIN at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/sources/0396F9D56BBCF5F8CF25C8759
D77D03AEF745931 (Zef::CLI) line 137                      
  in block <unit> at /home/patrick/.rakudobrew/moar-2017.10/install/share/perl6/site/resources/95699F546D28C01BF68
BD7A836D7D12FFB0B2943 line 1                             
  in sub MAIN at /home/patrick/.rakudobrew/bin/../moar-2017.10/install/share/perl6/site/bin/zef line 2            
  in block <unit> at /home/patrick/.rakudobrew/bin/../moar-2017.10/install/share/perl6/site/bin/zef line 2

Add `push` command

Same as doing a release and upload command.

Add a `bootstrap` command to assist the user in generating a config file

Add a command to allow use of cpan6 bootstrap config. This will ask input for all configuration options, and then save the configuration file.

Update the `readme.adoc` file

The readme is currently out of date, it must be updated.

Update dependencies to have minimum versions

Some dependencies used in cpan6 require a minimum version due to some features used of those modules. The META6 should be updated to reflect these minimum versions, so that zef will install the right version.

Add unit tests

Sort entries in `put-meta` sub

This should result in less changes in the META6.json file, since the lists will always be sorted. Currently the order of arrays and objects are random after turning the %meta hash into a json string.

Clean up the code base

Use the SemVer module to deal with the version bumping

Add `bootstrap meta author [add]` command to add authors to the META6 easily

Allow multiple arguments to `depend`

Split off the App::Cpan6::Input into a seperate module

META file requests dependencies on broken modules

The META file locks the dependency on 0.9.6 version of JSON::Fast, which has numerous bugs, including reliance on a Rakudo bug that's fixed in latest Rakudo.

For that reason, this module won't be installable on Rakudo 2018.03 and later.

Add a README file

This repository currently lacks a README. To help possible users and contributors, one should be added.

Add 'build-meta' command to build a META6.json from the current directory

This should scan the current directory for a lib, bin and resources directory and generate a META6.json file from those. This could be used to create distributable modules from existing projects that did not have a META6.json yet.

Generate a manpage from the readme

The readme.adoc could be transformed into a manpage. This could be installed on cpan6 bootstrap man for instance, unless there's a nicer way to let zef do that automatically on installation.