From 1ab5ee6ef4b0b018b36b4b9712dcf1d90ddda4bf Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Mon, 30 Oct 2017 18:22:51 +1300 Subject: Add a `lint-vim` target for linting Vim config Since I know there's a usable tool for this now in vim-vint, I may as well make a target for my own convenience later. Updated the README.markdown documentation of the `lint-*` targets, restructuring the paragraph into a nested list for clarity. Also updated the `dotfiles(7)` manual page to reflect those changes. --- Makefile | 5 +++++ README.md | 18 ++++++++++++++---- lint/vim.sh | 5 +++++ man/man7/dotfiles.7df | 34 ++++++++++++++++++++++++++++++---- 4 files changed, 54 insertions(+), 8 deletions(-) create mode 100644 lint/vim.sh diff --git a/Makefile b/Makefile index 01e58ba8..314c2a2b 100644 --- a/Makefile +++ b/Makefile @@ -66,6 +66,7 @@ lint-ksh \ lint-sh \ lint-urxvt \ + lint-vim \ lint-xinit .SUFFIXES: @@ -570,6 +571,7 @@ lint: lint-bash \ lint-ksh \ lint-sh \ lint-urxvt \ + lint-vim \ lint-xinit lint-bash: check-bash @@ -590,5 +592,8 @@ lint-sh: check-sh lint-urxvt: check-urxvt sh lint/urxvt.sh +lint-vim: + sh lint/vim.sh + lint-xinit: check-xinit sh lint/xinit.sh diff --git a/README.md b/README.md index 56407e8c..20a67a37 100644 --- a/README.md +++ b/README.md @@ -584,10 +584,20 @@ You can check that both sets of shell scripts are syntactically correct with the scripts in `bin` and `games`. There's no proper test suite for the actual functionality (yet). -If you have [ShellCheck](https://www.shellcheck.net/) and/or -[Perl::Critic](http://perlcritic.com/), there's a `lint` target for the shell -script files and Perl files respectively. The files don't need to pass that -check to be installed. +There are also optional `lint` targets, if you have the appropriate tools +available to run them: + +* [ShellCheck](https://www.shellcheck.net/): + * `lint-bash` + * `lint-bin` + * `lint-games` + * `lint-ksh` + * `lint-sh` + * `lint-xinit` +* [Perl::Critic](https://perlcritic.com/): + * `lint-urxvt` +* [Vint](https://github.com/Kuniwak/vint): + * `lint-vim` Known issues ------------ diff --git a/lint/vim.sh b/lint/vim.sh new file mode 100644 index 00000000..6714ac9a --- /dev/null +++ b/lint/vim.sh @@ -0,0 +1,5 @@ +for v in vim/* ; do + [ "$v" != vim/bundle ] || continue + printf '%s\n' "$v" + vint -s -- "$v" +done diff --git a/man/man7/dotfiles.7df b/man/man7/dotfiles.7df index 6ddacd5d..91b4b841 100644 --- a/man/man7/dotfiles.7df +++ b/man/man7/dotfiles.7df @@ -921,10 +921,36 @@ with \f[C]make\ check\-bash\f[], \f[C]make\ check\-sh\f[], or \f[C]bin\f[] and \f[C]games\f[]. There's no proper test suite for the actual functionality (yet). .PP -If you have ShellCheck (https://www.shellcheck.net/) and/or -Perl::Critic (http://perlcritic.com/), there's a \f[C]lint\f[] target -for the shell script files and Perl files respectively. -The files don't need to pass that check to be installed. +There are also optional \f[C]lint\f[] targets, if you have the +appropriate tools available to run them: +.IP \[bu] 2 +ShellCheck (https://www.shellcheck.net/): +.RS 2 +.IP \[bu] 2 +\f[C]lint\-bash\f[] +.IP \[bu] 2 +\f[C]lint\-bin\f[] +.IP \[bu] 2 +\f[C]lint\-games\f[] +.IP \[bu] 2 +\f[C]lint\-ksh\f[] +.IP \[bu] 2 +\f[C]lint\-sh\f[] +.IP \[bu] 2 +\f[C]lint\-xinit\f[] +.RE +.IP \[bu] 2 +Perl::Critic (https://perlcritic.com/): +.RS 2 +.IP \[bu] 2 +\f[C]lint\-urxvt\f[] +.RE +.IP \[bu] 2 +Vint (https://github.com/Kuniwak/vint): +.RS 2 +.IP \[bu] 2 +\f[C]lint\-vim\f[] +.RE .SS Known issues .PP See ISSUES.markdown. -- cgit v1.2.3