@harness-engineering/eslint-plugin 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -28,6 +28,9 @@ declare const rules: {
     'no-sync-io-in-async': _typescript_eslint_utils_ts_eslint.RuleModule<"syncIoInAsync", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
+    'no-undefined-optional-assignment': _typescript_eslint_utils_ts_eslint.RuleModule<"undefinedOptionalAssignment", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        name: string;
+    };
     'no-unbounded-array-chains': _typescript_eslint_utils_ts_eslint.RuleModule<"unboundedArrayChain", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
@@ -75,6 +78,9 @@ declare const plugin: {
         'no-sync-io-in-async': _typescript_eslint_utils_ts_eslint.RuleModule<"syncIoInAsync", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
+        'no-undefined-optional-assignment': _typescript_eslint_utils_ts_eslint.RuleModule<"undefinedOptionalAssignment", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+            name: string;
+        };
         'no-unbounded-array-chains': _typescript_eslint_utils_ts_eslint.RuleModule<"unboundedArrayChain", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
@@ -99,6 +105,9 @@ declare const plugin: {
                 '@harness-engineering/no-forbidden-imports': string;
                 '@harness-engineering/require-boundary-schema': string;
                 '@harness-engineering/enforce-doc-exports': string;
+                '@harness-engineering/no-nested-loops-in-critical': string;
+                '@harness-engineering/no-sync-io-in-async': string;
+                '@harness-engineering/no-unbounded-array-chains': string;
                 '@harness-engineering/no-unix-shell-command': string;
                 '@harness-engineering/no-hardcoded-path-separator': string;
                 '@harness-engineering/no-process-env-in-spawn': string;
@@ -115,6 +124,9 @@ declare const plugin: {
                 '@harness-engineering/no-forbidden-imports': string;
                 '@harness-engineering/require-boundary-schema': string;
                 '@harness-engineering/enforce-doc-exports': string;
+                '@harness-engineering/no-nested-loops-in-critical': string;
+                '@harness-engineering/no-sync-io-in-async': string;
+                '@harness-engineering/no-unbounded-array-chains': string;
                 '@harness-engineering/no-unix-shell-command': string;
                 '@harness-engineering/no-hardcoded-path-separator': string;
                 '@harness-engineering/no-process-env-in-spawn': string;
@@ -160,6 +172,9 @@ declare const configs: {
                     'no-sync-io-in-async': _typescript_eslint_utils_ts_eslint.RuleModule<"syncIoInAsync", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
                         name: string;
                     };
+                    'no-undefined-optional-assignment': _typescript_eslint_utils_ts_eslint.RuleModule<"undefinedOptionalAssignment", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+                        name: string;
+                    };
                     'no-unbounded-array-chains': _typescript_eslint_utils_ts_eslint.RuleModule<"unboundedArrayChain", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
                         name: string;
                     };
@@ -182,6 +197,9 @@ declare const configs: {
             '@harness-engineering/no-forbidden-imports': string;
             '@harness-engineering/require-boundary-schema': string;
             '@harness-engineering/enforce-doc-exports': string;
+            '@harness-engineering/no-nested-loops-in-critical': string;
+            '@harness-engineering/no-sync-io-in-async': string;
+            '@harness-engineering/no-unbounded-array-chains': string;
             '@harness-engineering/no-unix-shell-command': string;
             '@harness-engineering/no-hardcoded-path-separator': string;
             '@harness-engineering/no-process-env-in-spawn': string;
@@ -223,6 +241,9 @@ declare const configs: {
                     'no-sync-io-in-async': _typescript_eslint_utils_ts_eslint.RuleModule<"syncIoInAsync", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
                         name: string;
                     };
+                    'no-undefined-optional-assignment': _typescript_eslint_utils_ts_eslint.RuleModule<"undefinedOptionalAssignment", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+                        name: string;
+                    };
                     'no-unbounded-array-chains': _typescript_eslint_utils_ts_eslint.RuleModule<"unboundedArrayChain", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
                         name: string;
                     };
