@typespec/library-linter 0.44.0 → 0.45.0-dev.1

package/dist/src/lib.d.ts

@@ -7,21 +7,36 @@ export declare const libDef: {
                 readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
             };
         };
+        readonly "missing-signature": {
+            readonly severity: "warning";
+            readonly messages: {
+                readonly default: import("@typespec/compiler").CallableMessage<["decName", "decName"]>;
+            };
+        };
     };
 };
 declare const lib: import("@typespec/compiler").TypeSpecLibrary<{
     "missing-namespace": {
         readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
     };
+    "missing-signature": {
+        readonly default: import("@typespec/compiler").CallableMessage<["decName", "decName"]>;
+    };
 }, Record<string, any>>;
-export declare const reportDiagnostic: <C extends "missing-namespace", M extends keyof {
+export declare const reportDiagnostic: <C extends "missing-namespace" | "missing-signature", M extends keyof {
     "missing-namespace": {
         readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
     };
+    "missing-signature": {
+        readonly default: import("@typespec/compiler").CallableMessage<["decName", "decName"]>;
+    };
 }[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
     "missing-namespace": {
         readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
     };
+    "missing-signature": {
+        readonly default: import("@typespec/compiler").CallableMessage<["decName", "decName"]>;
+    };
 }, C, M>) => void;
 export type OpenAPILibrary = typeof lib;
 export {};

package/dist/src/lib.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;CAUT,CAAC;AACX,QAAA,MAAM,GAAG;;;;uBAAgC,CAAC;AAC1C,eAAO,MAAQ,gBAAgB;;;;;;;;iBAAQ,CAAC;AAExC,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,CAAC"}
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;CAgBT,CAAC;AACX,QAAA,MAAM,GAAG;;;;;;;uBAAgC,CAAC;AAC1C,eAAO,MAAQ,gBAAgB;;;;;;;;;;;;;;iBAAQ,CAAC;AAExC,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,CAAC"}

package/dist/src/lib.js

@@ -8,6 +8,12 @@ export const libDef = {
                 default: paramMessage `${"type"} '${"name"}' is not in a namespace. This is bad practice for a published library.`,
             },
         },
