blob: 58ccb6abba66f9b69299b2ac840804adfe88da79 [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
Christian Brabandtb147d312023-09-01 17:58:35 +010031 PerformCheck(fname, ' \t', 'space before Tab', '')
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000032
Christian Brabandtb147d312023-09-01 17:58:35 +010033 PerformCheck(fname, '\s$', 'trailing white space', '')
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000034
35 # some files don't stick to the Vim style rules
36 if fname =~ 'iscygpty.c'
37 continue
38 endif
39
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000040 var skip = 'getline(".") =~ "condition) {" || getline(".") =~ "vimglob_func" || getline(".") =~ "{\"" || getline(".") =~ "{\\d" || getline(".") =~ "{{{"'
Christian Brabandtb147d312023-09-01 17:58:35 +010041 PerformCheck(fname, ')\s*{', 'curly after closing paren', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000042
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000043 # Examples in comments use double quotes.
44 skip = "getline('.') =~ '\"'"
Bram Moolenaarbf630112023-05-19 21:41:02 +010045
Christian Brabandtb147d312023-09-01 17:58:35 +010046 PerformCheck(fname, '}\s*else', 'curly before "else"', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000047
Christian Brabandtb147d312023-09-01 17:58:35 +010048 PerformCheck(fname, 'else\s*{', 'curly after "else"', skip)
Bram Moolenaarc9471b12023-05-09 15:00:00 +010049
Christian Brabandtb147d312023-09-01 17:58:35 +010050 PerformCheck(fname, '\<\(if\|while\|for\)(', 'missing white space after "if"/"while"/"for"', skip)
Bram Moolenaarebfec1c2023-01-22 21:14:53 +000051 endfor
52
53 bwipe!
54enddef
55
Bram Moolenaar94722c52023-01-28 19:19:03 +000056def Test_test_files()
57 for fname in glob('*.vim', 0, 1)
Bram Moolenaarabc81302023-06-04 16:55:27 +010058 g:ignoreSwapExists = 'e'
Bram Moolenaar94722c52023-01-28 19:19:03 +000059 exe 'edit ' .. fname
60
61 # some files intentionally have misplaced white space
62 if fname =~ 'test_cindent.vim' || fname =~ 'test_join.vim'
63 continue
64 endif
65
66 # skip files that are known to have a space before a tab
67 if fname !~ 'test_comments.vim'
68 && fname !~ 'test_listchars.vim'
69 && fname !~ 'test_visual.vim'
70 cursor(1, 1)
Christian Brabandt22105fd2024-07-15 20:51:11 +020071 var skip = 'getline(".") =~ "codestyle: ignore"'
72 var lnum = search(fname =~ "test_regexp_latin" ? '[^รก] \t' : ' \t', 'W', 0, 0, skip)
Bram Moolenaarabc81302023-06-04 16:55:27 +010073 ReportError('testdir/' .. fname, lnum, 'space before Tab')
Bram Moolenaar94722c52023-01-28 19:19:03 +000074 endif
75
76 # skip files that are known to have trailing white space
77 if fname !~ 'test_cmdline.vim'
78 && fname !~ 'test_let.vim'
79 && fname !~ 'test_tagjump.vim'
80 && fname !~ 'test_vim9_cmd.vim'
81 cursor(1, 1)
82 var lnum = search(
83 fname =~ 'test_vim9_assign.vim' ? '[^=]\s$'
84 : fname =~ 'test_vim9_class.vim' ? '[^)]\s$'
85 : fname =~ 'test_vim9_script.vim' ? '[^,:3]\s$'
86 : fname =~ 'test_visual.vim' ? '[^/]\s$'
87 : '[^\\]\s$')
Bram Moolenaarabc81302023-06-04 16:55:27 +010088 ReportError('testdir/' .. fname, lnum, 'trailing white space')
Bram Moolenaar94722c52023-01-28 19:19:03 +000089 endif
90 endfor
91
92 bwipe!
93enddef
94
h-eastd9509842023-02-21 13:33:17 +000095def Test_help_files()
96 var lnum: number
97 set nowrapscan
98
99 for fpath in glob('../../runtime/doc/*.txt', 0, 1)
Bram Moolenaarabc81302023-06-04 16:55:27 +0100100 g:ignoreSwapExists = 'e'
h-eastd9509842023-02-21 13:33:17 +0000101 exe 'edit ' .. fpath
102
103 var fname = fnamemodify(fpath, ":t")
104
105 # todo.txt is for developers, it's not need a strictly check
106 # version*.txt is a history and large size, so it's not checked
107 if fname == 'todo.txt' || fname =~ 'version.*\.txt'
108 continue
109 endif
110
111 # Check for mixed tabs and spaces
112 cursor(1, 1)
113 while 1
114 lnum = search('[^/] \t')
115 if fname == 'visual.txt' && getline(lnum) =~ "STRING \tjkl"
116 || fname == 'usr_27.txt' && getline(lnum) =~ "\[^\? \t\]"
117 continue
118 endif
Bram Moolenaarabc81302023-06-04 16:55:27 +0100119 ReportError(fpath, lnum, 'space before tab')
h-eastd9509842023-02-21 13:33:17 +0000120 if lnum == 0
121 break
122 endif
123 endwhile
124
125 # Check for unnecessary whitespace at the end of a line
126 cursor(1, 1)
127 while 1
128 lnum = search('[^/~\\]\s$')
129 # skip line that are known to have trailing white space
130 if fname == 'map.txt' && getline(lnum) =~ "unmap @@ $"
131 || fname == 'usr_12.txt' && getline(lnum) =~ "^\t/ \t$"
132 || fname == 'usr_41.txt' && getline(lnum) =~ "map <F4> o#include $"
133 || fname == 'change.txt' && getline(lnum) =~ "foobar bla $"
134 continue
135 endif
Bram Moolenaarabc81302023-06-04 16:55:27 +0100136 ReportError('testdir' .. fpath, lnum, 'trailing white space')
h-eastd9509842023-02-21 13:33:17 +0000137 if lnum == 0
138 break
139 endif
140 endwhile
141
Bram Moolenaarabc81302023-06-04 16:55:27 +0100142# # TODO: Check for line over 80 columns
h-eastd9509842023-02-21 13:33:17 +0000143# cursor(1, 1)
144# while 1
145# lnum = search('\%>80v.*$')
Bram Moolenaarabc81302023-06-04 16:55:27 +0100146# ReportError(fpath, lnum, 'line over 80 columns')
h-eastd9509842023-02-21 13:33:17 +0000147# if lnum == 0
148# break
149# endif
150# endwhile
151
152 endfor
153
154 set wrapscan&vim
155 bwipe!
156enddef
157
Bram Moolenaarebfec1c2023-01-22 21:14:53 +0000158
Christian Brabandt22105fd2024-07-15 20:51:11 +0200159" vim: shiftwidth=2 sts=2 expandtab nofoldenable