@typespec/eslint-plugin 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,22 @@
+# TypeSpec Eslint Plugin
+
+## Installation
+
+Install the package as a dev dependency.
+
+```
+npm install -D @typespec/eslint-plugin
+```
+
+## Usage
+
+Add the following to your eslint config
+
+```yaml
+plugins: ["@typespec/eslint-plugin"],
+extends: ["plugin:@typespec/eslint-plugin/recommended"],
+```
+
+## Rules
+
+- [call-decorator](./docs/rules/call-decorator.md)

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+export declare const rules: {
+    "call-decorator": import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleModule<"default" | "suggestReplaceWithContextCall", never[], import("@typescript-eslint/utils/dist/ts-eslint/Rule.js").RuleListener>;
+};
+export declare const configs: {
+    recommended: {
+        rules: {
+            "@typespec/call-decorator": string;
+        };
+    };
+};
+//# 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":"AAEA,eAAO,MAAM,KAAK;;CAEjB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;;CAMnB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.rules = void 0;
+const call_decorator_js_1 = require("./rules/call-decorator.js");
+exports.rules = {
+    "call-decorator": call_decorator_js_1.callDecoratorRule,
+};
+exports.configs = {
+    recommended: {
+        rules: {
+            "@typespec/call-decorator": "warn",
+        },
+    },
+};
+//# 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,iEAA8D;AAEjD,QAAA,KAAK,GAAG;IACnB,gBAAgB,EAAE,qCAAiB;CACpC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,WAAW,EAAE;QACX,KAAK,EAAE;YACL,0BAA0B,EAAE,MAAM;SACnC;KACF;CACF,CAAC"}

package/dist/src/rules/call-decorator.d.ts

@@ -0,0 +1,3 @@
+import { TSESLint } from "@typescript-eslint/utils";
+export declare const callDecoratorRule: TSESLint.RuleModule<"default" | "suggestReplaceWithContextCall", never[], TSESLint.RuleListener>;
+//# sourceMappingURL=call-decorator.d.ts.map

package/dist/src/rules/call-decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-decorator.d.ts","sourceRoot":"","sources":["../../../src/rules/call-decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,QAAQ,EAAY,MAAM,0BAA0B,CAAC;AAS3E,eAAO,MAAM,iBAAiB,kGAkD5B,CAAC"}

