blob: 83f52ef34cd6032bacf113f1bee3c8785c30b93c [file] [log] [blame]
Bram Moolenaarebfec1c2023-01-22 21:14:53 +00001" Test for checking the source code style.
2
Bram Moolenaarabc81302023-06-04 16:55:27 +01003def s:ReportError(fname: string, lnum: number, msg: string)
4 if lnum > 0
5 assert_report(fname .. ' line ' .. lnum .. ': ' .. msg)
6 endif
7enddef
8
Christian Brabandtb147d312023-09-01 17:58:35 +01009def s:PerformCheck(fname: string, pattern: string, msg: string, skip: string)
John Marriott78d742a2024-04-02 20:26:01 +020010 var prev_lnum = 1
Christian Brabandtb147d312023-09-01 17:58:35 +010011 var lnum = 1
12 while (lnum > 0)
13 cursor(lnum, 1)
14 lnum = search(pattern, 'W', 0, 0, skip)
John Marriott78d742a2024-04-02 20:26:01 +020015 if (prev_lnum == lnum)
16 break
17 endif
18 prev_lnum = lnum
Christian Brabandtb147d312023-09-01 17:58:35 +010019 if (lnum > 0)
John Marriott78d742a2024-04-02 20:26:01 +020020 ReportError(fname, lnum, msg)
Christian Brabandtb147d312023-09-01 17:58:35 +010021 endif
22 endwhile
23enddef
24
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000025def Test_source_files()
Christian Brabandtb147d312023-09-01 17:58:35 +010026 for fname in glob('../*.[ch]', 0, 1) + ['../xxd/xxd.c']
Bram Moolenaarbf630112023-05-19 21:41:02 +010027 bwipe!
Bram Moolenaarabc81302023-06-04 16:55:27 +010028 g:ignoreSwapExists = 'e'
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000029 exe 'edit ' .. fname
30
Ken Takatac8a582a2024-07-20 11:55:13 +020031 # Some files are generated files and may contain space errors.
32 if fname =~ 'dlldata.c'
33 || fname =~ 'if_ole.h'
34 || fname =~ 'iid_ole.c'
35 continue
36 endif
37
Christian Brabandtb147d312023-09-01 17:58:35 +010038 PerformCheck(fname, ' \t', 'space before Tab', '')
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000039
Christian Brabandtb147d312023-09-01 17:58:35 +010040 PerformCheck(fname, '\s$', 'trailing white space', '')
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000041
42 # some files don't stick to the Vim style rules
43 if fname =~ 'iscygpty.c'
44 continue
45 endif
46
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000047 var skip = 'getline(".") =~ "condition) {" || getline(".") =~ "vimglob_func" || getline(".") =~ "{\"" || getline(".") =~ "{\\d" || getline(".") =~ "{{{"'
Christian Brabandtb147d312023-09-01 17:58:35 +010048 PerformCheck(fname, ')\s*{', 'curly after closing paren', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000049
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000050 # Examples in comments use double quotes.
51 skip = "getline('.') =~ '\"'"
Bram Moolenaarbf630112023-05-19 21:41:02 +010052
Christian Brabandtb147d312023-09-01 17:58:35 +010053 PerformCheck(fname, '}\s*else', 'curly before "else"', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000054
Christian Brabandtb147d312023-09-01 17:58:35 +010055 PerformCheck(fname, 'else\s*{', 'curly after "else"', skip)
Bram Moolenaarc9471b12023-05-09 15:00:00 +010056
Christian Brabandtb147d312023-09-01 17:58:35 +010057 PerformCheck(fname, '\<\(if\|while\|for\)(', 'missing white space after "if"/"while"/"for"', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000058 endfor
59
60 bwipe!
61enddef
62
Bram Moolenaar94722c52023-01-28 19:19:03 +000063def Test_test_files()
64 for fname in glob('*.vim', 0, 1)
Bram Moolenaarabc81302023-06-04 16:55:27 +010065 g:ignoreSwapExists = 'e'
Bram Moolenaar94722c52023-01-28 19:19:03 +000066 exe 'edit ' .. fname
67
68 # some files intentionally have misplaced white space
69 if fname =~ 'test_cindent.vim' || fname =~ 'test_join.vim'
70 continue
71 endif
72
73 # skip files that are known to have a space before a tab
74 if fname !~ 'test_comments.vim'
75 && fname !~ 'test_listchars.vim'
76 && fname !~ 'test_visual.vim'
77 cursor(1, 1)
Christian Brabandt22105fd2024-07-15 20:51:11 +020078 var skip = 'getline(".") =~ "codestyle: ignore"'
79 var lnum = search(fname =~ "test_regexp_latin" ? '[^รก] \t' : ' \t', 'W', 0, 0, skip)
Bram Moolenaarabc81302023-06-04 16:55:27 +010080 ReportError('testdir/' .. fname, lnum, 'space before Tab')
Bram Moolenaar94722c52023-01-28 19:19:03 +000081 endif
82
83 # skip files that are known to have trailing white space
84 if fname !~ 'test_cmdline.vim'
85 && fname !~ 'test_let.vim'
86 && fname !~ 'test_tagjump.vim'
87 && fname !~ 'test_vim9_cmd.vim'
88 cursor(1, 1)
89 var lnum = search(
90 fname =~ 'test_vim9_assign.vim' ? '[^=]\s$'
91 : fname =~ 'test_vim9_class.vim' ? '[^)]\s$'
92 : fname =~ 'test_vim9_script.vim' ? '[^,:3]\s$'
93 : fname =~ 'test_visual.vim' ? '[^/]\s$'
94 : '[^\\]\s$')
Bram Moolenaarabc81302023-06-04 16:55:27 +010095 ReportError('testdir/' .. fname, lnum, 'trailing white space')
Bram Moolenaar94722c52023-01-28 19:19:03 +000096 endif
97 endfor
98
99 bwipe!
100enddef
101
h-eastd9509842023-02-21 13:33:17 +0000102def Test_help_files()
103 var lnum: number
104 set nowrapscan
105
106 for fpath in glob('../../runtime/doc/*.txt', 0, 1)
Bram Moolenaarabc81302023-06-04 16:55:27 +0100107 g:ignoreSwapExists = 'e'
h-eastd9509842023-02-21 13:33:17 +0000108 exe 'edit ' .. fpath
109
110 var fname = fnamemodify(fpath, ":t")
111
112 # todo.txt is for developers, it's not need a strictly check
113 # version*.txt is a history and large size, so it's not checked
114 if fname == 'todo.txt' || fname =~ 'version.*\.txt'
115 continue
116 endif
117
118 # Check for mixed tabs and spaces
119 cursor(1, 1)
120 while 1
121 lnum = search('[^/] \t')
122 if fname == 'visual.txt' && getline(lnum) =~ "STRING \tjkl"
123 || fname == 'usr_27.txt' && getline(lnum) =~ "\[^\? \t\]"
124 continue
125 endif
Bram Moolenaarabc81302023-06-04 16:55:27 +0100126 ReportError(fpath, lnum, 'space before tab')
h-eastd9509842023-02-21 13:33:17 +0000127 if lnum == 0
128 break
129 endif
130 endwhile
131
132 # Check for unnecessary whitespace at the end of a line
133 cursor(1, 1)
134 while 1
135 lnum = search('[^/~\\]\s$')
136 # skip line that are known to have trailing white space
137 if fname == 'map.txt' && getline(lnum) =~ "unmap @@ $"
138 || fname == 'usr_12.txt' && getline(lnum) =~ "^\t/ \t$"
139 || fname == 'usr_41.txt' && getline(lnum) =~ "map <F4> o#include $"
140 || fname == 'change.txt' && getline(lnum) =~ "foobar bla $"
141 continue
142 endif
Bram Moolenaarabc81302023-06-04 16:55:27 +0100143 ReportError('testdir' .. fpath, lnum, 'trailing white space')
h-eastd9509842023-02-21 13:33:17 +0000144 if lnum == 0
145 break
146 endif
147 endwhile
148
Bram Moolenaarabc81302023-06-04 16:55:27 +0100149# # TODO: Check for line over 80 columns
h-eastd9509842023-02-21 13:33:17 +0000150# cursor(1, 1)
151# while 1
152# lnum = search('\%>80v.*$')
Bram Moolenaarabc81302023-06-04 16:55:27 +0100153# ReportError(fpath, lnum, 'line over 80 columns')
h-eastd9509842023-02-21 13:33:17 +0000154# if lnum == 0
155# break
156# endif
157# endwhile
158
159 endfor
160
161 set wrapscan&vim
162 bwipe!
163enddef
164
Bram Moolenaarebfec1c2023-01-22 21:14:53 +0000165
Christian Brabandt22105fd2024-07-15 20:51:11 +0200166" vim: shiftwidth=2 sts=2 expandtab nofoldenable