@primitivefi/hardhat-dodoc - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

dist/src/index.js

@@ -47,18 +47,5 @@ "use strict";
 });
-async function generateDocumentation(hre, runSuper, shouldRunSuper = false) {
+async function generateDocumentation(hre) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
     const config = hre.config.dodoc;
-    // Updates the compiler settings
-    for (const compiler of hre.config.solidity.compilers) {
-        compiler.settings.outputSelection['*']['*'].push('devdoc');
-        compiler.settings.outputSelection['*']['*'].push('userdoc');
-    }
-    if (shouldRunSuper && runSuper) {
-        // Calls super to COMPILE
-        runSuper();
-    }
-    else {
-        // Calls the actual COMPILE task
-        await hre.run(task_names_1.TASK_COMPILE);
-    }
     const docs = [];
@@ -209,11 +196,24 @@ const qualifiedNames = await hre.artifacts.getAllFullyQualifiedNames();
 (0, config_1.task)('dodoc', 'Generates NatSpec documentation for the project')
+    .addFlag('noCompile', 'Prevents compiling before running this task')
     .setAction(async (args, hre) => {
+    if (!args.noCompile) {
+        await hre.run(task_names_1.TASK_COMPILE, { noDodoc: true });
+    }
     await generateDocumentation(hre);
 });
 // Overriding task triggered when COMPILE is called
-(0, config_1.task)(task_names_1.TASK_COMPILE, async (args, hre, runSuper) => {
-    if (hre.config.dodoc.runOnCompile) {
-        await generateDocumentation(hre, runSuper, true);
+(0, config_1.task)(task_names_1.TASK_COMPILE)
+    .addFlag('noDodoc', 'Prevents generating NatSpec documentation for the project')
+    .setAction(async (args, hre, runSuper) => {
+    // Updates the compiler settings
+    for (const compiler of hre.config.solidity.compilers) {
+        compiler.settings.outputSelection['*']['*'].push('devdoc');
+        compiler.settings.outputSelection['*']['*'].push('userdoc');
     }
+    // Compiles the contracts
+    await runSuper();
+    if (hre.config.dodoc.runOnCompile && !args.noDodoc) {
+        await hre.run('dodoc', { noCompile: true });
+    }
 });
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@primitivefi/hardhat-dodoc",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Zero-config Hardhat plugin to generate documentation for all your Solidity contracts",
@@ -5,0 +5,0 @@ "repository": "github:primitivefinance/primitive-dodoc",

No alert changes

Improved metrics

Total package byte prevSize

52221

increased by0.43%

No dependency changes