Skip to content

Commit

Permalink
xtools.1, README: add xshellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
classabbyamp committed May 19, 2023
1 parent 30611dc commit da3b09f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,12 @@ COMMANDS
xrs pattern
– like xbps-query -Rs, but take cwd repo into account

xshellcheck template | pkgname | :pkgname | :
– scan XBPS template for common shell mistakes. Requires
shellcheck(1).
- use ‘:pkgname’ to lint template as staged in the git index
- use ‘:’ to lint all templates staged in the git index

xsrc pkg
– list source files for XBPS template

Expand Down
2 changes: 1 addition & 1 deletion xshellcheck
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ for argument; do
$XSHELLCHECK_ARGS \
-xa "${void_packages}/common/scripts/template_shellcheck_shim" || ret="$?"
fi
done | $filter
done
exit $ret
14 changes: 14 additions & 0 deletions xtools.1
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,20 @@ to read templates from stdin.
.Nd list packages shlib-dependent on package or its subpackages
.It Nm xrs Ar pattern
.Nd like xbps-query -Rs, but take cwd repo into account
.It Nm xshellcheck Ar template | pkgname | Cm \&: Ns Ar pkgname | Cm \&:
.Nd scan XBPS template for common shell mistakes.
Requires
.Xr shellcheck 1 .
.Bl -dash -offset 0n -width 0n -compact
.It
use
.Sq Cm \&: Ns Ar pkgname
to lint template as staged in the git index
.It
use
.Sq Cm \&:
to lint all templates staged in the git index
.El
.It Nm xsrc Ar pkg
.Nd list source files for XBPS template
.It Nm xsubpkg \
Expand Down

0 comments on commit da3b09f

Please sign in to comment.