|
| 1 | +-- Validate commit message. Designed to be run as pre-commit hook and in CI. |
| 2 | + |
| 3 | +local allowed_commit_types = { 'ci', 'docs', 'feat', 'fix', 'refactor', 'style', 'test' } |
| 4 | + |
| 5 | +local allowed_scopes = { 'ALL' } |
| 6 | +for _, module in ipairs(vim.fn.readdir('lua/mini')) do |
| 7 | + if module ~= 'init.lua' then table.insert(allowed_scopes, module:match('^(.+)%.lua$')) end |
| 8 | +end |
| 9 | + |
| 10 | +local validate_first_line = function(line) |
| 11 | + -- Allow starting with 'fixup' to disable commit linting |
| 12 | + if vim.startswith(line, 'fixup') then return true, nil end |
| 13 | + |
| 14 | + -- Should match overall conventional commit spec |
| 15 | + local commit_type, scope, desc = string.match(line, '^([^(]+)(%b())!?: (.+)$') |
| 16 | + if commit_type == nil then |
| 17 | + commit_type, desc = string.match(line, '^([^!:]+)!?: (.+)$') |
| 18 | + end |
| 19 | + if commit_type == nil or desc == nil then |
| 20 | + return false, 'First line does not match conventional commit specification: ' .. vim.inspect(line) |
| 21 | + end |
| 22 | + |
| 23 | + -- Commit type should be present and be from one of allowed |
| 24 | + if not vim.tbl_contains(allowed_commit_types, commit_type) then |
| 25 | + local one_of = table.concat(vim.tbl_map(vim.inspect, allowed_commit_types), ', ') |
| 26 | + return false, 'Commit type ' .. vim.inspect(commit_type) .. ' is not allowed. Use one of ' .. one_of .. '.' |
| 27 | + end |
| 28 | + |
| 29 | + -- Scope, if present, should be from one of allowed |
| 30 | + if scope ~= nil then |
| 31 | + scope = scope:sub(2, -2) |
| 32 | + if not vim.tbl_contains(allowed_scopes, scope) then |
| 33 | + local one_of = table.concat(vim.tbl_map(vim.inspect, allowed_scopes), ', ') |
| 34 | + return false, 'Scope ' .. vim.inspect(scope) .. ' is not allowed. Use one of ' .. one_of .. '.' |
| 35 | + end |
| 36 | + end |
| 37 | + |
| 38 | + -- Description should be present and properly formatted |
| 39 | + if string.find(desc, '^%w') == nil then |
| 40 | + return false, 'Description should start with alphanumeric character: ' .. vim.inspect(desc) |
| 41 | + end |
| 42 | + |
| 43 | + if string.find(desc, '^%u%l') ~= nil then |
| 44 | + return false, 'Description should not start with capitalized word: ' .. vim.inspect(desc) |
| 45 | + end |
| 46 | + |
| 47 | + if string.find(desc, '%p$') ~= nil then |
| 48 | + return false, 'Description should not end with punctuation: ' .. vim.inspect(desc) |
| 49 | + end |
| 50 | + |
| 51 | + -- Main title should not be too long |
| 52 | + if vim.fn.strdisplaywidth(line) > 72 then |
| 53 | + return false, 'First line is longer than 72 characters: ' .. vim.inspect(desc) |
| 54 | + end |
| 55 | + |
| 56 | + return true, nil |
| 57 | +end |
| 58 | + |
| 59 | +local validate_body = function(parts) |
| 60 | + if #parts == 1 then return true, nil end |
| 61 | + |
| 62 | + if parts[2] ~= '' then return false, 'Second line should be empty' end |
| 63 | + if parts[3] == nil then return false, 'If first line is not enough, body should be present' end |
| 64 | + if string.find(parts[3], '^%S') == nil then return false, 'First body line should not start with whitespace.' end |
| 65 | + |
| 66 | + for i = 3, #parts do |
| 67 | + if vim.fn.strdisplaywidth(parts[i]) > 80 then |
| 68 | + return false, 'Body line is longer than 80 characters: ' .. vim.inspect(parts[i]) |
| 69 | + end |
| 70 | + end |
| 71 | + |
| 72 | + if string.find(parts[#parts], '^%s*$') ~= nil then return false, 'Body should not end with blank line.' end |
| 73 | + |
| 74 | + return true, nil |
| 75 | +end |
| 76 | + |
| 77 | +local validate_bad_wording = function(msg) |
| 78 | + local has_fix = msg:find('[Ff]ix #') or msg:find('[Ff]ixes #') or msg:find('[Ff]ixed #') |
| 79 | + local has_bad_close = msg:find('[Cc]lose[sd]? #') ~= nil |
| 80 | + local has_bad_resolve = msg:find('[Rr]esolve[sd] #') ~= nil |
| 81 | + if has_fix or has_bad_close or has_bad_resolve then |
| 82 | + return false, 'Commit message should use "Resolve #" GitHub keyword to resolve issue/PR.' |
| 83 | + end |
| 84 | + return true, nil |
| 85 | +end |
| 86 | + |
| 87 | +_G.validate_commit_msg = function(msg) |
| 88 | + msg = msg:gsub('\n$', '') |
| 89 | + local parts = vim.split(msg, '\n') |
| 90 | + local is_valid, err_msg |
| 91 | + |
| 92 | + -- Validate main (first) line |
| 93 | + is_valid, err_msg = validate_first_line(parts[1]) |
| 94 | + if not is_valid then return is_valid, err_msg end |
| 95 | + |
| 96 | + -- Validate body |
| 97 | + is_valid, err_msg = validate_body(parts) |
| 98 | + if not is_valid then return is_valid, err_msg end |
| 99 | + |
| 100 | + -- No validation for footer |
| 101 | + |
| 102 | + -- Should not contain bad wording |
| 103 | + is_valid, err_msg = validate_bad_wording(msg) |
| 104 | + if not is_valid then return is_valid, err_msg end |
| 105 | + |
| 106 | + return true, nil |
| 107 | +end |
| 108 | + |
| 109 | +-- Tests to be run interactively: `_G.test_cases_failed` should be empty. |
| 110 | +local test_cases = { |
| 111 | + -- First line |
| 112 | + ['fixup'] = true, |
| 113 | + ['fixup: commit message'] = true, |
| 114 | + ['fixup! commit message'] = true, |
| 115 | + |
| 116 | + ['ci: normal message'] = true, |
| 117 | + ['docs: normal message'] = true, |
| 118 | + ['feat: normal message'] = true, |
| 119 | + ['fix: normal message'] = true, |
| 120 | + ['refactor: normal message'] = true, |
| 121 | + ['style: normal message'] = true, |
| 122 | + ['test: normal message'] = true, |
| 123 | + |
| 124 | + ['feat(ai): message with scope'] = true, |
| 125 | + ['feat!: message with breaking change'] = true, |
| 126 | + ['feat(ai)!: message with scope and breaking change'] = true, |
| 127 | + ['style(ALL): style all modules'] = true, |
| 128 | + |
| 129 | + ['unknown: unknown type'] = false, |
| 130 | + ['feat(unknown): unknown scope'] = false, |
| 131 | + ['refactor(): empty scope'] = false, |
| 132 | + ['ci( ): whitespace as scope'] = false, |
| 133 | + |
| 134 | + ['ci no colon after type'] = false, |
| 135 | + [': no type before colon 1'] = false, |
| 136 | + [' : no type before colon 2'] = false, |
| 137 | + [' : no type before colon 3'] = false, |
| 138 | + ['ci:'] = false, |
| 139 | + ['ci: '] = false, |
| 140 | + ['ci: '] = false, |
| 141 | + |
| 142 | + ['feat: message with : in it'] = true, |
| 143 | + ['feat(ai): message with : in it'] = true, |
| 144 | + |
| 145 | + ['test: extra space after colon'] = false, |
| 146 | + ['ci: tab after colon'] = false, |
| 147 | + ['ci:no space after colon'] = false, |
| 148 | + ['ci : extra space before colon'] = false, |
| 149 | + |
| 150 | + ['ci: period at end of sentence.'] = false, |
| 151 | + ['ci: punctuation at end of sentence!'] = false, |
| 152 | + ['ci: Capitalized first word'] = false, |
| 153 | + ['ci: UPPER_CASE First Word'] = true, |
| 154 | + ['ci: very very very very very very very very very very looooong first line'] = false, |
| 155 | + |
| 156 | + -- Body |
| 157 | + ['ci: desc\n\nBody'] = true, |
| 158 | + ['ci: desc\n\nBody\n\nwith\n \nempty and blank lines'] = true, |
| 159 | + |
| 160 | + ['ci: desc\nSecond line is not empty'] = false, |
| 161 | + ['ci: desc\n\n First body line starts with whitespace'] = false, |
| 162 | + ['ci: desc\n\nBody\nwith\nVery very very very very very very very very very very very very loong first line'] = false, |
| 163 | + |
| 164 | + ['ci: only two lines\n\n'] = false, |
| 165 | + ['ci: desc\n\nLast line is empty\n\n'] = false, |
| 166 | + ['ci: desc\n\nLast line is blank\n '] = false, |
| 167 | + |
| 168 | + -- Footer |
| 169 | + -- No validation for footer |
| 170 | + |
| 171 | + -- Bad wordings |
| 172 | + ['ci: this has Fixed #1'] = false, |
| 173 | + ['ci: this has fixed #1'] = false, |
| 174 | + ['ci: this Fixes #1'] = false, |
| 175 | + ['ci: this fixes #1'] = false, |
| 176 | + ['ci: this will Fix #1'] = false, |
| 177 | + ['ci: this will fix #1'] = false, |
| 178 | + ['ci: this has Closed #1'] = false, |
| 179 | + ['ci: this has closed #1'] = false, |
| 180 | + ['ci: this Closes #1'] = false, |
| 181 | + ['ci: this closes #1'] = false, |
| 182 | + ['ci: this will Close #1'] = false, |
| 183 | + ['ci: this will close #1'] = false, |
| 184 | + ['ci: this has Resolved #1'] = false, |
| 185 | + ['ci: this has resolved #1'] = false, |
| 186 | + ['ci: this Resolves #1'] = false, |
| 187 | + ['ci: this resolves #1'] = false, |
| 188 | + |
| 189 | + ['ci: desc\n\nthis has Fixed #1'] = false, |
| 190 | + ['ci: desc\n\nthis has fixed #1'] = false, |
| 191 | + ['ci: desc\n\nthis Fixes #1'] = false, |
| 192 | + ['ci: desc\n\nthis fixes #1'] = false, |
| 193 | + ['ci: desc\n\nthis will Fix #1'] = false, |
| 194 | + ['ci: desc\n\nthis will fix #1'] = false, |
| 195 | + ['ci: desc\n\nthis has Closed #1'] = false, |
| 196 | + ['ci: desc\n\nthis has closed #1'] = false, |
| 197 | + ['ci: desc\n\nthis Closes #1'] = false, |
| 198 | + ['ci: desc\n\nthis closes #1'] = false, |
| 199 | + ['ci: desc\n\nthis will Close #1'] = false, |
| 200 | + ['ci: desc\n\nthis will close #1'] = false, |
| 201 | + ['ci: desc\n\nthis has Resolved #1'] = false, |
| 202 | + ['ci: desc\n\nthis has resolved #1'] = false, |
| 203 | + ['ci: desc\n\nthis Resolves #1'] = false, |
| 204 | + ['ci: desc\n\nthis resolves #1'] = false, |
| 205 | +} |
| 206 | + |
| 207 | +_G.test_cases_failed = {} |
| 208 | +for message, expected in pairs(test_cases) do |
| 209 | + local is_valid = _G.validate_commit_msg(message) |
| 210 | + if is_valid ~= expected then |
| 211 | + table.insert(_G.test_cases_failed, { msg = message, expected = expected, actual = is_valid }) |
| 212 | + end |
| 213 | +end |
0 commit comments