node package manager

cpan-distributions-list

CPAN Distributions List

Build Status Coverage Status License

Display a list of CPAN distributions and related information for a specified Perl author.

Getting Started

Download the production version or the development version.

Add the following in your HEAD section:

<script src="libs/jquery/jquery.js"></script>
<script src="dist/cpan-distributions-list.min.js"></script>
<script>
    $('#cpan_distributions').createDistributionsList(
        {
            pause_id: "AUBERTG",
            github_id: "guillaumeaubert",
        }
    );
</script> 

Add the following to your BODY section:

<table id="cpan_distributions">
    <thead>
        <th>Distribution</th>
        <th>Current Version</th>
        <th>Links</th>
        <th>Build Status</th>
        <th>Test Coverage</th>
    </thead>
    <tbody>
        <tr style="display: none;" class="template">
            <td class="distribution"><!-- Name of the distribution --></td>
            <td class="version"><!-- Current version of the distribution --></td>
            <td class="links">
                <span class="github"><!-- GitHub link --></span>
                |
                <span class="metacpan"><!-- MetaCPAN link --></span>
                |
                <span class="cpants"><!-- CPANTS link --></span>
            </td>
            <td class="travis_status_badge"><!-- Travis CI - badge to indicate build status --></td>
            <td class="coveralls_badge"><!-- Coveralls.io - badge to indicate test coverage percentage --></td>
        </tr>
    </tbody>
</table>

Documentation

createDistributionsList() accepts the following arguments:

Argument Default Description
pause_id AUBERTG A PAUSE author ID.
github_id guillaumeaubert The corresponding GitHub ID, where the repositories for all the distributions are located.
coveralls true Control the display of the Coveralls.io badges for all distributions.
travis_ci true Control the display of the Travis-CI badge.
repository_lowercase false By default, this plugin expects the name of the repositories on GitHub to match the name of the distributions, case included. If you have chosen to lowercase the name of the distribution for the repository names, set this argument to true.
repositories {} Hash associating a distribution name with a corresponding repository on GitHub. This is useful if the repository name does not match the distribution name.
template_row this.find('tr.template:first') This plugin uses a hidden tr row as a template to clone and display each distribution. Changing this value allows sharing the same template across different tables, for example.

Development

  1. Install Node.JS.

  2. Install Grunt.

  3. Clone the repository: git clone git@github.com:guillaumeaubert/jquery-cpan-distributions-list.git

  4. Install the project dependencies: cd jquery-cpan-distributions-list && npm install

  5. Run Grunt to check the files and rebuild: grunt

Copyright

Copyright (C) 2013-2016 Guillaume Aubert

License

This software is released under the MIT license. See the LICENSE file for details.