+        "missing-signature": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Decorator function $${"decName"} is missing a decorator declaration. Add "extern dec ${"decName"}(...args);" to the library tsp.`,
+            },
+        },
     },
 };
 const lib = createTypeSpecLibrary(libDef);

package/dist/src/lib.js.map

@@ -1 +1 @@
-{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE;QACX,mBAAmB,EAAE;YACnB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,GAAG,MAAM,KAAK,MAAM,wEAAwE;aAClH;SACF;KACF;CACO,CAAC;AACX,MAAM,GAAG,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC"}
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE;QACX,mBAAmB,EAAE;YACnB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,GAAG,MAAM,KAAK,MAAM,wEAAwE;aAClH;SACF;QACD,mBAAmB,EAAE;YACnB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,uBAAuB,SAAS,wDAAwD,SAAS,iCAAiC;aACxJ;SACF;KACF;CACO,CAAC;AACX,MAAM,GAAG,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC"}

package/dist/src/linter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,OAAO,EAAqB,MAAM,oBAAoB,CAAC;AAG3E,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,QAI3C"}
+{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,OAAO,EAAsC,MAAM,oBAAoB,CAAC;AAG5F,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,QAK3C"}

package/dist/src/linter.js

@@ -1,7 +1,9 @@
+import { SyntaxKind } from "@typespec/compiler";
 import { reportDiagnostic } from "./lib.js";
 export function $onValidate(program) {
     const root = program.checker.getGlobalNamespaceType();
     validateNoExportAtRoot(program, root);
+    validateDecoratorSignature(program);
 }
 function validateNoExportAtRoot(program, root) {
     var _a, _b;
@@ -37,4 +39,32 @@ function validateNoExportAtRoot(program, root) {
         }
     }
 }
+const excludeDecoratorSignature = new Set([
+    "@docFromComment",
+    "@indexer",
+    "@test",
+    "@list",
+    "@resourceTypeForKeyParam", // TODO check if we actually need this one https://github.com/microsoft/typespec/issues/1981
+]);
+function validateDecoratorSignature(program) {
+    function navigate(sym) {
+        var _a, _b;
+        if (sym.flags & 16384 /* SymbolFlags.Decorator */) {
+            const hasSignature = sym.declarations.some((x) => x.kind === SyntaxKind.DecoratorDeclarationStatement);
+            if (!hasSignature && !excludeDecoratorSignature.has(sym.name)) {
+                reportDiagnostic(program, {
+                    code: "missing-signature",
+                    format: { decName: sym.name.slice(1) },
+                    target: sym,
+                });
+            }
+        }
+        for (const exp of (_b = (_a = sym.exports) === null || _a === void 0 ? void 0 : _a.values()) !== null && _b !== void 0 ? _b : []) {
+            navigate(exp);
+        }
+    }
+    for (const jsFile of program.jsSourceFiles.values()) {
+        navigate(jsFile.symbol);
+    }
+}
 //# sourceMappingURL=linter.js.map

package/dist/src/linter.js.map

@@ -1 +1 @@
-{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAQ,CAAC,sBAAsB,EAAE,CAAC;IAEvD,sBAAsB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAgB,EAAE,IAAe;;IAC/D,SAAS,WAAW,CAAC,KAA4C;;QAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;YACjC,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE,EAAE;gBAClD,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;SACJ;IACH,CAAC;IACD,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEzB,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,0CAAE,OAAO,EAAE,mCAAI,EAAE,EAAE;QACnE,IAAI,GAAG,CAAC,KAAK,oCAAwB,EAAE;YACrC,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE;gBACnC,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;aAAM,IAAI,GAAG,CAAC,KAAK,oCAAuB,EAAE;YAC3C,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE;gBAClC,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;KACF;AACH,CAAC"}
+{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,UAAU,EAAQ,MAAM,oBAAoB,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,UAAU,WAAW,CAAC,OAAgB;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAQ,CAAC,sBAAsB,EAAE,CAAC;IAEvD,sBAAsB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACtC,0BAA0B,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAgB,EAAE,IAAe;;IAC/D,SAAS,WAAW,CAAC,KAA4C;;QAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;YACjC,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE,EAAE;gBAClD,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;SACJ;IACH,CAAC;IACD,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEzB,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,0CAAE,OAAO,EAAE,mCAAI,EAAE,EAAE;QACnE,IAAI,GAAG,CAAC,KAAK,oCAAwB,EAAE;YACrC,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE;gBACnC,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;aAAM,IAAI,GAAG,CAAC,KAAK,oCAAuB,EAAE;YAC3C,gBAAgB,CAAC,OAAO,EAAE;gBACxB,IAAI,EAAE,mBAAmB;gBACzB,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE;gBAClC,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;SACJ;KACF;AACH,CAAC;AAED,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC;IACxC,iBAAiB;IACjB,UAAU;IACV,OAAO;IACP,OAAO;IACP,0BAA0B,EAAE,4FAA4F;CACzH,CAAC,CAAC;AACH,SAAS,0BAA0B,CAAC,OAAgB;IAClD,SAAS,QAAQ,CAAC,GAAQ;;QACxB,IAAI,GAAG,CAAC,KAAK,oCAAwB,EAAE;YACrC,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,6BAA6B,CAC3D,CAAC;YACF,IAAI,CAAC,YAAY,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBAC7D,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,mBAAmB;oBACzB,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;oBACtC,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAC;aACJ;SACF;QACD,KAAK,MAAM,GAAG,IAAI,MAAA,MAAA,GAAG,CAAC,OAAO,0CAAE,MAAM,EAAE,mCAAI,EAAE,EAAE;YAC7C,QAAQ,CAAC,GAAG,CAAC,CAAC;SACf;IACH,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE;QACnD,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KACzB;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/library-linter",
-  "version": "0.44.0",
+  "version": "0.45.0-dev.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for linting another library.",
   "homepage": "https://microsoft.github.io/typespec",
@@ -42,13 +42,13 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "~0.44.0"
+    "@typespec/compiler": "~0.44.0 || >=0.45.0-dev <0.45.0"
   },
   "devDependencies": {
     "@types/mocha": "~10.0.0",
     "@types/node": "~18.11.9",
-    "@typespec/compiler": "~0.44.0",
-    "@typespec/eslint-config-typespec": "~0.7.0",
+    "@typespec/compiler": "~0.44.0 || >=0.45.0-dev <0.45.0",
+    "@typespec/eslint-config-typespec": "~0.7.0 || >=0.8.0-dev <0.8.0",
     "eslint": "^8.36.0",
     "mocha": "~10.2.0",
     "mocha-junit-reporter": "~2.2.0",
@@ -57,6 +57,7 @@
     "rimraf": "~5.0.0",
     "typescript": "~5.0.2"
   },
+  "dependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
     "build": "tsc -p .",