eslint-plugin-complete 1.0.8 → 1.0.10

package/dist/completeCommon.d.ts

@@ -13,6 +13,13 @@ export declare function capitalizeFirstLetter(string: string): string;
  * https://stackoverflow.com/questions/8334606/check-if-first-letter-of-word-is-a-capital-letter
  */
 export declare function isFirstLetterCapitalized(string: string): boolean;
+/**
+ * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
+ *
+ * Under the hood, this checks for `typeof variable === "object"`, `variable !== null`, and
+ * `!Array.isArray(variable)`.
+ */
+export declare function isObject(variable: unknown): variable is Record<string, unknown>;
 /**
  * Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
  *

package/dist/completeCommon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completeCommon.d.ts","sourceRoot":"","sources":["../src/completeCommon.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,QAAQ,CAC1E,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACb,CAAC;AAIF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7B,CAAC,MAAM,CAAC,GACR;IACE,iFAAiF;CAClF,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAIxC;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR"}
+{"version":3,"file":"completeCommon.d.ts","sourceRoot":"","sources":["../src/completeCommon.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,QAAQ,CAC1E,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACb,CAAC;AAIF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7B,CAAC,MAAM,CAAC,GACR;IACE,iFAAiF;CAClF,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAIxC;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMrC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR"}

package/dist/completeCommon.js

@@ -33,6 +33,17 @@ export function capitalizeFirstLetter(string) {
 export function isFirstLetterCapitalized(string) {
     return FIRST_LETTER_CAPITALIZED_REGEX.test(string);
 }
+/**
+ * Helper function to narrow an unknown value to an object (i.e. a TypeScript record).
+ *
+ * Under the hood, this checks for `typeof variable === "object"`, `variable !== null`, and
+ * `!Array.isArray(variable)`.
+ */
+export function isObject(variable) {
+    return (typeof variable === "object" &&
+        variable !== null &&
+        !Array.isArray(variable));
+}
 /**
  * Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
  *

package/dist/completeSentence.js

@@ -30,9 +30,9 @@ export function getIncompleteSentences(text) {
             continue;
         }
         const sentences = getSentences(squishedText);
-        const loneSentence = sentences.length === 1;
+        const isLoneSentence = sentences.length === 1;
         for (const sentence of sentences) {
-            const messageId = getIncompleteSentenceKind(sentence, loneSentence);
+            const messageId = getIncompleteSentenceKind(sentence, isLoneSentence);
             if (messageId !== undefined) {
                 incompleteSentences.push({
                     sentence,
@@ -149,7 +149,7 @@ export function getSentences(text) {
     }
     return match;
 }
-function getIncompleteSentenceKind(sentence, loneSentence) {
+function getIncompleteSentenceKind(sentence, isLoneSentence) {
     let text = sentence;
     // Trim the parenthesis surrounding the sentence, if any.
     let textBeforeModifications;
@@ -191,7 +191,7 @@ function getIncompleteSentenceKind(sentence, loneSentence) {
             return "doublePeriod";
         }
     }
-    if (loneSentence &&
+    if (isLoneSentence &&
         // Single words, double words, and triple words.
         (/^\S+$/.test(text) || /^\S+ \S+$/.test(text) || /^\S+ \S+ \S+$/.test(text))) {
         return undefined;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AASzD,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOX,CAAC;AAIF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAUzD,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOX,CAAC;AAMF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
+import { isObject } from "./completeCommon.js";
 import { configs } from "./configs.js";
 import { rules } from "./rules.js";
 const { name, version } = getPackageJSONNameAndVersion();
@@ -12,6 +13,8 @@ const plugin = {
     rules,
 };
 addPluginToConfigs(configs, name);
+// ESLint plugins must provide a default export by design.
+// eslint-disable-next-line
 export default plugin;
 /**
  * We parse the package JSON manually since importing JSON files directly in Node is experimental.
@@ -27,6 +30,9 @@ function getPackageJSONNameAndVersion() {
     catch (error) {
         throw new Error(`Failed to read the "${packageJSONPath}" file: ${error}`);
     }
+    if (!isObject(packageJSON)) {
+        throw new Error(`Failed to parse the "${packageJSONPath}" file since it was not an object.`);
+    }
     // eslint-disable-next-line @typescript-eslint/no-shadow
     const { name } = packageJSON;
     if (typeof name !== "string") {

package/dist/rules/prefer-readonly-parameter-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prefer-readonly-parameter-types.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-readonly-parameter-types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAY1E,KAAK,OAAO,GAAG;IACb;QACE,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC/B,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC;CACF,CAAC;AAGF,eAAO,MAAM,4BAA4B,6MA4LvC,CAAC"}
+{"version":3,"file":"prefer-readonly-parameter-types.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-readonly-parameter-types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAY1E,KAAK,OAAO,GAAG;IACb;QACE,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC/B,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC;CACF,CAAC;AAGF,eAAO,MAAM,4BAA4B,6MA6MvC,CAAC"}

package/dist/rules/prefer-readonly-parameter-types.js

@@ -71,6 +71,18 @@ export const preferReadonlyParameterTypes = createRule({
                 AST_NODE_TYPES.TSFunctionType,
                 AST_NODE_TYPES.TSMethodSignature,
             ].join(", ")](node) {
+                // Early return in the special case of a map method. (This would result in an unfixable lint
+                // error.)
+                if (node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
+                    node.type === AST_NODE_TYPES.FunctionExpression) {
+                    const { parent } = node;
+                    if (parent.type === AST_NODE_TYPES.CallExpression &&
+                        parent.callee.type === AST_NODE_TYPES.MemberExpression &&
+                        parent.callee.property.type === AST_NODE_TYPES.Identifier &&
+                        parent.callee.property.name === "map") {
+                        return;
+                    }
+                }
                 for (const param of node.params) {
                     if (checkParameterProperties === false &&
                         param.type === AST_NODE_TYPES.TSParameterProperty) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-complete",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "An ESLint plugin that contains useful rules.",
   "keywords": [
     "eslint",
@@ -44,23 +44,23 @@
     "test": "jest"
   },
   "dependencies": {
-    "@typescript-eslint/type-utils": "^8.10.0",
-    "@typescript-eslint/utils": "^8.10.0",
-    "typescript-eslint": "^8.10.0"
+    "@typescript-eslint/type-utils": "8.25.0",
+    "@typescript-eslint/utils": "8.25.0",
+    "typescript-eslint": "8.25.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.25.8",
-    "@babel/preset-env": "^7.25.8",
-    "@babel/preset-typescript": "^7.25.7",
-    "@types/jest": "^29.5.13",
-    "@types/node": "^22.7.6",
-    "@typescript-eslint/rule-tester": "^8.10.0",
-    "@typescript-eslint/types": "^8.10.0",
-    "complete-common": "^1.0.0",
-    "complete-node": "^1.5.1",
-    "jest": "^29.7.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.6.3"
+    "@babel/core": "7.26.9",
+    "@babel/preset-env": "7.26.9",
+    "@babel/preset-typescript": "7.26.0",
+    "@types/jest": "29.5.14",
+    "@types/node": "22.13.5",
+    "@typescript-eslint/rule-tester": "8.25.0",
+    "@typescript-eslint/types": "8.25.0",
+    "complete-common": "1.1.2",
+    "complete-node": "3.1.6",
+    "jest": "29.7.0",
+    "prettier": "3.5.2",
+    "typescript": "5.7.3"
   },
   "peerDependencies": {
     "eslint": ">= 9.0.0",