File: HACKING.md

package info (click to toggle)
pgbadger 11.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,452 kB
  • sloc: javascript: 22,274; perl: 20,588; sh: 4; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,487 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Contributing on pgBadger

Thanks for your attention on pgBadger ! You need Perl Module JSON::XS
to run the full test suite. You can install it on a Debian like system
using:

    sudo apt-get install libjson-xs-perl

or in RPM like system using:

    sudo yum install perl-JSON-XS

pgBadger has a TAP compatible test suite executed by `prove`:

    $ prove
    t/01_lint.t ......... ok   
    t/02_basics.t ....... ok   
    t/03_consistency.t .. ok   
    All tests successful.
    Files=3, Tests=13,  6 wallclock secs ( 0.01 usr  0.01 sys +  5.31 cusr  0.16 csys =  5.49 CPU)
    Result: PASS
    $

or if you prefer to run test manually:

    $ perl Makefile.PL && make test
    Checking if your kit is complete...
    Looks good
    Generating a Unix-style Makefile
    Writing Makefile for pgBadger
    Writing MYMETA.yml and MYMETA.json
    cp pgbadger blib/script/pgbadger
    "/usr/bin/perl" -MExtUtils::MY -e 'MY->fixin(shift)' -- blib/script/pgbadger
    PERL_DL_NONLAZY=1 "/usr/bin/perl" "-MExtUtils::Command::MM" "-MTest::Harness" "-e" "undef *Test::Harness::Switches; test_harness(0, 'blib/lib', 'blib/arch')" t/*.t
    t/01_lint.t ......... ok   
    t/02_basics.t ....... ok   
    t/03_consistency.t .. ok   
    All tests successful.
    Files=3, Tests=13,  6 wallclock secs ( 0.03 usr  0.00 sys +  5.39 cusr  0.14 csys =  5.56 CPU)
    Result: PASS
    $ make clean && rm Makefile.old

Please contribute a regression test when you fix a bug or add a feature. Thanks!