feat(UI): disableTemplateTab flag

fix #545
compodoc · Apr 25, 2018 · fed52f1 · fed52f1
1 parent 40e8686
commit fed52f1
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 3 deletions.
diff --git a/src/app/configuration.ts b/src/app/configuration.ts
@@ -42,6 +42,7 @@ export class Configuration implements ConfigurationInterface {
         includesFolder: COMPODOC_DEFAULTS.additionalEntryPath,
         disableSourceCode: COMPODOC_DEFAULTS.disableSourceCode,
         disableDomTree: COMPODOC_DEFAULTS.disableDomTree,
+        disableTemplateTab: COMPODOC_DEFAULTS.disableTemplateTab,
         disableGraph: COMPODOC_DEFAULTS.disableGraph,
         disableMainGraph: COMPODOC_DEFAULTS.disableMainGraph,
         disableCoverage: COMPODOC_DEFAULTS.disableCoverage,

diff --git a/src/app/interfaces/main-data.interface.ts b/src/app/interfaces/main-data.interface.ts
@@ -34,6 +34,7 @@ export interface MainDataInterface {
     includesFolder: string;
     disableSourceCode: boolean;
     disableDomTree: boolean;
+    disableTemplateTab: boolean;
     disableGraph: boolean;
     disableMainGraph: boolean;
     disableCoverage: boolean;

diff --git a/src/index-cli.ts b/src/index-cli.ts
@@ -109,6 +109,7 @@ export class CliApplication extends Application {
                 false
             )
             .option('--disableDomTree', 'Do not add dom tree tab', false)
+            .option('--disableTemplateTab', 'Do not add template tab', false)
             .option('--disableGraph', 'Do not add the dependency graph', false)
             .option('--disableCoverage', 'Do not add the documentation coverage report', false)
             .option('--disablePrivate', 'Do not show private in generated documentation', false)
@@ -223,6 +224,10 @@ export class CliApplication extends Application {
             this.configuration.mainData.disableDomTree = program.disableDomTree;
         }
 
+        if (program.disableTemplateTab) {
+            this.configuration.mainData.disableTemplateTab = program.disableTemplateTab;
+        }
+
         if (program.disableGraph) {
             this.configuration.mainData.disableGraph = program.disableGraph;
         }

diff --git a/src/templates/partials/component.hbs b/src/templates/partials/component.hbs
@@ -20,9 +20,11 @@
     {{/unless}}
 
     {{#if component.templateData}}
-    <li>
-        <a href="#templateData" role="tab" id="templateData-tab" data-toggle="tab" data-link="template">Template</a>
-    </li>
+        {{#unless disableTemplateTab}}
+        <li>
+            <a href="#templateData" role="tab" id="templateData-tab" data-toggle="tab" data-link="template">Template</a>
+        </li>
+        {{/unless}}
     {{/if}}
     {{#unless disableDomTree}}
     <li>

diff --git a/src/utils/defaults.ts b/src/utils/defaults.ts
@@ -14,6 +14,7 @@ export const COMPODOC_DEFAULTS = {
     toggleMenuItems: ['all'],
     disableSourceCode: false,
     disableDomTree: false,
+    disableTemplateTab: false,
     disableGraph: false,
     disableMainGraph: false,
     disableCoverage: false,

diff --git a/test/src/cli/cli-generation.spec.ts b/test/src/cli/cli-generation.spec.ts
@@ -618,6 +618,33 @@ describe('CLI simple generation', () => {
         });
     });
 
+    describe('when generation with --disableTemplateTab flag', () => {
+
+        let stdoutString = undefined,
+            index = undefined;
+        before(function (done) {
+            tmp.create(distFolder);
+            let ls = shell('node', [
+                './bin/index-cli.js',
+                '-p', './test/src/sample-files/tsconfig.simple.json',
+                '--disableTemplateTab',
+                '-d', distFolder]);
+
+            if (ls.stderr.toString() !== '') {
+                console.error(`shell error: ${ls.stderr.toString()}`);
+                done('error');
+            }
+            stdoutString = ls.stdout.toString();
+            done();
+        });
+        after(() => tmp.clean(distFolder));
+
+        it('should not contain template tab', () => {
+            index = read(`${distFolder}/components/BarComponent.html`);
+            expect(index).to.not.contain('id="templateData-tab"');
+        });
+    });
+
     describe('when generation with --disableGraph flag', () => {
 
         let stdoutString = undefined,

diff --git a/test/src/cli/cli-options.spec.ts b/test/src/cli/cli-options.spec.ts
@@ -122,6 +122,11 @@ describe('CLI Options', () => {
             expect(runHelp.stdout.toString()).to.contain('Do not add source code tab');
         });
 
+        it(`--disableTemplateTab`, () => {
+            expect(runHelp.stdout.toString()).to.contain('--disableTemplateTab');
+            expect(runHelp.stdout.toString()).to.contain('Do not add template tab');
+        });
+
         it(`--disableGraph`, () => {
             expect(runHelp.stdout.toString()).to.contain('--disableGraph');
             expect(runHelp.stdout.toString()).to.contain('Do not add the dependency graph');