Merge pull request #168 from docsbydoxdox/feature/cli-options

[feat] Added renderer config flags and package.

Author: neogeek

packages/doxdox-cli/src/index.ts

@@ -18,6 +18,7 @@ import doxdox, {
     getProjectPackage,
     getRootDirPath,
     loadPlugin,
+    parseConfigFromCLI,
     parseIgnoreConfig,
     sanitizePath
 } from 'doxdox-core';
@@ -109,6 +110,8 @@ const overridePackage = String(
         }
     );
 
+    const cliConfig = parseConfigFromCLI(args.raw);
+
     const nodeModulesDir = await findParentNodeModules(
         dirname(sanitizePath(import.meta.url))
     );
@@ -141,7 +144,11 @@ const overridePackage = String(
         name: overrideName || pkg.name || 'Untitled Project',
         description: overrideDescription || pkg.description || '',
         version: pkg.version,
-        homepage: pkg.homepage
+        homepage: pkg.homepage,
+        config: {
+            ...pkg.doxdoxConfig,
+            ...cliConfig
+        }
     });
 
     if (overrideOutput) {

packages/doxdox-core/src/types.ts

@@ -1,9 +1,6 @@
-export interface Options {
-    name?: string;
-    description?: string;
-    version?: string;
-    homepage?: string;
-}
+export type Config = {
+    [key in string]?: string | boolean;
+};
 
 export interface Doc extends Options {
     files: File[];
@@ -24,8 +21,17 @@ export interface Method {
     private: boolean;
 }
 
-export interface Package extends Options {
+export interface Options extends Package {
+    config?: Config;
+}
+
+export interface Package {
     exports?: string;
+    name?: string;
+    description?: string;
+    version?: string;
+    homepage?: string;
+    doxdoxConfig?: Config;
 }
 
 export interface Param {

packages/doxdox-core/src/utils.test.ts

@@ -9,6 +9,7 @@ import {
     getRootDirPath,
     isDirectory,
     isFile,
+    parseConfigFromCLI,
     parseIgnoreConfig,
     sanitizePath,
     slugify
@@ -98,6 +99,27 @@ describe('utils', () => {
         });
     });
 
+    describe('parseConfigFromCLI', () => {
+        it('parse config', () => {
+            expect(
+                parseConfigFromCLI([
+                    ['--version', true],
+                    ['-c', 'key1=value1'],
+                    ['-c', 'key2=value2'],
+                    ['--config', 'boolean1=true'],
+                    ['--config', 'boolean2=false']
+                ])
+            ).toEqual(
+                expect.objectContaining({
+                    key1: 'value1',
+                    key2: 'value2',
+                    boolean1: true,
+                    boolean2: false
+                })
+            );
+        });
+    });
+
     describe('parseIgnoreConfig', () => {
         it('parse ignore config', () => {
             expect(

packages/doxdox-core/src/utils.ts

@@ -88,11 +88,17 @@ export const getProjectPackage = async (cwd: string): Promise<Package> => {
     const projectPackagePath = await findFileInPath(cwd);
 
     if (projectPackagePath) {
-        const { name, description, version, exports, homepage } = JSON.parse(
-            await fs.readFile(projectPackagePath, 'utf8')
-        );
-
-        return { name, description, version, exports, homepage };
+        const { name, description, version, exports, homepage, doxdoxConfig } =
+            JSON.parse(await fs.readFile(projectPackagePath, 'utf8'));
+
+        return {
+            name,
+            description,
+            version,
+            exports,
+            homepage,
+            doxdoxConfig
+        };
     }
 
     return {};
@@ -141,6 +147,33 @@ export const isFile = async (path: string): Promise<boolean> => {
     }
 };
 
+/**
+ * Parse config key/value pairs from raw CLI flags.
+ *
+ *     console.log(await parseConfigFromCLI([['-c', 'key=value']]));
+ *
+ * @param {[string, string | boolean][]} rawFlags Raw flags from the CLI.
+ * @return {{ [key in string]: string | boolean }} Configs key/value pairs.
+ * @public
+ */
+
+export const parseConfigFromCLI = (
+    rawFlags: [string, string | boolean][]
+): {
+    [key in string]: string | boolean;
+} =>
+    rawFlags
+        .filter(([flag]) => ['-c', '--config'].includes(flag))
+        .reduce((all, [, config]) => {
+            const [key, value] = String(config).split('=');
+
+            if (['true', 'false'].includes(value)) {
+                return { ...all, [key]: value === 'true' ? true : false };
+            } else {
+                return { ...all, [key]: value };
+            }
+        }, {});
+
 /**
  * Parse contents of ignore file.
  *

packages/doxdox-renderer-bootstrap/src/index.ts

@@ -6,6 +6,8 @@ import hljs from 'highlight.js';
 
 import { Doc, File, Method } from 'doxdox-core';
 
+import { CustomConfig } from './types';
+
 const md = new MarkdownIt({
     html: true,
     linkify: true,
@@ -205,10 +207,15 @@ export default async (doc: Doc): Promise<string> => `<!DOCTYPE html>
           Documentation generated with
           <a href="https://github.com/docsbydoxdox/doxdox">doxdox</a>.
         </p>
-        <p>
+        ${
+            !doc.config ||
+            (doc.config as CustomConfig)['hideGeneratedTimestamp'] !== true
+                ? `<p>
           Generated on
           ${new Date().toDateString()} ${new Date().toTimeString()}
-        </p>
+        </p>`
+                : ''
+        }
       </div>
     </footer>
     <script>

packages/doxdox-renderer-bootstrap/src/types.ts

@@ -0,0 +1,5 @@
+import { Config } from 'doxdox-core';
+
+export interface CustomConfig extends Config {
+    hideGeneratedTimestamp?: boolean;
+}

packages/doxdox-renderer-dash/src/index.ts

@@ -16,6 +16,8 @@ import { getRootDirPath, slugify } from 'doxdox-core';
 
 import { Doc, Method } from 'doxdox-core';
 
+import { CustomConfig } from './types';
+
 const md = new MarkdownIt({
     html: true,
     linkify: true,
@@ -99,10 +101,15 @@ ${param.description ? `<p>${param.description}</p>` : ''}`
     Documentation generated with
     <a href="https://github.com/docsbydoxdox/doxdox">doxdox</a>.
   </p>
-  <p>
+  ${
+      !doc.config ||
+      (doc.config as CustomConfig)['hideGeneratedTimestamp'] !== true
+          ? `<p>
     Generated on
     ${new Date().toDateString()} ${new Date().toTimeString()}
-  </p>
+  </p>`
+          : ''
+  }
 </div>
 </footer>
 

packages/doxdox-renderer-dash/src/types.ts

@@ -0,0 +1,5 @@
+import { Config } from 'doxdox-core';
+
+export interface CustomConfig extends Config {
+    hideGeneratedTimestamp?: boolean;
+}

packages/doxdox-renderer-github-wiki/src/index.ts

@@ -4,9 +4,13 @@ import admzip from 'adm-zip';
 
 import { markdownTable } from 'markdown-table';
 
-import { Doc, Method } from 'doxdox-core';
+import { Config, Doc, Method } from 'doxdox-core';
 
-const renderMethod = (method: Method) => `## ${method.fullName}
+import { CustomConfig } from './types';
+
+const renderMethod = (method: Method, config: Config | undefined) => `## ${
+    method.fullName
+}
 
 ${method.description}
 
@@ -37,9 +41,11 @@ ${param.description || ''}`
 }
 
 Documentation generated with [doxdox](https://github.com/docsbydoxdox/doxdox)
-
-Generated on ${new Date().toDateString()} ${new Date().toTimeString()}
-`;
+${
+    !config || (config as CustomConfig)['hideGeneratedTimestamp'] !== true
+        ? `\nGenerated on ${new Date().toDateString()} ${new Date().toTimeString()}\n`
+        : ''
+}`;
 
 export default async (doc: Doc): Promise<string | Buffer> => {
     const zip = new admzip();
@@ -50,7 +56,7 @@ export default async (doc: Doc): Promise<string | Buffer> => {
                 file.methods.map(async method =>
                     zip.addFile(
                         join(file.path, `${method.name}.md`),
-                        Buffer.from(renderMethod(method), 'utf-8')
+                        Buffer.from(renderMethod(method, doc.config), 'utf-8')
                     )
                 )
             )

packages/doxdox-renderer-github-wiki/src/types.ts

@@ -0,0 +1,5 @@
+import { Config } from 'doxdox-core';
+
+export interface CustomConfig extends Config {
+    hideGeneratedTimestamp?: boolean;
+}