Add doc errors for decorators and decorator parameters.

Author: tjprescott

.vscode/launch.json

@@ -145,6 +145,28 @@
       "sourceMaps": true,
       "skipFiles": ["<node_internals>/**/*.js"],
       "cwd": "C:/Github/Sandbox/playground/cadl/migrate/0.37"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug library linter",
+      "program": "${workspaceFolder}/packages/compiler/dist/core/cli/cli.js",
+      "args": [
+        "compile",
+        "../samples/scratch",
+        "--import=E:/repos/typespec/packages/library-linter"
+      ],
+      "smartStep": true,
+      "sourceMaps": true,
+      "skipFiles": ["<node_internals>/**/*.js"],
+      "outFiles": [
+        "${workspaceFolder}/packages/*/dist/**/*.js",
+        "${workspaceFolder}/packages/*/dist-dev/**/*.js"
+      ],
+      "cwd": "${workspaceFolder}/packages/compiler",
+      "presentation": {
+        "order": 2
+      }
     }
   ],
   "compounds": [

packages/library-linter/src/lib.ts

@@ -9,6 +9,13 @@ export const libDef = {
         default: paramMessage`${"type"} '${"name"}' is not in a namespace. This is bad practice for a published library.`,
       },
     },
+    "missing-documentation": {
+      severity: "warning",
+      messages: {
+        decorator: paramMessage`Decorator ${"decorator"} is missing documentation.`,
+        decoratorParam: paramMessage`Decorator param ${"param"} is missing documentation.`,
+      },
+    },
   },
 } as const;
 const lib = createTypeSpecLibrary(libDef);

packages/library-linter/src/linter.ts

@@ -5,6 +5,7 @@ export function $onValidate(program: Program) {
   const root = program.checker!.getGlobalNamespaceType();
 
   validateNoExportAtRoot(program, root);
+  validateDocumentation(program, root);
 }
 
 function validateNoExportAtRoot(program: Program, root: Namespace) {
@@ -39,3 +40,7 @@ function validateNoExportAtRoot(program: Program, root: Namespace) {
     }
   }
 }
+
+function validateDocumentation(program: Program, root: Namespace) {
+  let test = "best";
+}