Fixed issue with flags

Author: darkmavis1980

bin/run

@@ -7,10 +7,10 @@ const MarkdownIndexGenerator = require('../lib/index.js');
 program
   .version(version)
   .arguments('<file>', 'The file to parse')
-  .option('-o', '--output <outputFile>', 'Output will be saved in the defined file')
-  .option('-d', '--depth <depth>', 'Depth of the headings to parse, 4 means \'till h4\'', 4)
-  .option('-t', '--title <title>', 'Title to add on top of the index, by default is \'## Index\'')
-  .option('-r', '--replace', 'Add the index to the source file', false)
+  .option('-o, --output <outputFile>', 'Output will be saved in the defined file')
+  .option('-d, --depth <depth>', 'Depth of the headings to parse, 4 means \'till h4\'', 4)
+  .option('-t, --title <title>', 'Title to add on top of the index, by default is \'## Index\'')
+  .option('-r, --replace <replace>', 'Add the index to the source file', false)
   .action(MarkdownIndexGenerator);
 
 program.parse();

src/constants.ts

@@ -1,2 +1,8 @@
+import { Flags } from './interfaces/types';
+
 export const INDEX_TAG = 'index';
 export const VALID_FORMATS = ['md', 'mdx'];
+export const DEFAULT_VALUES: Flags = {
+  replace: false,
+  depth: 4,
+}

src/index.ts

@@ -1,33 +1,32 @@
-import MarkDownParser from './classes/markdown'
+import MarkDownParser from './classes/markdown';
+import { Flags } from './interfaces/types';
+import { DEFAULT_VALUES } from './constants';
 
-interface Flags {
-  depth?: number;
-  title?: string;
-  output?: string;
-  replace?: string;
-}
+const MarkdownIndexGenerator = async(file: string, flags?: Flags) => {
+  if (!flags) {
+    flags = {...DEFAULT_VALUES};
+  }
 
-const MarkdownIndexGenerator = async(file: string, flags: Flags) => {
   if (!file) {
     throw 'Missing file to parse';
   }
 
   const parser = new MarkDownParser(file);
 
-  if (flags.depth) {
+  if (flags?.depth) {
     parser.setDepth(flags.depth);
   }
 
-  if (flags.title) {
+  if (flags?.title) {
     parser.setTitle(flags.title);
   }
 
   await parser.parse();
 
-  if (flags.output) {
+  if (flags?.output) {
     await parser.toFile(flags.output);
     console.log(`File ${flags.output} saved!`);
-  } else if (flags.replace) {
+  } else if (flags?.replace) {
     await parser.replaceOriginal();
     console.log(`File ${file} updated!`);
   } else {

src/interfaces/types.ts

@@ -1 +1,8 @@
-export type HeadingsRange = 2|3|4|5
+export type HeadingsRange = 2|3|4|5;
+
+export interface Flags {
+  depth: number;
+  replace: boolean;
+  title?: string;
+  output?: string;
+}

test/index.test.ts

@@ -0,0 +1,27 @@
+import MarkdownIndexGenerator from '../src/index'
+
+describe('MarkdownIndexGenerator', () => {
+  beforeEach(() => {
+    console.log = jest.fn();
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should show the generated menu', async () => {
+    await MarkdownIndexGenerator('./test/__mocks__/test.md');
+    expect(console.log).toHaveBeenCalledWith('--- Begin MarkDown ---');
+    expect(console.log).toHaveBeenCalledWith(expect.stringContaining('[Heading 2](#heading-2)'));
+    expect(console.log).toHaveBeenCalledWith(expect.stringContaining('- [Sub sub heading 4](#sub-sub-heading-4)'));
+    expect(console.log).toHaveBeenCalledWith('--- End Markdown ---');
+  });
+
+  it('should show the generated menu, but only at depth 2', async () => {
+    await MarkdownIndexGenerator('./test/__mocks__/test.md', { depth: 2, replace: false});
+    expect(console.log).toHaveBeenCalledWith('--- Begin MarkDown ---');
+    expect(console.log).toHaveBeenCalledWith(expect.stringContaining('[Heading 2](#heading-2)'));
+    expect(console.log).toHaveBeenCalledWith(expect.not.stringContaining('- [Sub sub heading 4](#sub-sub-heading-4)'));
+    expect(console.log).toHaveBeenCalledWith('--- End Markdown ---');
+  });
+});