Mercurial > vim

comparison src/testdir/test_cmd_lists.vim @ 30837:82c3677f8af1 v9.0.0753

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 9.0.0753: some Ex commands are not in the help index Commit: https://github.com/vim/vim/commit/b77bdce120d7e140d0d0bd535ec9febdef78993d Author: Yee Cheng Chin <ychin.git@gmail.com> Date: Sat Oct 15 10:22:19 2022 +0100 patch 9.0.0753: some Ex commands are not in the help index Problem: Some Ex commands are not in the help index. Solution: Add the missing commands. Add a script to check all Ex commands are in the help index. (Yee Cheng Chin, closes #11371)
author Bram Moolenaar <Bram@vim.org>
date Sat, 15 Oct 2022 11:30:07 +0200
parents
children 2ddb98b138b5
comparison
equal deleted inserted replaced
30836:11e7cb28f830 30837:82c3677f8af1
1 " Test to verify that the cmd list in runtime/doc/index.txt contains all of
2 " the commands in src/ex_cmds.h. It doesn't map the other way round because
3 " index.txt contains some shorthands like :!! which are useful to list, but
4 " they don't exist as an independent entry in src/ex_cmds.h.
5 "
6 " Currently this just checks for existence, and we aren't checking for whether
7 " they are sorted in the index, or whether the substring needed (e.g.
8 " 'defc[ompile]') is correct or not.
9
10 func Test_cmd_lists()
11
12 " Create a list of the commands in ex_cmds.h:CMD_index.
13 enew!
14 read ../ex_cmds.h
15 1,/^enum CMD_index$/d
16 call search('^};$')
17 .,$d
18 v/^EXCMD/d
19 %s/^.*"\(\S\+\)".*$/\1/
20 " Special case ':*' because it's represented as ':star'
21 %s/^\*$/star/
22 sort u
23 let l:command_list = getline(1, '$')
24
25 " Verify that the ':help ex-cmd-index' list contains all known commands.
26 enew!
27 if filereadable('../../doc/index.txt')
28 " unpacked MS-Windows zip archive
29 read ../../doc/index.txt
30 else
31 read ../../runtime/doc/index.txt
32 endif
33 call search('\*ex-cmd-index\*')
34 1,.d
35 v/^|:/d
36 %s/^|:\(\S*\)|.*/\1/
37 sort u
38 norm gg
39 let l:missing_cmds = []
40 for cmd in l:command_list
41 " Reserved Vim 9 commands or other script-only syntax aren't useful to
42 " document as Ex commands.
43 let l:vim9cmds = [
44 \ 'abstract',
45 \ 'class',
46 \ 'endclass',
47 \ 'endenum',
48 \ 'endinterface',
49 \ 'enum',
50 \ 'interface',
51 \ 'static',
52 \ 'type',
53 \ '++',
54 \ '--',
55 \ '{',
56 \ '}']
57 if index(l:vim9cmds, cmd) != -1
58 continue
59 endif
60
61 if search('^\V' .. cmd .. '\v$', 'cW') == 0
62 call add(l:missing_cmds, ':' .. cmd)
63 endif
64 endfor
65 call assert_equal(0, len(l:missing_cmds), "Missing commands from `:help ex-cmd-index`: " .. string(l:missing_cmds))
66 endfunc
67
68 " vim: shiftwidth=2 sts=2 expandtab