From 1248c12666dc4d8fb801c2a8dbc355027f8f9bbe Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Mon, 24 Oct 2022 13:24:08 +0200
Subject: ci(lintcommit): enforce common scope names #20393

This is useful to ensure related commits aren't spread out when
generating the changelog.
---
 scripts/lintcommit.lua | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'scripts/lintcommit.lua')

diff --git a/scripts/lintcommit.lua b/scripts/lintcommit.lua
index 16326cfe66..87a8e62503 100644
--- a/scripts/lintcommit.lua
+++ b/scripts/lintcommit.lua
@@ -86,11 +86,28 @@ local function validate_commit(commit_message)
       vim.inspect(allowed_types))
   end
 
-  -- Check if scope is empty
+  -- Check if scope is appropriate
   if before_colon:match("%(") then
     local scope = vim.trim(before_colon:match("%((.*)%)"))
+
     if scope == '' then
-      return [[Scope can't be empty.]]
+      return [[Scope can't be empty]]
+    end
+
+    if vim.startswith(scope, "nvim_") then
+        return [[Scope should be "api" instead of "nvim_..."]]
+    end
+
+    local alternative_scope = {
+      ['filetype.vim'] = 'filetype',
+      ['filetype.lua'] = 'filetype',
+      ['tree-sitter'] = 'treesitter',
+      ['ts'] = 'treesitter',
+      ['hl'] = 'highlight',
+    }
+
+    if alternative_scope[scope] then
+      return ('Scope should be "%s" instead of "%s"'):format(alternative_scope[scope], scope)
     end
   end
 
-- 
cgit