@nomicfoundation/hardhat-utils 4.1.5 → 4.1.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @nomicfoundation/hardhat-utils
 
+## 4.1.6
+
+### Patch Changes
+
+- [#8429](https://github.com/NomicFoundation/hardhat/pull/8429) [`448a980`](https://github.com/NomicFoundation/hardhat/commit/448a9807c962eb02ed81e7ddce2718a0399f2335) Thanks [@marianfe](https://github.com/marianfe)! - Add `detectAgentEnvironment` and `isInteractive` utils
+
 ## 4.1.5
 
 ### Patch Changes

package/dist/src/environment.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The result of detecting whether the current process is running inside an
+ * AI coding agent environment.
+ */
+export interface AgentEnvironment {
+    /**
+     * True if at least one agent environment was detected.
+     */
+    isAgent: boolean;
+    /**
+     * The identifiers of every detected agent, deduplicated.
+     *
+     * More than one agent can be reported at the same time, as agent sessions
+     * can be nested.
+     */
+    agents: string[];
+}
+/**
+ * Detects whether the current process is running inside an AI coding agent
+ * environment, based on the environment variables that those tools set in
+ * the shells they spawn.
+ *
+ * Currently supported: Claude Code and Codex. Other agents that advertise
+ * themselves via the generic `AI_AGENT` variable are reported as "unknown".
+ *
+ * @returns The detected agent environment.
+ */
+export declare function detectAgentEnvironment(): AgentEnvironment;
+/**
+ * Checks whether the current process is running interactively, meaning both
+ * stdin and stdout are TTYs.
+ *
+ * This is orthogonal to agent detection, but can be a useful hint of whether
+ * the process is running in an automated environment.
+ *
+ * @returns True if the current process is running interactively.
+ */
+export declare function isInteractive(): boolean;
+//# sourceMappingURL=environment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/environment.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,IAAI,gBAAgB,CAiCzD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC"}

package/dist/src/environment.js

@@ -0,0 +1,48 @@
+/**
+ * Detects whether the current process is running inside an AI coding agent
+ * environment, based on the environment variables that those tools set in
+ * the shells they spawn.
+ *
+ * Currently supported: Claude Code and Codex. Other agents that advertise
+ * themselves via the generic `AI_AGENT` variable are reported as "unknown".
+ *
+ * @returns The detected agent environment.
+ */
+export function detectAgentEnvironment() {
+    const env = process.env;
+    const detectedAgents = [];
+    // Claude Code sets these in every shell command it runs
+    if (env.CLAUDECODE !== undefined ||
+        env.CLAUDE_CODE_ENTRYPOINT !== undefined) {
+        detectedAgents.push("claude-code");
+    }
+    // Codex sets these in the shells it spawns
+    if (env.CODEX_THREAD_ID !== undefined ||
+        env.CODEX_CI !== undefined ||
+        env.CODEX_SANDBOX_NETWORK_DISABLED !== undefined) {
+        detectedAgents.push("codex");
+    }
+    // Generic marker set by some agents alongside their own variables (e.g.
+    // Claude Code sets `AI_AGENT=claude-code_<version>_agent`). It is only
+    // reported when no known agent matched, to avoid double counting
+    if (detectedAgents.length === 0 && env.AI_AGENT !== undefined) {
+        detectedAgents.push("unknown");
+    }
+    return {
+        isAgent: detectedAgents.length > 0,
+        agents: detectedAgents,
+    };
+}
+/**
+ * Checks whether the current process is running interactively, meaning both
+ * stdin and stdout are TTYs.
+ *
+ * This is orthogonal to agent detection, but can be a useful hint of whether
+ * the process is running in an automated environment.
+ *
+ * @returns True if the current process is running interactively.
+ */
+export function isInteractive() {
+    return process.stdin.isTTY === true && process.stdout.isTTY === true;
+}
+//# sourceMappingURL=environment.js.map

package/dist/src/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../src/environment.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB;IACpC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,MAAM,cAAc,GAAa,EAAE,CAAC;IAEpC,wDAAwD;IACxD,IACE,GAAG,CAAC,UAAU,KAAK,SAAS;QAC5B,GAAG,CAAC,sBAAsB,KAAK,SAAS,EACxC,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACrC,CAAC;IAED,2CAA2C;IAC3C,IACE,GAAG,CAAC,eAAe,KAAK,SAAS;QACjC,GAAG,CAAC,QAAQ,KAAK,SAAS;QAC1B,GAAG,CAAC,8BAA8B,KAAK,SAAS,EAChD,CAAC;QACD,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,wEAAwE;IACxE,uEAAuE;IACvE,iEAAiE;IACjE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC9D,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,cAAc,CAAC,MAAM,GAAG,CAAC;QAClC,MAAM,EAAE,cAAc;KACvB,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC;AACvE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/hardhat-utils",
-  "version": "4.1.5",
+  "version": "4.1.6",
   "description": "Utilities for Hardhat and its plugins",
   "homepage": "https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-utils",
   "repository": {
@@ -21,6 +21,7 @@
     "./date": "./dist/src/date.js",
     "./debug": "./dist/src/debug.js",
     "./env": "./dist/src/env.js",
+    "./environment": "./dist/src/environment.js",
     "./error": "./dist/src/error.js",
     "./eth": "./dist/src/eth.js",
     "./fast-semver": "./dist/src/fast-semver.js",

package/src/environment.ts

@@ -0,0 +1,76 @@
+/**
+ * The result of detecting whether the current process is running inside an
+ * AI coding agent environment.
+ */
+export interface AgentEnvironment {
+  /**
+   * True if at least one agent environment was detected.
+   */
+  isAgent: boolean;
+
+  /**
+   * The identifiers of every detected agent, deduplicated.
+   *
+   * More than one agent can be reported at the same time, as agent sessions
+   * can be nested.
+   */
+  agents: string[];
+}
+
+/**
+ * Detects whether the current process is running inside an AI coding agent
+ * environment, based on the environment variables that those tools set in
+ * the shells they spawn.
+ *
+ * Currently supported: Claude Code and Codex. Other agents that advertise
+ * themselves via the generic `AI_AGENT` variable are reported as "unknown".
+ *
+ * @returns The detected agent environment.
+ */
+export function detectAgentEnvironment(): AgentEnvironment {
+  const env = process.env;
+
+  const detectedAgents: string[] = [];
+
+  // Claude Code sets these in every shell command it runs
+  if (
+    env.CLAUDECODE !== undefined ||
+    env.CLAUDE_CODE_ENTRYPOINT !== undefined
+  ) {
+    detectedAgents.push("claude-code");
+  }
+
+  // Codex sets these in the shells it spawns
+  if (
+    env.CODEX_THREAD_ID !== undefined ||
+    env.CODEX_CI !== undefined ||
+    env.CODEX_SANDBOX_NETWORK_DISABLED !== undefined
+  ) {
+    detectedAgents.push("codex");
+  }
+
+  // Generic marker set by some agents alongside their own variables (e.g.
+  // Claude Code sets `AI_AGENT=claude-code_<version>_agent`). It is only
+  // reported when no known agent matched, to avoid double counting
+  if (detectedAgents.length === 0 && env.AI_AGENT !== undefined) {
+    detectedAgents.push("unknown");
+  }
+
+  return {
+    isAgent: detectedAgents.length > 0,
+    agents: detectedAgents,
+  };
+}
+
+/**
+ * Checks whether the current process is running interactively, meaning both
+ * stdin and stdout are TTYs.
+ *
+ * This is orthogonal to agent detection, but can be a useful hint of whether
+ * the process is running in an automated environment.
+ *
+ * @returns True if the current process is running interactively.
+ */
+export function isInteractive(): boolean {
+  return process.stdin.isTTY === true && process.stdout.isTTY === true;
+}