From 9f0dfb1e1a4c97e462cf298e0452be1d0fcf2216 Mon Sep 17 00:00:00 2001
From: "F. Eugene Aumson" <gene@aumson.org>
Date: Sat, 22 Sep 2018 10:31:47 -0400
Subject: feat: make sol-doc only document what's requested

if a list of contracts-to-document is passed into sol-doc, then the
output should only contain documentation for the contracts requested.

if an empty/undefined list is passed, then it should document all
contracts that were found.
---
 packages/sol-doc/src/solidity_doc_generator.ts | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

(limited to 'packages/sol-doc/src')

diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts
index 2586cf91c..074fb1f37 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -1,3 +1,5 @@
+import * as path from 'path';
+
 import * as _ from 'lodash';
 
 import {
@@ -34,8 +36,7 @@ export async function generateSolDocAsync(
     contractsDir: string,
     contractsToDocument?: string[],
 ): Promise<DocAgnosticFormat> {
-    const doc: DocAgnosticFormat = {};
-
+    const docWithDependencies: DocAgnosticFormat = {};
     const compilerOptions = _makeCompilerOptions(contractsDir, contractsToDocument);
     const compiler = new Compiler(compilerOptions);
     const compilerOutputs = await compiler.getCompilerOutputsAsync();
@@ -50,11 +51,25 @@ export async function generateSolDocAsync(
                 if (_.isUndefined(compiledContract.abi)) {
                     throw new Error('compiled contract did not contain ABI output');
                 }
-                doc[contractName] = _genDocSection(compiledContract);
+                docWithDependencies[contractName] = _genDocSection(compiledContract);
             }
         }
     }
 
+    let doc: DocAgnosticFormat = {};
+    if (_.isUndefined(contractsToDocument) || contractsToDocument.length === 0) {
+        doc = docWithDependencies;
+    } else {
+        for (const contractToDocument of contractsToDocument) {
+            const contractBasename = path.basename(contractToDocument);
+            const contractName =
+                contractBasename.lastIndexOf('.sol') === -1
+                    ? contractBasename
+                    : contractBasename.substring(0, contractBasename.lastIndexOf('.sol'));
+            doc[contractName] = docWithDependencies[contractName];
+        }
+    }
+
     return doc;
 }
 
-- 
cgit