2021-09-19 11:06:29 -07:00
|
|
|
-- Usage:
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
-- # verbose
|
|
|
|
-- nvim -es +"lua require('scripts.lintcommit').main()"
|
|
|
|
--
|
|
|
|
-- # silent
|
|
|
|
-- nvim -es +"lua require('scripts.lintcommit').main({trace=false})"
|
|
|
|
--
|
|
|
|
-- # self-test
|
|
|
|
-- nvim -es +"lua require('scripts.lintcommit')._test()"
|
|
|
|
|
|
|
|
local M = {}
|
2021-09-19 11:06:29 -07:00
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
local _trace = false
|
2021-09-19 11:06:29 -07:00
|
|
|
|
|
|
|
-- Print message
|
|
|
|
local function p(s)
|
|
|
|
vim.cmd('set verbose=1')
|
|
|
|
vim.api.nvim_echo({{s, ''}}, false, {})
|
|
|
|
vim.cmd('set verbose=0')
|
|
|
|
end
|
|
|
|
|
|
|
|
local function die()
|
|
|
|
p('')
|
|
|
|
vim.cmd("cquit 1")
|
|
|
|
end
|
|
|
|
|
|
|
|
-- Executes and returns the output of `cmd`, or nil on failure.
|
|
|
|
--
|
|
|
|
-- Prints `cmd` if `trace` is enabled.
|
|
|
|
local function run(cmd, or_die)
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
if _trace then
|
2021-09-19 11:06:29 -07:00
|
|
|
p('run: '..vim.inspect(cmd))
|
|
|
|
end
|
|
|
|
local rv = vim.trim(vim.fn.system(cmd)) or ''
|
|
|
|
if vim.v.shell_error ~= 0 then
|
|
|
|
if or_die then
|
|
|
|
p(rv)
|
|
|
|
die()
|
|
|
|
end
|
|
|
|
return nil
|
|
|
|
end
|
|
|
|
return rv
|
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
-- Returns nil if the given commit message is valid, or returns a string
|
|
|
|
-- message explaining why it is invalid.
|
|
|
|
local function validate_commit(commit_message)
|
2021-09-19 09:27:08 -07:00
|
|
|
local commit_split = vim.split(commit_message, ":")
|
|
|
|
|
2021-11-27 09:10:48 -07:00
|
|
|
-- Return nil if the type is vim-patch since most of the normal rules don't
|
2021-09-19 09:27:08 -07:00
|
|
|
-- apply.
|
|
|
|
if commit_split[1] == "vim-patch" then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return nil
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
|
|
|
-- Check that message isn't too long.
|
|
|
|
if commit_message:len() > 80 then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return [[Commit message is too long, a maximum of 80 characters is allowed.]]
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
|
2021-09-19 09:27:08 -07:00
|
|
|
if vim.tbl_count(commit_split) < 2 then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return [[Commit message does not include colons.]]
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
|
|
|
local before_colon = commit_split[1]
|
|
|
|
local after_colon = commit_split[2]
|
|
|
|
|
|
|
|
-- Check if commit introduces a breaking change.
|
|
|
|
if vim.endswith(before_colon, "!") then
|
|
|
|
before_colon = before_colon:sub(1, -2)
|
|
|
|
end
|
|
|
|
|
|
|
|
-- Check if type is correct
|
|
|
|
local type = vim.split(before_colon, "%(")[1]
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
local allowed_types = {'build', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'test', 'chore', 'vim-patch'}
|
2021-09-19 09:27:08 -07:00
|
|
|
if not vim.tbl_contains(allowed_types, type) then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return string.format(
|
|
|
|
'Invalid commit type "%s". Allowed types are:\n %s',
|
|
|
|
type,
|
|
|
|
vim.inspect(allowed_types))
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
|
|
|
-- Check if scope is empty
|
|
|
|
if before_colon:match("%(") then
|
|
|
|
local scope = vim.trim(before_colon:match("%((.*)%)"))
|
|
|
|
if scope == '' then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return [[Scope can't be empty.]]
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
-- Check that description doesn't end with a period
|
|
|
|
if vim.endswith(after_colon, ".") then
|
2021-09-26 12:13:59 -07:00
|
|
|
return [[Description ends with a period (".").]]
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
|
|
|
-- Check that description has exactly one whitespace after colon, followed by
|
|
|
|
-- a lowercase letter and then any number of letters.
|
|
|
|
if not string.match(after_colon, '^ %l%a*') then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return [[There should be one whitespace after the colon and the first letter should lowercase.]]
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return nil
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
function M.main(opt)
|
|
|
|
_trace = not opt or not not opt.trace
|
|
|
|
|
2021-10-14 01:13:56 -07:00
|
|
|
local branch = run({'git', 'rev-parse', '--abbrev-ref', 'HEAD'}, true)
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
-- TODO(justinmk): check $GITHUB_REF
|
2021-09-19 11:06:29 -07:00
|
|
|
local ancestor = run({'git', 'merge-base', 'origin/master', branch})
|
|
|
|
if not ancestor then
|
|
|
|
ancestor = run({'git', 'merge-base', 'upstream/master', branch})
|
|
|
|
end
|
|
|
|
local commits_str = run({'git', 'rev-list', ancestor..'..'..branch}, true)
|
2021-09-19 09:27:08 -07:00
|
|
|
|
|
|
|
local commits = {}
|
|
|
|
for substring in commits_str:gmatch("%S+") do
|
|
|
|
table.insert(commits, substring)
|
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
local failed = 0
|
|
|
|
for _, commit_id in ipairs(commits) do
|
|
|
|
local msg = run({'git', 'show', '-s', '--format=%s' , commit_id})
|
2021-09-19 09:27:08 -07:00
|
|
|
if vim.v.shell_error ~= 0 then
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
p('Invalid commit-id: '..commit_id..'"')
|
|
|
|
else
|
|
|
|
local invalid_msg = validate_commit(msg)
|
|
|
|
if invalid_msg then
|
|
|
|
failed = failed + 1
|
|
|
|
p(string.format([[
|
|
|
|
Invalid commit message: "%s"
|
|
|
|
Commit: %s
|
|
|
|
%s
|
|
|
|
See also:
|
|
|
|
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
|
|
|
|
https://www.conventionalcommits.org/en/v1.0.0/
|
|
|
|
]],
|
|
|
|
msg,
|
|
|
|
commit_id,
|
|
|
|
invalid_msg))
|
|
|
|
end
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
if failed > 0 then
|
|
|
|
die() -- Exit with error.
|
|
|
|
else
|
|
|
|
p('')
|
|
|
|
end
|
|
|
|
end
|
2021-09-19 09:27:08 -07:00
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
function M._test()
|
|
|
|
-- message:expected_result
|
|
|
|
local test_cases = {
|
|
|
|
['ci: normal message'] = true,
|
|
|
|
['build: normal message'] = true,
|
|
|
|
['docs: normal message'] = true,
|
|
|
|
['feat: normal message'] = true,
|
|
|
|
['fix: normal message'] = true,
|
|
|
|
['perf: normal message'] = true,
|
|
|
|
['refactor: normal message'] = true,
|
|
|
|
['revert: normal message'] = true,
|
|
|
|
['test: normal message'] = true,
|
|
|
|
['chore: normal message'] = true,
|
|
|
|
['ci(window): message with scope'] = true,
|
|
|
|
['ci!: message with breaking change'] = true,
|
|
|
|
['ci(tui)!: message with scope and breaking change'] = true,
|
|
|
|
['vim-patch:8.2.3374: Pyret files are not recognized (#15642)'] = true,
|
|
|
|
['vim-patch:8.1.1195,8.2.{3417,3419}'] = true,
|
|
|
|
[':no type before colon 1'] = false,
|
|
|
|
[' :no type before colon 2'] = false,
|
|
|
|
[' :no type before colon 3'] = false,
|
|
|
|
['ci(empty description):'] = false,
|
|
|
|
['ci(whitespace as description): '] = false,
|
|
|
|
['docs(multiple whitespaces as description): '] = false,
|
|
|
|
['ci no colon after type'] = false,
|
|
|
|
['test: extra space after colon'] = false,
|
|
|
|
['ci: tab after colon'] = false,
|
|
|
|
['ci:no space after colon'] = false,
|
|
|
|
['ci :extra space before colon'] = false,
|
|
|
|
['refactor(): empty scope'] = false,
|
|
|
|
['ci( ): whitespace as scope'] = false,
|
|
|
|
['chore: period at end of sentence.'] = false,
|
|
|
|
['ci: Starting sentence capitalized'] = false,
|
|
|
|
['unknown: using unknown type'] = false,
|
|
|
|
['chore: you\'re saying this commit message just goes on and on and on and on and on and on for way too long?'] = false,
|
2021-09-19 09:27:08 -07:00
|
|
|
}
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
local failed = 0
|
|
|
|
for message, expected in pairs(test_cases) do
|
|
|
|
local is_valid = (nil == validate_commit(message))
|
|
|
|
if is_valid ~= expected then
|
|
|
|
failed = failed + 1
|
|
|
|
p(string.format('[ FAIL ]: expected=%s, got=%s\n input: "%s"', expected, is_valid, message))
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
if failed > 0 then
|
|
|
|
die() -- Exit with error.
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
|
2021-09-19 09:27:08 -07:00
|
|
|
end
|
|
|
|
|
build(lint): commit linter #15725
Example test failure:
$ nvim -es +"lua require('scripts.lintcommit')._test()"
[ FAIL ]: expected=true, got=false
input: ":no type before colon 1"
[ FAIL ]: expected=true, got=false
input: "ci: tab after colon"
Example main({trace=true}) output:
$ nvim -es +"lua require('scripts.lintcommit').main()"
run: { "git", "branch", "--show-current" }
run: { "git", "merge-base", "origin/master", "master" }
run: { "git", "merge-base", "upstream/master", "master" }
run: { "git", "rev-list", "89db07556dbdce97c0c150ed7e47d80e1ddacad3..master" }
run: { "git", "show", "-s", "--format=%s", "d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc" }
Invalid commit message: "buildlint): commit linter #15620"
Commit: d2e6d2f5fc93b6da3c6153229135ba2f0b24f8cc
Invalid commit type "buildlint)". Allowed types are:
{ "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "test", "chore", "vim-patch" }
See also:
https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#commit-messages
https://www.conventionalcommits.org/en/v1.0.0/
2021-09-19 12:57:57 -07:00
|
|
|
return M
|