@@ -245,6 +266,9 @@ declare const configs: {
             '@harness-engineering/no-forbidden-imports': string;
             '@harness-engineering/require-boundary-schema': string;
             '@harness-engineering/enforce-doc-exports': string;
+            '@harness-engineering/no-nested-loops-in-critical': string;
+            '@harness-engineering/no-sync-io-in-async': string;
+            '@harness-engineering/no-unbounded-array-chains': string;
             '@harness-engineering/no-unix-shell-command': string;
             '@harness-engineering/no-hardcoded-path-separator': string;
             '@harness-engineering/no-process-env-in-spawn': string;

package/dist/index.js

@@ -308,17 +308,27 @@ function getConfig(filePath) {
     return null;
   }
 }
+function getConfigRoot(filePath) {
+  const configPath = findConfigFile(path2.dirname(filePath));
+  return configPath ? path2.dirname(configPath) : null;
+}
 
 // src/utils/path-utils.ts
 import * as path3 from "path";
 import { minimatch } from "minimatch";
-function resolveImportPath(importPath, importingFile) {
+function resolveImportPath(importPath, importingFile, projectRoot) {
   if (!importPath.startsWith(".")) {
     return importPath;
   }
   const importingDir = path3.dirname(importingFile);
   const resolved = path3.resolve(importingDir, importPath);
   const normalized = resolved.replace(/\\/g, "/");
+  if (projectRoot) {
+    const root = projectRoot.replace(/\\/g, "/").replace(/\/$/, "");
+    if (normalized.startsWith(root + "/")) {
+      return normalized.slice(root.length + 1);
+    }
+  }
   const srcIndex = normalized.indexOf("/src/");
   if (srcIndex !== -1) {
     return normalized.slice(srcIndex + 1);
@@ -341,8 +351,14 @@ function getLayerForFile(filePath, layers) {
 function getLayerByName(name, layers) {
   return layers.find((l) => l.name === name);
 }
-function normalizePath2(filePath) {
+function normalizePath2(filePath, projectRoot) {
   const normalized = filePath.replace(/\\/g, "/");
+  if (projectRoot) {
+    const root = projectRoot.replace(/\\/g, "/").replace(/\/$/, "");
+    if (normalized.startsWith(root + "/")) {
+      return normalized.slice(root.length + 1);
+    }
+  }
   const srcIndex = normalized.indexOf("/src/");
   if (srcIndex !== -1) {
     return normalized.slice(srcIndex + 1);
@@ -370,9 +386,9 @@ function findViolatedRule(applicableRules, importPath, resolvedImport) {
 function buildForbiddenMessage(rule, importPath) {
   return rule.message ?? `Import "${importPath}" is forbidden in files matching "${rule.from}"`;
 }
-function checkImportDeclaration2(node, applicableRules, filename, report) {
+function checkImportDeclaration2(node, applicableRules, filename, projectRoot, report) {
   const importPath = node.source.value;
-  const resolvedImport = resolveImportPath(importPath, filename);
+  const resolvedImport = resolveImportPath(importPath, filename, projectRoot ?? void 0);
   const violatedRule = findViolatedRule(applicableRules, importPath, resolvedImport);
   if (violatedRule) {
     report({
@@ -400,7 +416,8 @@ var no_forbidden_imports_default = createRule3({
     if (!config?.forbiddenImports?.length) {
       return {};
     }
-    const filePath = normalizePath2(context.filename);
+    const projectRoot = getConfigRoot(context.filename);
+    const filePath = normalizePath2(context.filename, projectRoot ?? void 0);
     const applicableRules = config.forbiddenImports.filter(
       (rule) => matchesPattern(filePath, rule.from)
     );
@@ -410,7 +427,7 @@ var no_forbidden_imports_default = createRule3({
     const report = context.report.bind(context);
     return {
       ImportDeclaration(node) {
-        checkImportDeclaration2(node, applicableRules, context.filename, report);
+        checkImportDeclaration2(node, applicableRules, context.filename, projectRoot, report);
       }
     };
   }
@@ -424,13 +441,13 @@ var createRule4 = ESLintUtils4.RuleCreator(
 function isLayerViolation(importLayer, currentLayer, currentLayerDef) {
   return importLayer !== currentLayer && !currentLayerDef.allowedDependencies.includes(importLayer);
 }
-function resolveImportLayer(importPath, filename, layers) {
+function resolveImportLayer(importPath, filename, layers, projectRoot) {
   if (!importPath.startsWith(".")) return null;
-  const resolvedImport = resolveImportPath(importPath, filename);
+  const resolvedImport = resolveImportPath(importPath, filename, projectRoot ?? void 0);
   return getLayerForFile(resolvedImport, layers) ?? null;
 }
-function checkLayerImport(node, context, currentLayer, currentLayerDef, layers) {
-  const importLayer = resolveImportLayer(node.source.value, context.filename, layers);
+function checkLayerImport(node, context, currentLayer, currentLayerDef, layers, projectRoot) {
+  const importLayer = resolveImportLayer(node.source.value, context.filename, layers, projectRoot);
   if (!importLayer) return;
   if (isLayerViolation(importLayer, currentLayer, currentLayerDef)) {
     context.report({
@@ -458,7 +475,8 @@ var no_layer_violation_default = createRule4({
     if (!config?.layers?.length) {
       return {};
     }
-    const filePath = normalizePath2(context.filename);
+    const projectRoot = getConfigRoot(context.filename);
+    const filePath = normalizePath2(context.filename, projectRoot ?? void 0);
     const currentLayer = getLayerForFile(filePath, config.layers);
     if (!currentLayer) {
       return {};
@@ -470,7 +488,7 @@ var no_layer_violation_default = createRule4({
     const layers = config.layers;
     return {
       ImportDeclaration(node) {
-        checkLayerImport(node, context, currentLayer, currentLayerDef, layers);
+        checkLayerImport(node, context, currentLayer, currentLayerDef, layers, projectRoot);
       }
     };
   }
@@ -964,6 +982,14 @@ function hasProcessEnvProperty(node) {
   }
   return void 0;
 }
+function findEnvViolation(args) {
+  for (const arg of args) {
+    if (arg.type !== "ObjectExpression") continue;
+    const envProp = hasProcessEnvProperty(arg);
+    if (envProp) return envProp;
+  }
+  return void 0;
+}
 var no_process_env_in_spawn_default = createRule11({
   name: "no-process-env-in-spawn",
   meta: {
@@ -978,20 +1004,15 @@ var no_process_env_in_spawn_default = createRule11({
   },
   defaultOptions: [],
   create(context) {
-    return {
-      CallExpression(node) {
-        const name = getSpawnFunctionName(node);
-        if (!name) return;
-        for (const arg of node.arguments) {
-          if (arg.type === "ObjectExpression") {
-            const envProp = hasProcessEnvProperty(arg);
-            if (envProp) {
-              context.report({ node: envProp, messageId: "processEnvInSpawn", data: { name } });
-            }
-          }
-        }
+    function checkCall(node) {
+      const name = getSpawnFunctionName(node);
+      if (!name) return;
+      const violation = findEnvViolation(node.arguments);
+      if (violation) {
+        context.report({ node: violation, messageId: "processEnvInSpawn", data: { name } });
       }
-    };
+    }
+    return { CallExpression: checkCall };
   }
 });
 
@@ -1052,6 +1073,69 @@ var require_path_normalization_default = createRule12({
   }
 });
 
+// src/rules/no-undefined-optional-assignment.ts
+import { ESLintUtils as ESLintUtils13 } from "@typescript-eslint/utils";
+var createRule13 = ESLintUtils13.RuleCreator(
+  (name) => `https://github.com/harness-engineering/eslint-plugin/blob/main/docs/rules/${name}.md`
+);
+function unionIncludesUndefined(typeNode) {
+  return typeNode?.type === "TSUnionType" && typeNode.types.some((t) => t.type === "TSUndefinedKeyword");
+}
+function declaredType(identifier, scope) {
+  const ref = scope.references.find((r) => r.identifier === identifier);
+  const name = ref?.resolved?.defs[0]?.name;
+  if (name?.type !== "Identifier") return void 0;
+  return name.typeAnnotation?.typeAnnotation;
+}
+function checksDefined(expr, name) {
+  if (expr.type !== "BinaryExpression" || expr.operator !== "!==" && expr.operator !== "!=") {
+    return false;
+  }
+  const refsName = (n) => n.type === "Identifier" && n.name === name;
+  const isNullish = (n) => n.type === "Identifier" && n.name === "undefined" || n.type === "Literal" && n.value === null;
+  return refsName(expr.left) && isNullish(expr.right) || refsName(expr.right) && isNullish(expr.left);
+}
+function isGuarded(node, name) {
+  for (let cur = node.parent; cur; cur = cur.parent) {
+    if (cur.type === "LogicalExpression" && cur.operator === "&&" && checksDefined(cur.left, name)) {
+      return true;
+    }
+  }
+  return false;
+}
+var no_undefined_optional_assignment_default = createRule13({
+  name: "no-undefined-optional-assignment",
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Disallow assigning a possibly-undefined variable directly to an object property, which breaks `exactOptionalPropertyTypes`; use a conditional spread instead."
+    },
+    messages: {
+      undefinedOptionalAssignment: "Assigning possibly-undefined '{{name}}' directly to '{{field}}' breaks exactOptionalPropertyTypes. Use a conditional spread: ...({{name}} !== undefined && {{ '{' }} {{field}}: {{name}} {{ '}' }})."
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      Property(node) {
+        if (node.computed || node.value.type !== "Identifier") return;
+        if (node.key.type !== "Identifier" && node.key.type !== "Literal") return;
+        const value = node.value;
+        const scope = context.sourceCode.getScope(value);
+        if (!unionIncludesUndefined(declaredType(value, scope))) return;
+        if (isGuarded(node, value.name)) return;
+        const field = node.key.type === "Identifier" ? node.key.name : String(node.key.value);
+        context.report({
+          node: value,
+          messageId: "undefinedOptionalAssignment",
+          data: { name: value.name, field }
+        });
+      }
+    };
+  }
+});
+
 // src/rules/index.ts
 var rules = {
   "enforce-doc-exports": enforce_doc_exports_default,
@@ -1062,6 +1146,7 @@ var rules = {
   "no-nested-loops-in-critical": no_nested_loops_in_critical_default,
   "no-process-env-in-spawn": no_process_env_in_spawn_default,
   "no-sync-io-in-async": no_sync_io_in_async_default,
+  "no-undefined-optional-assignment": no_undefined_optional_assignment_default,
   "no-unbounded-array-chains": no_unbounded_array_chains_default,
   "no-unix-shell-command": no_unix_shell_command_default,
   "require-boundary-schema": require_boundary_schema_default,
@@ -1072,7 +1157,7 @@ var rules = {
 var plugin = {
   meta: {
     name: "@harness-engineering/eslint-plugin",
-    version: "0.2.4"
+    version: "0.3.0"
   },
   rules,
   configs: {
@@ -1088,6 +1173,9 @@ var plugin = {
         "@harness-engineering/no-forbidden-imports": "error",
         "@harness-engineering/require-boundary-schema": "warn",
         "@harness-engineering/enforce-doc-exports": "warn",
+        "@harness-engineering/no-nested-loops-in-critical": "warn",
+        "@harness-engineering/no-sync-io-in-async": "warn",
+        "@harness-engineering/no-unbounded-array-chains": "warn",
         "@harness-engineering/no-unix-shell-command": "warn",
         "@harness-engineering/no-hardcoded-path-separator": "warn",
         "@harness-engineering/no-process-env-in-spawn": "error",
@@ -1106,6 +1194,9 @@ var plugin = {
         "@harness-engineering/no-forbidden-imports": "error",
         "@harness-engineering/require-boundary-schema": "error",
         "@harness-engineering/enforce-doc-exports": "error",
+        "@harness-engineering/no-nested-loops-in-critical": "error",
+        "@harness-engineering/no-sync-io-in-async": "error",
+        "@harness-engineering/no-unbounded-array-chains": "error",
         "@harness-engineering/no-unix-shell-command": "error",
         "@harness-engineering/no-hardcoded-path-separator": "error",
         "@harness-engineering/no-process-env-in-spawn": "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harness-engineering/eslint-plugin",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "ESLint plugin for harness engineering architectural constraints",
   "type": "module",
   "main": "./dist/index.js",