package/dist/src/rules/call-decorator.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callDecoratorRule = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const typescript_1 = __importDefault(require("typescript"));
+const utils_js_1 = require("../utils.js");
+const messages = {
+    default: "Use context.call to call a TypeSpec decorator function.",
+    suggestReplaceWithContextCall: "Replace with context.call",
+};
+exports.callDecoratorRule = (0, utils_js_1.createRule)({
+    create(context) {
+        const parserServices = utils_1.ESLintUtils.getParserServices(context);
+        const checker = parserServices.program.getTypeChecker();
+        return {
+            CallExpression(node) {
+                if (node.callee.type === utils_1.TSESTree.AST_NODE_TYPES.Identifier) {
+                    const functionName = node.callee.name;
+                    if (functionName.startsWith("$")) {
+                        const tsNode = parserServices.esTreeNodeToTSNodeMap.get(node);
+                        const signature = checker.getResolvedSignature(tsNode);
+                        if (signature === undefined) {
+                            return;
+                        }
+                        if (isTypeSpecFunctionSignature(checker, signature, tsNode)) {
+                            context.report({
+                                messageId: "default",
+                                node,
+                                suggest: [
+                                    {
+                                        messageId: "suggestReplaceWithContextCall",
+                                        fix: (fixer) => {
+                                            return [
+                                                fixer.replaceText(node.callee, `context.call`),
+                                                fixer.replaceText(node.arguments[0], functionName),
+                                            ];
+                                        },
+                                    },
+                                ],
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+    name: "call-decorator",
+    meta: {
+        docs: {
+            description: "Calling a TypeSpec decorator from JS/TS code should be done with context.call",
+            recommended: "warn",
+        },
+        hasSuggestions: true,
+        messages,
+        type: "suggestion",
+        schema: [],
+    },
+    defaultOptions: [],
+});
+function isTypeSpecFunctionSignature(checker, signature, tsNode) {
+    if (signature.parameters.length < 2) {
+        return false;
+    }
+    const contextParameter = signature.parameters[0];
+    const contextParamType = checker.getTypeOfSymbolAtLocation(contextParameter, tsNode);
+    if (contextParamType.flags & typescript_1.default.TypeFlags.StructuredType &&
+        contextParamType.symbol.name === "DecoratorContext") {
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=call-decorator.js.map

package/dist/src/rules/call-decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-decorator.js","sourceRoot":"","sources":["../../../src/rules/call-decorator.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2E;AAC3E,4DAA4B;AAC5B,0CAAyC;AAEzC,MAAM,QAAQ,GAAG;IACf,OAAO,EAAE,yDAAyD;IAClE,6BAA6B,EAAE,2BAA2B;CAC3D,CAAC;AAEW,QAAA,iBAAiB,GAAG,IAAA,qBAAU,EAAiC;IAC1E,MAAM,CAAC,OAAO;QACZ,MAAM,cAAc,GAAG,mBAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACxD,OAAO;YACL,cAAc,CAAC,IAAI;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,gBAAQ,CAAC,cAAc,CAAC,UAAU,EAAE;oBAC3D,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;oBACtC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;wBAChC,MAAM,MAAM,GAAG,cAAc,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;wBAE9D,MAAM,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;wBACvD,IAAI,SAAS,KAAK,SAAS,EAAE;4BAC3B,OAAO;yBACR;wBAED,IAAI,2BAA2B,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE;4BAC3D,OAAO,CAAC,MAAM,CAAC;gCACb,SAAS,EAAE,SAAS;gCACpB,IAAI;gCACJ,OAAO,EAAE;oCACP;wCACE,SAAS,EAAE,+BAA+B;wCAC1C,GAAG,EAAE,CAAC,KAAK,EAAsB,EAAE;4CACjC,OAAO;gDACL,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC;gDAC9C,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;6CACnD,CAAC;wCACJ,CAAC;qCACF;iCACF;6BACF,CAAC,CAAC;yBACJ;qBACF;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,gBAAgB;IACtB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,WAAW,EAAE,+EAA+E;YAC5F,WAAW,EAAE,MAAM;SACpB;QACD,cAAc,EAAE,IAAI;QACpB,QAAQ;QACR,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;CACnB,CAAC,CAAC;AAEH,SAAS,2BAA2B,CAClC,OAAuB,EACvB,SAAuB,EACvB,MAAe;IAEf,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QACnC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,OAAO,CAAC,yBAAyB,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IACrF,IACE,gBAAgB,CAAC,KAAK,GAAG,oBAAE,CAAC,SAAS,CAAC,cAAc;QACpD,gBAAgB,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB,EACnD;QACA,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+export declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string, TRuleListener extends import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener = import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>>) => import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<TMessageIds, TOptions, TRuleListener>;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGvD,eAAO,MAAM,UAAU,ybAGtB,CAAC"}

package/dist/src/utils.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRule = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+// TODO get rule url
+exports.createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/microsoft/typespec/tree/main/packages/eslint-plugin-typespec/docs/rules/${name}.md`);
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAAA,oDAAuD;AAEvD,oBAAoB;AACP,QAAA,UAAU,GAAG,mBAAW,CAAC,WAAW,CAC/C,CAAC,IAAI,EAAE,EAAE,CACP,8FAA8F,IAAI,KAAK,CAC1G,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@typespec/eslint-plugin",
+  "version": "0.41.0",
+  "author": "Microsoft Corporation",
+  "description": "Eslint plugin providing set of rules to be used in the JS/TS code of TypeSpec libraries",
+  "homepage": "https://microsoft.github.io/typespec",
+  "readme": "https://github.com/Microsoft/typespec/blob/main/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": "commonjs",
+  "main": "dist/src/index.js",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "lib/*.tsp",
+    "dist/**",
+    "!dist/test/**"
+  ],
+  "peerDependencies": {
+    "eslint": ">=0.8.0"
+  },
+  "devDependencies": {
+    "@types/mocha": "~10.0.0",
+    "@types/node": "~18.11.9",
+    "@typespec/eslint-config-typespec": "~0.6.0",
+    "@typescript-eslint/parser": "^5.30.7",
+    "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"
+  },
+  "dependencies": {
+    "@typescript-eslint/utils": "~5.26.0"
+  },
+  "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"
+  }
+}