@typespec/library-linter 0.41.0

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,24 @@
+# TypeSpec Library Linter
+
+## Installation
+
+Install the package as a dev dependency.
+
+```
+npm install -D @typespec/library-linter
+```
+
+## Usage
+
+Compile your library package. Any errors or warnings will be reported as typespec diagnostics.
+
+```bash
+# At the root of your typespec library.
+tsp compile . --import @typespec/library-linter
+```
+
+## TypeSpec Library Best rules and best practices
+
+| Rule name           | Description                                                                                                      |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `missing-namespace` | Validate that every exported element from the library(Models, JS functions, operations, etc.) is in a namespace. |

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./linter.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from "./linter.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/src/lib.d.ts

@@ -0,0 +1,28 @@
+export declare const libDef: {
+    readonly name: "@typespec/library-linter";
+    readonly diagnostics: {
+        readonly "missing-namespace": {
+            readonly severity: "warning";
+            readonly messages: {
+                readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
+            };
+        };
+    };
+};
+declare const lib: import("@typespec/compiler").TypeSpecLibrary<{
+    "missing-namespace": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
+    };
+}, Record<string, any>>;
+export declare const reportDiagnostic: <C extends "missing-namespace", M extends keyof {
+    "missing-namespace": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
+    };
+}[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
+    "missing-namespace": {
+        readonly default: import("@typespec/compiler").CallableMessage<["type", "name"]>;
+    };
+}, C, M>) => void;
+export type OpenAPILibrary = typeof lib;
+export {};
+//# sourceMappingURL=lib.d.ts.map

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

@@ -0,0 +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"}

package/dist/src/lib.js

@@ -0,0 +1,15 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+export const libDef = {
+    name: "@typespec/library-linter",
+    diagnostics: {
+        "missing-namespace": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `${"type"} '${"name"}' is not in a namespace. This is bad practice for a published library.`,
+            },
+        },
+    },
+};
+const lib = createTypeSpecLibrary(libDef);
+export const { reportDiagnostic } = lib;
+//# sourceMappingURL=lib.js.map

package/dist/src/lib.js.map

@@ -0,0 +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"}

package/dist/src/linter.d.ts

@@ -0,0 +1,3 @@
+import { Program } from "@typespec/compiler";
+export declare function $onValidate(program: Program): void;
+//# sourceMappingURL=linter.d.ts.map

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

@@ -0,0 +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"}

package/dist/src/linter.js

@@ -0,0 +1,40 @@
+import { reportDiagnostic } from "./lib.js";
+export function $onValidate(program) {
+    const root = program.checker.getGlobalNamespaceType();
+    validateNoExportAtRoot(program, root);
+}
+function validateNoExportAtRoot(program, root) {
+    var _a, _b;
+    function validateFor(items) {
+        var _a;
+        for (const type of items.values()) {
+            reportDiagnostic(program, {
+                code: "missing-namespace",
+                format: { type: type.kind, name: (_a = type.name) !== null && _a !== void 0 ? _a : "" },
+                target: type,
+            });
+        }
+    }
+    validateFor(root.models);
+    validateFor(root.interfaces);
+    validateFor(root.enums);
+    validateFor(root.operations);
+    validateFor(root.unions);
+    for (const [name, sym] of (_b = (_a = root.node.symbol.exports) === null || _a === void 0 ? void 0 : _a.entries()) !== null && _b !== void 0 ? _b : []) {
+        if (sym.flags & 16384 /* SymbolFlags.Decorator */) {
+            reportDiagnostic(program, {
+                code: "missing-namespace",
+                format: { type: "Decorator", name },
+                target: sym,
+            });
+        }
+        else if (sym.flags & 131072 /* SymbolFlags.Function */) {
+            reportDiagnostic(program, {
+                code: "missing-namespace",
+                format: { type: "Function", name },
+                target: sym,
+            });
+        }
+    }
+}
+//# sourceMappingURL=linter.js.map

package/dist/src/linter.js.map

@@ -0,0 +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"}

package/dist/src/testing/index.d.ts

@@ -0,0 +1,3 @@
+import { TypeSpecTestLibrary } from "@typespec/compiler/testing";
+export declare const LibraryLinterTestLibrary: TypeSpecTestLibrary;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGpF,eAAO,MAAM,wBAAwB,EAAE,mBAGrC,CAAC"}

package/dist/src/testing/index.js

@@ -0,0 +1,8 @@
+import { resolvePath } from "@typespec/compiler";
+import { createTestLibrary } from "@typespec/compiler/testing";
+import { fileURLToPath } from "url";
+export const LibraryLinterTestLibrary = createTestLibrary({
+    name: "@typespec/library-linter",
+    packageRoot: resolvePath(fileURLToPath(import.meta.url), "../../../../"),
+});
+//# sourceMappingURL=index.js.map

package/dist/src/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAuB,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,CAAC,MAAM,wBAAwB,GAAwB,iBAAiB,CAAC;IAC7E,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC;CACzE,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@typespec/library-linter",
+  "version": "0.41.0",
+  "author": "Microsoft Corporation",
+  "description": "TypeSpec library for linting another library.",
+  "homepage": "https://microsoft.github.io/typespec",
+  "readme": "https://github.com/Microsoft/typespec/blob/master/README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Microsoft/typespec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Microsoft/typespec/issues"
+  },
+  "keywords": [
+    "typespec"
+  ],
+  "type": "module",
+  "main": "dist/src/index.js",
+  "exports": {
+    ".": "./dist/src/index.js",
+    "./testing": "./dist/src/testing/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/src/index.d.ts"
+      ],
+      "testing": [
+        "./dist/src/testing/index.d.ts"
+      ]
+    }
+  },
+  "tspMain": "dist/src/index.js",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "lib/*.tsp",
+    "dist/**",
+    "!dist/test/**"
+  ],
+  "peerDependencies": {
+    "@typespec/compiler": "~0.41.0"
+  },
+  "devDependencies": {
+    "@types/mocha": "~10.0.0",
+    "@types/node": "~18.11.9",
+    "@typespec/compiler": "~0.41.0",
+    "@typespec/eslint-config-typespec": "~0.6.0",
+    "eslint": "^8.12.0",
+    "mocha": "~10.1.0",
+    "mocha-junit-reporter": "~2.2.0",
+    "mocha-multi-reporters": "~1.5.1",
+    "c8": "~7.12.0",
+    "rimraf": "~3.0.2",
+    "typescript": "~4.9.3"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist ./temp",
+    "build": "tsc -p .",
+    "watch": "tsc -p . --watch",
+    "test": "mocha",
+    "test-official": "c8 mocha --forbid-only --reporter mocha-multi-reporters",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "lint:fix": "eslint . --fix --ext .ts"
+  }
+}