@sapphire/eslint-plugin-result 2.0.2-next.f4ec2624.0 → 2.0.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+# [@sapphire/eslint-plugin-result@2.0.2](https://github.com/sapphiredev/utilities/compare/@sapphire/eslint-plugin-result@2.0.2...@sapphire/eslint-plugin-result@2.0.2) - (2023-12-04)
+
+## 🐛 Bug Fixes
+
+- **eslint-plugin-result:** Properly split CJS and ESM ([e357e62](https://github.com/sapphiredev/utilities/commit/e357e629a3932faf827f423736d793c02a495109))
+- **eslint-plugin-result:** Update transitive dependencies ([7878399](https://github.com/sapphiredev/utilities/commit/7878399502917fbb90af1b7c85135b2966dd43b2))
+
 # [@sapphire/eslint-plugin-result@2.0.1](https://github.com/sapphiredev/utilities/compare/@sapphire/eslint-plugin-result@2.0.0...@sapphire/eslint-plugin-result@2.0.1) - (2023-08-29)
 
 ## 🐛 Bug Fixes

package/dist/esm/index.mjs

@@ -0,0 +1,150 @@
+import { ESLintUtils, AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { isUnionType, isThenableType } from 'tsutils';
+import ts from 'typescript';
+
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+
+// src/configs/recommended.ts
+var recommendedConfig;
+var init_recommended = __esm({
+  "src/configs/recommended.ts"() {
+    recommendedConfig = {
+      plugins: ["@sapphire/eslint-plugin-result"],
+      rules: {
+        "@sapphire/result/no-discard-result": "error"
+      }
+    };
+  }
+});
+function getSapphireResultType(service, checker) {
+  const file = service.program?.getSourceFile(resultPath);
+  const resultNode = file?.statements.find((node) => ts.isTypeAliasDeclaration(node) && node.name.getText() === "Result");
+  if (resultNode) {
+    return checker.getTypeAtLocation(resultNode);
+  }
+  return null;
+}
+function unwrapPotentialPromiseType(checker, node, type = checker.getTypeAtLocation(node)) {
+  if (isUnionType(type)) {
+    const { ...copy } = type;
+    copy.types = type.types.filter((subtype) => Boolean(subtype));
+    if (copy.types.length === 1) {
+      return unwrapPotentialPromiseType(checker, node, copy.types[0]);
+    }
+    copy.types = copy.types.map((subtype) => unwrapPotentialPromiseType(checker, node, subtype));
+    return copy;
+  }
+  if (isThenableType(checker, node)) {
+    return checker.getTypeArguments(type)[0];
+  }
+  return type;
+}
+function functionHasResultLikeReturnType(service, checker, node) {
+  const functionDeclaration = checker.getResolvedSignature(node);
+  if (!functionDeclaration) {
+    return false;
+  }
+  const returnType = unwrapPotentialPromiseType(checker, node);
+  const resultType = getSapphireResultType(service, checker);
+  if (!returnType.aliasSymbol || !resultType?.aliasSymbol) {
+    return false;
+  }
+  return Reflect.get(returnType.aliasSymbol, "id") === Reflect.get(resultType.aliasSymbol, "id");
+}
+function isDiscardedResult(callExpressionNode) {
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.UnaryExpression && callExpressionNode.parent.operator === "void") {
+    return false;
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.VariableDeclarator) {
+    return false;
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.AssignmentExpression) {
+    return false;
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.CallExpression) {
+    return false;
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.SequenceExpression) {
+    return isDiscardedResult(callExpressionNode.parent);
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.AwaitExpression) {
+    return isDiscardedResult(callExpressionNode.parent);
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.ConditionalExpression) {
+    return isDiscardedResult(callExpressionNode.parent);
+  }
+  if (callExpressionNode.parent?.type === AST_NODE_TYPES.LogicalExpression) {
+    return isDiscardedResult(callExpressionNode.parent);
+  }
+  return true;
+}
+var messages, resultPath, noDiscardResult;
+var init_no_discard_result = __esm({
+  "src/rules/no-discard-result.ts"() {
+    messages = {
+      discardedResult: "This function returns a Result, but its return value is being discarded."
+    };
+    resultPath = __require.resolve("@sapphire/result").split("/").slice(0, -1).concat("index.d.ts").join("/");
+    __name(getSapphireResultType, "getSapphireResultType");
+    __name(unwrapPotentialPromiseType, "unwrapPotentialPromiseType");
+    __name(functionHasResultLikeReturnType, "functionHasResultLikeReturnType");
+    __name(isDiscardedResult, "isDiscardedResult");
+    noDiscardResult = ESLintUtils.RuleCreator.withoutDocs({
+      meta: {
+        messages,
+        type: "problem",
+        schema: []
+      },
+      defaultOptions: [],
+      create: (context) => {
+        return {
+          CallExpression(callExpressionNode) {
+            const service = ESLintUtils.getParserServices(context);
+            const checker = service.program.getTypeChecker();
+            if (!functionHasResultLikeReturnType(service, checker, service.esTreeNodeToTSNodeMap.get(callExpressionNode))) {
+              return;
+            }
+            if (isDiscardedResult(callExpressionNode)) {
+              context.report({ messageId: "discardedResult", node: callExpressionNode });
+            }
+          }
+        };
+      }
+    });
+  }
+});
+
+// src/index.ts
+var require_src = __commonJS({
+  "src/index.ts"(exports, module) {
+    init_recommended();
+    init_no_discard_result();
+    var eslintPluginResult = {
+      rules: {
+        "no-discard-result": noDiscardResult
+      },
+      configs: {
+        recommended: recommendedConfig
+      }
+    };
+    module.exports = eslintPluginResult;
+  }
+});
+var index = require_src();
+
+export { index as default };

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@sapphire/eslint-plugin-result",
-  "version": "2.0.2-next.f4ec2624.0",
+  "version": "2.0.2",
   "description": "A TypeScript ESLint plugin for @sapphire/result",
   "author": "@sapphire",
   "license": "MIT",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
   "exports": {
-    "import": "./dist/index.js",
-    "require": "./dist/index.js"
+    "import": {
+      "default": "./dist/esm/index.mjs"
+    },
+    "require": {
+      "default": "./dist/cjs/index.cjs"
+    }
   },
   "sideEffects": false,
   "homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/eslint-plugin-result",
@@ -26,9 +30,7 @@
     "directory": "packages/eslint-plugin-result"
   },
   "files": [
-    "dist/**/*.js*",
-    "dist/**/*.mjs*",
-    "dist/**/*.d*"
+    "dist/"
   ],
   "engines": {
     "node": ">=v14.0.0",
@@ -51,17 +53,17 @@
   },
   "devDependencies": {
     "@favware/cliff-jumper": "^2.2.3",
-    "@typescript-eslint/rule-tester": "^6.11.0",
-    "@typescript-eslint/typescript-estree": "^6.11.0",
+    "@typescript-eslint/rule-tester": "^6.13.2",
+    "@typescript-eslint/typescript-estree": "^6.13.2",
     "@vitest/coverage-v8": "^0.34.6",
-    "tsup": "^7.2.0",
+    "tsup": "^8.0.1",
     "typedoc-json-parser": "^9.0.1",
     "vitest": "^0.34.6"
   },
   "dependencies": {
-    "@sapphire/result": "^2.6.4",
-    "@typescript-eslint/utils": "^6.11.0",
+    "@sapphire/result": "^2.6.5",
+    "@typescript-eslint/utils": "^6.13.2",
     "tsutils": "^3.21.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   }
 }