feat(diagnostics): add missing local doc implementation for english

Author: NathanSnail

doc/en-us/config.md

@@ -314,6 +314,7 @@ Array<string>
 * ``"miss-symbol"``
 * ``"missing-fields"``
 * ``"missing-global-doc"``
+* ``"missing-local-doc"``
 * ``"missing-local-export-doc"``
 * ``"missing-parameter"``
 * ``"missing-return"``
@@ -504,6 +505,7 @@ object<string, string>
     * duplicate-doc-param
     * incomplete-signature-doc
     * missing-global-doc
+    * missing-local-doc
     * missing-local-export-doc
     * undefined-doc-class
     * undefined-doc-name
@@ -633,6 +635,7 @@ object<string, string>
     * duplicate-doc-param
     * incomplete-signature-doc
     * missing-global-doc
+    * missing-local-doc
     * missing-local-export-doc
     * undefined-doc-class
     * undefined-doc-name
@@ -870,6 +873,10 @@ object<string, string>
     */
     "missing-global-doc": "None",
     /*
+    Missing annotations for locals! Local functions must have a comment and annotations for all parameters and return values.
+    */
+    "missing-local-export-doc": "None",
+    /*
     Missing annotations for exported locals! Exported local functions must have a comment and annotations for all parameters and return values.
     */
     "missing-local-export-doc": "None",

locale/en-us/script.lua

@@ -126,6 +126,12 @@ DIAG_MISSING_GLOBAL_DOC_PARAM         =
 'Missing @param annotation for parameter `{}` in global function `{}`.'
 DIAG_MISSING_GLOBAL_DOC_RETURN        =
 'Missing @return annotation at index `{}` in global function `{}`.'
+DIAG_MISSING_LOCAL_DOC_COMMENT       =
+'Missing comment for local function `{}`.'
+DIAG_MISSING_LOCAL_DOC_PARAM         =
+'Missing @param annotation for parameter `{}` in local function `{}`.'
+DIAG_MISSING_LOCAL_DOC_RETURN        =
+'Missing @return annotation at index `{}` in local function `{}`.'
 DIAG_MISSING_LOCAL_EXPORT_DOC_COMMENT  =
 'Missing comment for exported local function `{}`.'
 DIAG_MISSING_LOCAL_EXPORT_DOC_PARAM    =

locale/en-us/setting.lua

@@ -411,6 +411,8 @@ config.diagnostics['invisible']             =
 'Enable diagnostics for accesses to fields which are invisible.'
 config.diagnostics['missing-global-doc']    =
 'Missing annotations for globals! Global functions must have a comment and annotations for all parameters and return values.'
+config.diagnostics['missing-local-doc'] =
+'Missing annotations for locals! Local functions must have a comment and annotations for all parameters and return values.'
 config.diagnostics['missing-local-export-doc'] =
 'Missing annotations for exported locals! Exported local functions must have a comment and annotations for all parameters and return values.'
 config.diagnostics['missing-parameter']     =

script/core/diagnostics/missing-local-doc.lua

@@ -0,0 +1,27 @@
+local files  = require 'files'
+local guide  = require 'parser.guide'
+local await  = require 'await'
+local helper = require 'core.diagnostics.helper.missing-doc-helper'
+
+---@async
+return function (uri, callback)
+    local state = files.getState(uri)
+
+    if not state then
+        return
+    end
+
+    if not state.ast then
+        return
+    end
+
+    ---@async
+    guide.eachSourceType(state.ast, 'function', function (source)
+        await.delay()
+
+        if source.parent.type ~= 'local' then return end
+
+        helper.CheckFunction(source, callback, 'DIAG_MISSING_LOCAL_DOC_COMMENT', 'DIAG_MISSING_LOCAL_DOC_PARAM',
+            'DIAG_MISSING_LOCAL_DOC_RETURN')
+    end)
+end

script/proto/diagnostic.lua

@@ -106,6 +106,7 @@ m.register {
 m.register {
     'incomplete-signature-doc',
     'missing-global-doc',
+    'missing-local-doc',
     'missing-local-export-doc',
 } {
     group    = 'luadoc',

test/diagnostics/init.lua

@@ -101,6 +101,7 @@ check 'invisible'
 check 'lowercase-global'
 check 'missing-fields'
 check 'missing-global-doc'
+check 'missing-local-doc'
 check 'missing-local-export-doc'
 check 'missing-parameter'
 check 'missing-return-value'

test/diagnostics/missing-local-doc.lua

@@ -0,0 +1,17 @@
+TEST [[
+local <!function fl0()
+end!>
+
+---comment
+local function fl1()
+end
+]]
+
+TEST [[
+local function fl0(<!p!>)
+end
+
+---@param p integer
+local function fl1(p)
+end
+]]