.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Debian::PkgJs::SimpleAudit 3pm"
.TH Debian::PkgJs::SimpleAudit 3pm 2024-05-16 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Debian::PkgJS::SimpleAudit \- Perl module to get security advisories
from NPM registry
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Debian::PkgJS::SimpleAudit;
\&  
\&  my $audit = advisories(\*(Aq/path/to/nodejs/module\*(Aq);
\&  # OR
\&  my $audit = advisories(\*(Aq@babel/runtime\*(Aq, \*(Aq0.7.16\*(Aq);
\&  
\&  if($audit) {
\&      print STDERR $audit;
\&      exit 1;
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Debian::PkgJS::SimpleAudit provides a single function to get security
advisories from NPM registry.
.SS EXPORT
.IX Subsection "EXPORT"
.IP \fBadvisories()\fR 4
.IX Item "advisories()"
This function build a query to get all NPM security advisories for the
given JS module. It returns a string in the same format than "\f(CW\*(C`npm audit\*(C'\fR"
\&\fI(empty if no advisories are available)\fR.
.Sp
\&\fBadvisories()\fR takes one or two arguments:
.RS 4
.IP "\fBadvisories('/path/to/module')\fR: use name and version found in package.json \fI(or package.yaml)\fR." 4
.IX Item "advisories('/path/to/module'): use name and version found in package.json (or package.yaml)."
.PD 0
.IP "\fBadvisories($name,$version)\fR: use given module name and version" 4
.IX Item "advisories($name,$version): use given module name and version"
.RE
.RS 4
.RE
.PD
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright Yadd <yadd@debian.org>
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
On Debian systems, the complete text of version 2 of the GNU General
Public License can be found in `/usr/share/common\-licenses/GPL\-2'.
If not, see <http://www.gnu.org/licenses/>.