feat: rename testMode to debugMode

b00ste · Feb 19, 2022 · 6e06f12 · 6e06f12
1 parent 037eaad
commit 6e06f12
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -90,7 +90,7 @@ const config: HardhatUserConfig = {
   // Your Hardhat config...
   dodoc: {
     runOnCompile: true,
-    testMode: true,
+    debugMode: true,
     // More options...
   },
 };
@@ -107,7 +107,7 @@ Here are all the configuration parameters that are currently available, but as s
 | `exclude`           | List of all the contract / interface / library names to exclude from the documentation generation                                                          | `[]`              |
 | `outputDir`         | Output directory of the documentation                                                                                                                      | `docs`            |
 | `templatePath`      | Path to the documentation template                                                                                                                         | `./template.sqrl` |
-| `testMode`          | Test mode generating additional JSON files used for debugging                                                                                              | `false`           |
+| `debugMode`          | Test mode generating additional JSON files used for debugging                                                                                              | `false`           |
 | `keepFileStructure` | True if you want to preserve your contracts file structure                                                                                                 | `true`            |
 
 ## 💅 Customize

diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -9,7 +9,7 @@ const config: HardhatUserConfig = {
     sources: './examples/contracts/',
   },
   dodoc: {
-    testMode: true,
+    debugMode: true,
     outputDir: './examples/docs',
   },
 };

diff --git a/src/index.ts b/src/index.ts
@@ -16,7 +16,7 @@ extendConfig((config: HardhatConfig, userConfig: Readonly<HardhatUserConfig>) =>
     include: userConfig.dodoc?.include || [],
     exclude: userConfig.dodoc?.exclude || [],
     runOnCompile: userConfig.dodoc?.runOnCompile !== undefined ? userConfig.dodoc?.runOnCompile : true,
-    testMode: userConfig.dodoc?.testMode || false,
+    debugMode: userConfig.dodoc?.debugMode || false,
     outputDir: userConfig.dodoc?.outputDir || './docs',
     templatePath: userConfig.dodoc?.templatePath || path.join(__dirname, './template.sqrl'),
     keepFileStructure: userConfig.dodoc?.keepFileStructure ?? true,
@@ -59,7 +59,7 @@ task(TASK_COMPILE, async (args, hre, runSuper) => {
     const buildInfo = await hre.artifacts.getBuildInfo(qualifiedName);
     const info = buildInfo?.output.contracts[source][name] as CompilerOutputContractWithDocumentation;
 
-    if (config.testMode) {
+    if (config.debugMode) {
       console.log('ABI:\n');
       console.log(JSON.stringify(info.abi, null, 4));
       console.log('\n\n');
@@ -189,7 +189,7 @@ task(TASK_COMPILE, async (args, hre, runSuper) => {
       },
     );
 
-    if (config.testMode) {
+    if (config.debugMode) {
       await fs.promises.writeFile(
         path.join(config.outputDir, testFileName),
         JSON.stringify(docs[i], null, 4), {

diff --git a/src/type-extensions.ts b/src/type-extensions.ts
@@ -6,7 +6,7 @@ declare module 'hardhat/types/config' {
       include?: string[];
       exclude?: string[];
       runOnCompile?: boolean;
-      testMode?: boolean;
+      debugMode?: boolean;
       templatePath?: string;
       outputDir?: string;
       keepFileStructure?: boolean;
@@ -18,7 +18,7 @@ declare module 'hardhat/types/config' {
       include: string[];
       exclude: string[];
       runOnCompile: boolean;
-      testMode: boolean;
+      debugMode: boolean;
       templatePath: string;
       outputDir: string;
       keepFileStructure: boolean;