feat(finder): add writeToFile option and outputDir parameter

emretepedev · Dec 29, 2024 · 2570008 · 2570008
1 parent bf95e62
commit 2570008
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -64,3 +64,4 @@ typings/
 
 test/**/artifacts
 test/**/cache
+test/**/finder-outputs
diff --git a/README.md b/README.md
@@ -39,8 +39,8 @@ import "hardhat-finder";
 This plugin adds the `finder` task to Hardhat:
 
 ```
-Usage: hardhat [GLOBAL OPTIONS] finder [--colorify] [--compact] [--depth <INT>] [--include-dependencies] [--max-string-length <INT>] [--name <STRING>] [--no-compile] [--path <INPUTFILE>] [--prettify] [...outputs]
-$ hardhat finder --prettify --colorify contracts/Example.sol Example abi bytecode
+Usage: hardhat [GLOBAL OPTIONS] finder [--colorify] [--compact] [--name <STRING>] [--path <INPUTFILE>] [--depth <INT>] [--include-dependencies] [--max-string-length <INT>] [--no-compile] [--output-dir <STRING>] [--prettify] [--write-to-file] [...outputs]
+$ hardhat finder --prettify --colorify --path contracts/Example.sol --name Example abi bytecode
 
 @@@@@@@ contracts/Example.sol:Example @@@@@@@
 ======= Abi ======= (contracts/Example.sol:Example)
@@ -109,6 +109,8 @@ module.exports = {
 | colorify            | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Colorize the outputs.                                               |
 | prettify            | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Beautify the outputs.                                               |
 | compact             | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Compact the outputs.                                                |
+| writeToFile         | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Write the outputs to a file.                                        |
+| outputDir           | _String_   | finder-outputs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Directory to save the outputs.                                      |
 | noCompile           | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Don't compile before running this task.                             |
 | runOnCompile        | _Boolean_  | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Run finder task during compile task.                                |
 

diff --git a/src/config/plugin.ts b/src/config/plugin.ts
@@ -5,9 +5,11 @@ import {
   DEFAULT_INCLUDE_DEPENDENCIES,
   DEFAULT_MAX_STRING_LENGTH,
   DEFAULT_NO_COMPILE,
+  DEFAULT_OUTPUT_DIR,
   DEFAULT_OUTPUTS,
   DEFAULT_PRETTIFY,
   DEFAULT_RUN_ON_COMPILE,
+  DEFAULT_WRITE_TO_FILE,
 } from "~/constants";
 import type { FinderConfig } from "~/types";
 
@@ -21,4 +23,6 @@ export const defaultFinderConfig: FinderConfig = {
   compact: DEFAULT_COMPACT,
   noCompile: DEFAULT_NO_COMPILE,
   runOnCompile: DEFAULT_RUN_ON_COMPILE,
+  writeToFile: DEFAULT_WRITE_TO_FILE,
+  outputDir: DEFAULT_OUTPUT_DIR,
 };
diff --git a/src/constants/task.ts b/src/constants/task.ts
@@ -37,3 +37,5 @@ export const DEFAULT_PRETTIFY = false;
 export const DEFAULT_COMPACT = false;
 export const DEFAULT_NO_COMPILE = false;
 export const DEFAULT_RUN_ON_COMPILE = false;
+export const DEFAULT_WRITE_TO_FILE = false;
+export const DEFAULT_OUTPUT_DIR = "finder-outputs";
diff --git a/src/tasks/finder.ts b/src/tasks/finder.ts
@@ -1,6 +1,8 @@
+import { existsSync, mkdirSync, writeFileSync } from "fs";
 import { task, types } from "hardhat/config";
 import { HardhatPluginError } from "hardhat/plugins";
 import type { ActionType } from "hardhat/types";
+import { dirname } from "path";
 import type { InspectOptions } from "util";
 import { PLUGIN_NAME, SUPPORTED_OUTPUTS, TASK_FINDER } from "~/constants";
 import type { ContractInfo, FinderTaskArguments } from "~/types";
@@ -24,6 +26,8 @@ const finderAction: ActionType<FinderTaskArguments> = async (
     prettify,
     compact,
     noCompile,
+    writeToFile,
+    outputDir,
   },
   { config, finder }
 ) => {
@@ -38,6 +42,8 @@ const finderAction: ActionType<FinderTaskArguments> = async (
     prettify,
     compact,
     noCompile,
+    writeToFile,
+    outputDir,
   } = prepareTaskArguments());
 
   validateTaskArguments();
@@ -95,6 +101,15 @@ const finderAction: ActionType<FinderTaskArguments> = async (
         `======= ${outputName.humanReadableFormat} ======= (${contractInfo.fullyQualifiedName})`
       );
       useInspectConsole(content, inspectOptions);
+
+      if (writeToFile) {
+        const filePath = `${outputDir}/${contractInfo.fullyQualifiedName}/${output}`;
+        const dirPath = dirname(filePath);
+        if (!existsSync(dirPath)) {
+          mkdirSync(dirPath, { recursive: true });
+        }
+        writeFileSync(filePath, content);
+      }
     }
   }
 
@@ -114,6 +129,8 @@ const finderAction: ActionType<FinderTaskArguments> = async (
       prettify: prettify || config.finder.prettify,
       compact: compact || config.finder.compact,
       noCompile: noCompile || config.finder.noCompile,
+      writeToFile: writeToFile || config.finder.writeToFile,
+      outputDir: outputDir || config.finder.outputDir,
     };
   }
 
@@ -164,5 +181,12 @@ task<FinderTaskArguments>(TASK_FINDER)
   .addFlag("prettify", "Beautify the outputs.")
   .addFlag("compact", "Compact the outputs.")
   .addFlag("noCompile", "Don't compile before running this task.")
+  .addFlag("writeToFile", "Write the outputs to a file.")
+  .addOptionalParam(
+    "outputDir",
+    "Directory to save the outputs.",
+    undefined,
+    types.string
+  )
   .setDescription("Find various outputs of any existing contracts.")
   .setAction(finderAction);
diff --git a/src/types/plugin.ts b/src/types/plugin.ts
@@ -12,6 +12,8 @@ export interface FinderConfig {
   compact: boolean;
   noCompile: boolean;
   runOnCompile: boolean;
+  writeToFile: boolean;
+  outputDir: string;
 }
 
 export interface FinderUserConfig {
@@ -28,4 +30,6 @@ export interface FinderUserConfig {
   compact?: boolean;
   noCompile?: boolean;
   runOnCompile?: boolean;
+  writeToFile: boolean;
+  outputDir: string;
 }
diff --git a/src/types/task.ts b/src/types/task.ts
@@ -9,6 +9,8 @@ export interface FinderTaskArguments {
   prettify?: boolean;
   compact?: boolean;
   noCompile?: boolean;
+  writeToFile?: boolean;
+  outputDir?: string;
 }
 
 export interface CompilerTaskArguments {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -64,3 +64,4 @@ typings/

		test/**/artifacts
		test/**/cache
		test/**/finder-outputs