feat: optional template argument

lib/args.d.ts

@@ -7,5 +7,7 @@ export declare const options: import("yargs").Argv<{
     compiler: string;
 } & {
     format: "markdown";
+} & {
+    template: string;
 }>;
 export declare const printCliArguments: (x: unknown) => void;

lib/args.js

@@ -29,6 +29,12 @@ exports.options = yargs_1.option("input", {
     type: "string",
     description: "ddocs format",
     "default": types_1.cliArgumentsDefault.format
+})
+    .option("template", {
+    alias: "t",
+    type: "string",
+    description: "template to use",
+    "default": types_1.cliArgumentsDefault.template
 })
     .help()
     .alias("help", "h");

lib/bin/vydoc.js

@@ -51,7 +51,7 @@ var vyperFileExtentions = ["vy"];
                     switch (_a.label) {
                         case 0: return [4 /*yield*/, compile_1.compileContracts(argv.input, filePaths, argv.compiler)
                                 .then(ramda_1.tap(function () { return console.log(chalk_1.blue("\nGenerate docs...")); }))
-                                .then(function (contracts) { return generate_1.generateDocs(argv.format, argv.output, contracts); })];
+                                .then(function (contracts) { return generate_1.generateDocs(argv.format, argv.output, contracts, argv.template); })];
                         case 1: return [2 /*return*/, _a.sent()];
                     }
                 });

lib/generate.d.ts

@@ -2,4 +2,4 @@ import { Contract, Format } from "./types";
 export declare const generateDocs: (format: Format, output: string, contracts: {
     fileName: string;
     data: Contract;
-}[]) => Promise<any>;
+}[], templatePath: string) => Promise<any>;

lib/generate.js

@@ -45,10 +45,10 @@ var fs_1 = require("fs");
 var path_1 = require("path");
 var ramda_1 = require("ramda");
 var progress_1 = require("./progress");
-var generateDocs = function (format, output, contracts) { return __awaiter(void 0, void 0, void 0, function () {
+var generateDocs = function (format, output, contracts, templatePath) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, ramda_1.cond([
-                [ramda_1.equals("markdown"), function () { return generateMarkDown(contracts, output); }],
+                [ramda_1.equals("markdown"), function () { return generateMarkDown(contracts, output, templatePath); }],
                 [
                     ramda_1.T,
                     function () {
@@ -59,7 +59,7 @@ var generateDocs = function (format, output, contracts) { return __awaiter(void
     });
 }); };
 exports.generateDocs = generateDocs;
-var generateMarkDown = function (contracts, output) { return __awaiter(void 0, void 0, void 0, function () {
+var generateMarkDown = function (contracts, output, templatePath) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, ramda_1.pipe(fs_1.readFileSync, function (buffer) { return buffer.toString(); }, ejs_1["default"].compile, function (template) {
                 return ramda_1.pipe(function (handler) {
@@ -77,6 +77,6 @@ var generateMarkDown = function (contracts, output) { return __awaiter(void 0, v
                     }))
                         .map(ramda_1.tap(handler));
                 })(progress_1.makeProgressBar(contracts.length));
-            })(path_1.join(__dirname, "../src/templates/markdown.ejs"))];
+            })(templatePath)];
     });
 }); };

lib/table.d.ts

@@ -1,4 +1,4 @@
-interface TableOptions {
+export interface TableOptions {
     chars: Partial<Record<"top" | "top-mid" | "top-left" | "top-right" | "bottom" | "bottom-mid" | "bottom-left" | "bottom-right" | "left" | "left-mid" | "mid" | "mid-mid" | "right" | "right-mid" | "middle", string>>;
     truncate: string;
     colors: boolean;
@@ -14,4 +14,3 @@ interface TableOptions {
     head: string[];
 }
 export declare const makeTable: (options?: Partial<TableOptions> | undefined) => (values: any[]) => string;
-export {};

lib/types.d.ts

@@ -3,6 +3,7 @@ export declare type CliArguments = {
     output: string;
     compiler: string;
     format: Format;
+    template: string;
 };
 export declare type Format = "markdown";
 export declare const cliArgumentsDefault: CliArguments;

lib/types.js

@@ -5,5 +5,6 @@ exports.cliArgumentsDefault = {
     input: "./contracts",
     output: "./docs",
     compiler: "vyper",
-    format: "markdown"
+    format: "markdown",
+    template: "../src/templates/markdown.ejs"
 };

package.json

@@ -49,6 +49,7 @@
         "@types/ejs": "^3.0.6",
         "@types/node": "^14.14.35",
         "@types/ramda": "^0.27.39",
-        "@types/yargs": "^16.0.0"
+        "@types/yargs": "^16.0.0",
+        "typescript": "^4.2.4"
     }
-}
+}

src/args.ts

@@ -28,6 +28,12 @@ export const options = option("input", {
     description: "ddocs format",
     default: cliArgumentsDefault.format,
   })
+  .option("template", {
+    alias: "t",
+    type: "string",
+    description: "template to use",
+    default: cliArgumentsDefault.template, 
+  })
   .help()
   .alias("help", "h");
 

src/bin/vydoc.ts

@@ -18,5 +18,5 @@ const vyperFileExtentions = ["vy"];
     async (filePaths) =>
       await compileContracts(argv.input, filePaths, argv.compiler)
         .then(tap(() => console.log(blue("\nGenerate docs..."))))
-        .then((contracts) => generateDocs(argv.format, argv.output, contracts))
+        .then((contracts) => generateDocs(argv.format, argv.output, contracts, argv.template))
   )(argv))(options.argv);

src/generate.ts

@@ -4,14 +4,16 @@ import { join } from "path";
 import { cond, equals, pipe, T, tap } from "ramda";
 import { makeProgressBar } from "./progress";
 import { Contract, Format } from "./types";
+import path from 'path';
 
 export const generateDocs = async (
   format: Format,
   output: string,
-  contracts: { fileName: string; data: Contract }[]
+  contracts: { fileName: string; data: Contract }[],
+  templatePath: string
 ) =>
   cond<Format, any>([
-    [equals("markdown"), () => generateMarkDown(contracts, output)],
+    [equals("markdown"), () => generateMarkDown(contracts, output, templatePath)],
     [
       T,
       () => {
@@ -22,7 +24,8 @@ export const generateDocs = async (
 
 const generateMarkDown = async (
   contracts: { fileName: string; data: Contract }[],
-  output: string
+  output: string,
+  templatePath: string
 ) =>
   pipe(
     readFileSync,
@@ -51,4 +54,4 @@ const generateMarkDown = async (
           )
           .map(tap(handler))
       )(makeProgressBar(contracts.length))
-  )(join(__dirname, "../src/templates/markdown.ejs"));
+  )(templatePath);

src/table.ts

@@ -1,6 +1,6 @@
 import Table from "cli-table";
 
-interface TableOptions {
+export interface TableOptions {
   chars: Partial<
     Record<
       | "top"

src/types.ts

@@ -3,6 +3,7 @@ export type CliArguments = {
   output: string;
   compiler: string;
   format: Format;
+  template: string
 };
 
 export type Format = "markdown";
@@ -12,6 +13,7 @@ export const cliArgumentsDefault = {
   output: "./docs",
   compiler: "vyper",
   format: "markdown",
+  template: "../src/templates/markdown.ejs"
 } as CliArguments;
 
 export type Contract = {