fix(app): linting issues

compodoc · Jan 16, 2019 · f94d664 · f94d664
1 parent 32daba3
commit f94d664
Show file tree

Hide file tree

Showing 24 changed files with 213 additions and 138 deletions.
diff --git a/src/app/application.ts b/src/app/application.ts
@@ -1,7 +1,7 @@
 import * as fs from 'fs-extra';
-import * as path from 'path';
 import * as LiveServer from 'live-server';
 import * as _ from 'lodash';
+import * as path from 'path';
 
 import { SyntaxKind } from 'ts-simple-ast';
 
@@ -10,32 +10,34 @@ const marked = require('marked');
 const traverse = require('traverse');
 
 import { logger } from '../utils/logger';
+
+import Configuration from './configuration';
+
+import DependenciesEngine from './engines/dependencies.engine';
+import ExportEngine from './engines/export.engine';
+import FileEngine from './engines/file.engine';
 import HtmlEngine from './engines/html.engine';
+import I18nEngine from './engines/i18n.engine';
 import MarkdownEngine from './engines/markdown.engine';
-import FileEngine from './engines/file.engine';
-import Configuration from './configuration';
 import NgdEngine from './engines/ngd.engine';
 import SearchEngine from './engines/search.engine';
-import ExportEngine from './engines/export.engine';
-import I18nEngine from './engines/i18n.engine';
 
 import { AngularDependencies } from './compiler/angular-dependencies';
 import { AngularJSDependencies } from './compiler/angularjs-dependencies';
 
-import { COMPODOC_DEFAULTS } from '../utils/defaults';
+import AngularVersionUtil from '../utils/angular-version.util';
 import { COMPODOC_CONSTANTS } from '../utils/constants';
+import { COMPODOC_DEFAULTS } from '../utils/defaults';
+import { promiseSequential } from '../utils/promise-sequential';
+import RouterParserUtil from '../utils/router-parser.util';
 
 import {
-    findMainSourceFolder,
     cleanNameWithoutSpaceAndToLowerCase,
-    cleanSourcesForWatch
+    cleanSourcesForWatch,
+    findMainSourceFolder
 } from '../utils/utils';
 
-import { promiseSequential } from '../utils/promise-sequential';
-import DependenciesEngine from './engines/dependencies.engine';
-import RouterParserUtil from '../utils/router-parser.util';
-
-import AngularVersionUtil from '../utils/angular-version.util';
+import { CoverageData } from './interfaces/coverageData.interface';
 
 let cwd = process.cwd();
 let startTime = new Date();
@@ -745,18 +747,17 @@ export class Application {
 
                     const parsedSummaryData = JSON.parse(summaryData);
 
-                    let that = this,
-                        level = 0;
+                    let that = this;
 
                     traverse(parsedSummaryData).forEach(function() {
                         if (this.notRoot && typeof this.node === 'object') {
                             let rawPath = this.path;
-                            let file = this.node['file'];
-                            let title = this.node['title'];
+                            let file = this.node.file;
+                            let title = this.node.title;
                             let finalPath = Configuration.mainData.includesFolder;
 
                             let finalDepth = rawPath.filter(el => {
-                                return !isNaN(parseInt(el));
+                                return !isNaN(parseInt(el, 10));
                             });
 
                             if (typeof file !== 'undefined' && typeof title !== 'undefined') {
@@ -769,7 +770,7 @@ export class Application {
                                             ? parsedSummaryData
                                             : lastElementRootTree;
                                     if (typeof elementTree.children !== 'undefined') {
-                                        elementTree = elementTree['children'][el];
+                                        elementTree = elementTree.children[el];
                                     } else {
                                         elementTree = elementTree[el];
                                     }
@@ -2310,11 +2311,13 @@ at least one config for the 'info' or 'source' tab in --navTabConfig.`);
         return new Promise((resolve, reject) => {
             let covDat, covFileNames;
 
-            if (!Configuration.mainData.coverageData['files']) {
+            let coverageData: CoverageData = Configuration.mainData.coverageData;
+
+            if (!coverageData.files) {
                 logger.warn('Missing documentation coverage data');
             } else {
                 covDat = {};
-                covFileNames = _.map(Configuration.mainData.coverageData['files'], el => {
+                covFileNames = _.map(coverageData.files, el => {
                     let fileName = el.filePath;
                     covDat[fileName] = {
                         type: el.type,

diff --git a/src/app/compiler/angular-dependencies.ts b/src/app/compiler/angular-dependencies.ts
@@ -3,20 +3,20 @@ import * as path from 'path';
 import * as _ from 'lodash';
 import Ast, { ts, SyntaxKind } from 'ts-simple-ast';
 
-import { logger } from '../../utils/logger';
-import { markedtags, mergeTagsAndArgs, cleanLifecycleHooksFromMethods } from '../../utils/utils';
 import { kindToType } from '../../utils/kind-to-type';
+import { logger } from '../../utils/logger';
+import { cleanLifecycleHooksFromMethods, markedtags, mergeTagsAndArgs } from '../../utils/utils';
 import ComponentsTreeEngine from '../engines/components-tree.engine';
 
 import { FrameworkDependencies } from './framework-dependencies';
 
 import ImportsUtil from '../../utils/imports.util';
 
 import {
-    JsdocParserUtil,
-    isModuleWithProviders,
     getModuleWithProviders,
-    isIgnore
+    isIgnore,
+    isModuleWithProviders,
+    JsdocParserUtil
 } from '../../utils';
 
 import ExtendsMerger from '../../utils/extends-merger.util';
@@ -25,24 +25,24 @@ import RouterParserUtil from '../../utils/router-parser.util';
 
 import { CodeGenerator } from './angular/code-generator';
 
-import { DirectiveDepFactory } from './angular/deps/directive-dep.factory';
-import { ComponentCache } from './angular/deps/helpers/component-helper';
-import { ModuleDepFactory } from './angular/deps/module-dep.factory';
 import { ComponentDepFactory } from './angular/deps/component-dep.factory';
 import { ControllerDepFactory } from './angular/deps/controller-dep.factory';
-import { ModuleHelper } from './angular/deps/helpers/module-helper';
+import { DirectiveDepFactory } from './angular/deps/directive-dep.factory';
+import { ComponentCache } from './angular/deps/helpers/component-helper';
 import { JsDocHelper } from './angular/deps/helpers/js-doc-helper';
+import { ModuleHelper } from './angular/deps/helpers/module-helper';
 import { SymbolHelper } from './angular/deps/helpers/symbol-helper';
+import { ModuleDepFactory } from './angular/deps/module-dep.factory';
 
 import Configuration from '../configuration';
 
 import {
-    IInjectableDep,
-    IPipeDep,
     IDep,
-    IInterfaceDep,
-    IFunctionDecDep,
     IEnumDecDep,
+    IFunctionDecDep,
+    IInjectableDep,
+    IInterfaceDep,
+    IPipeDep,
     ITypeAliasDecDep
 } from './angular/dependencies.interfaces';
 

diff --git a/src/app/compiler/angular/deps/helpers/component-helper.ts b/src/app/compiler/angular/deps/helpers/component-helper.ts
@@ -1,8 +1,7 @@
 import { ts } from 'ts-simple-ast';
-import { SymbolHelper, IParseDeepIdentifierResult } from './symbol-helper';
 import { detectIndent } from '../../../../../utils';
-import { IDep, Deps } from '../../dependencies.interfaces';
 import { ClassHelper } from './class-helper';
+import { IParseDeepIdentifierResult, SymbolHelper } from './symbol-helper';
 
 export class ComponentHelper {
     constructor(

diff --git a/src/app/compiler/angularjs-dependencies.ts b/src/app/compiler/angularjs-dependencies.ts
@@ -1,8 +1,8 @@
-import { FrameworkDependencies } from './framework-dependencies';
 import { ComponentCache } from './angular/deps/helpers/component-helper';
-import { ModuleHelper } from './angular/deps/helpers/module-helper';
 import { JsDocHelper } from './angular/deps/helpers/js-doc-helper';
+import { ModuleHelper } from './angular/deps/helpers/module-helper';
 import { SymbolHelper } from './angular/deps/helpers/symbol-helper';
+import { FrameworkDependencies } from './framework-dependencies';
 
 export class AngularJSDependencies extends FrameworkDependencies {
     private engine: any;

diff --git a/src/app/configuration.ts b/src/app/configuration.ts
@@ -1,8 +1,10 @@
+import * as _ from 'lodash';
+
 import { COMPODOC_DEFAULTS } from '../utils/defaults';
-import { PageInterface } from './interfaces/page.interface';
-import { MainDataInterface } from './interfaces/main-data.interface';
+
 import { ConfigurationInterface } from './interfaces/configuration.interface';
-import * as _ from 'lodash';
+import { MainDataInterface } from './interfaces/main-data.interface';
+import { PageInterface } from './interfaces/page.interface';
 
 export class Configuration implements ConfigurationInterface {
     private _pages: PageInterface[] = [];

diff --git a/src/app/engines/components-tree.engine.ts b/src/app/engines/components-tree.engine.ts
@@ -1,7 +1,8 @@
-import * as path from 'path';
 import * as _ from 'lodash';
-import FileEngine from './file.engine';
+import * as path from 'path';
+
 import { logger } from '../../utils/logger';
+import FileEngine from './file.engine';
 
 const $: any = require('cheerio');
 

diff --git a/src/app/engines/dependencies.engine.ts b/src/app/engines/dependencies.engine.ts
@@ -1,26 +1,28 @@
 import * as _ from 'lodash';
 
-import { ParsedData } from '../interfaces/parsed-data.interface';
 import { MiscellaneousData } from '../interfaces/miscellaneous-data.interface';
-
-import { getNamesCompareFn } from '../../utils/utils';
-import { IModuleDep } from '../compiler/angular/deps/module-dep.factory';
-import { IComponentDep } from '../compiler/angular/deps/component-dep.factory';
-import { IDirectiveDep } from '../compiler/angular/deps/directive-dep.factory';
-import { IApiSourceResult } from '../../utils/api-source-result.interface';
+import { ParsedData } from '../interfaces/parsed-data.interface';
 import { RouteInterface } from '../interfaces/routes.interface';
+
 import AngularApiUtil from '../../utils/angular-api.util';
+import { IApiSourceResult } from '../../utils/api-source-result.interface';
+import { getNamesCompareFn } from '../../utils/utils';
+
 import {
+    IEnumDecDep,
+    IFunctionDecDep,
+    IGuardDep,
     IInjectableDep,
+    IInterceptorDep,
     IInterfaceDep,
     IPipeDep,
-    ITypeAliasDecDep,
-    IFunctionDecDep,
-    IEnumDecDep,
-    IInterceptorDep,
-    IGuardDep
+    ITypeAliasDecDep
 } from '../compiler/angular/dependencies.interfaces';
+
+import { IComponentDep } from '../compiler/angular/deps/component-dep.factory';
 import { IControllerDep } from '../compiler/angular/deps/controller-dep.factory';
+import { IDirectiveDep } from '../compiler/angular/deps/directive-dep.factory';
+import { IModuleDep } from '../compiler/angular/deps/module-dep.factory';
 
 const traverse = require('traverse');
 
@@ -104,8 +106,12 @@ export class DependenciesEngine {
     public init(data: ParsedData) {
         traverse(data).forEach(function(node) {
             if (node) {
-                if (node.parent) delete node.parent;
-                if (node.initializer) delete node.initializer;
+                if (node.parent) {
+                    delete node.parent;
+                }
+                if (node.initializer) {
+                    delete node.initializer;
+                }
             }
         });
         this.rawData = data;

diff --git a/src/app/engines/export-json.engine.ts b/src/app/engines/export-json.engine.ts
@@ -25,8 +25,12 @@ export class ExportJsonEngine {
 
         traverse(data).forEach(function(node) {
             if (node) {
-                if (node.parent) delete node.parent;
-                if (node.initializer) delete node.initializer;
+                if (node.parent) {
+                    delete node.parent;
+                }
+                if (node.initializer) {
+                    delete node.initializer;
+                }
             }
         });
 
@@ -43,7 +47,7 @@ export class ExportJsonEngine {
 
         return FileEngine.write(
             outputFolder + path.sep + '/documentation.json',
-            JSON.stringify(exportData, null, 4)
+            JSON.stringify(exportData, undefined, 4)
         ).catch(err => {
             logger.error('Error during export file generation ', err);
             return Promise.reject(err);

diff --git a/src/app/engines/html.engine.helpers.ts b/src/app/engines/html.engine.helpers.ts
@@ -1,40 +1,40 @@
 import * as Handlebars from 'handlebars';
 import * as _ from 'lodash';
 
-import { IHtmlEngineHelper } from './html-engine-helpers/html-engine-helper.interface';
+import { BreakCommaHelper } from './html-engine-helpers/break-comma.helper';
+import { BreakLinesHelper } from './html-engine-helpers/break-lines.helper';
+import { CleanParagraphHelper } from './html-engine-helpers/clean-paragraph.helper';
 import { CompareHelper } from './html-engine-helpers/compare.helper';
-import { OrHelper } from './html-engine-helpers/or.helper';
+import { DebugHelper } from './html-engine-helpers/debug.helper';
+import { ElementAloneHelper } from './html-engine-helpers/element-alone.helper';
+import { EscapeSimpleQuoteHelper } from './html-engine-helpers/escape-simple-quote.helper';
+import { FilterAngular2ModulesHelper } from './html-engine-helpers/filter-angular2-modules.helper';
 import { FunctionSignatureHelper } from './html-engine-helpers/function-signature.helper';
-import { IsNotToggleHelper } from './html-engine-helpers/is-not-toggle.helper';
+import { HasOwnHelper } from './html-engine-helpers/has-own.helper';
+import { IHtmlEngineHelper } from './html-engine-helpers/html-engine-helper.interface';
+import { I18nHelper } from './html-engine-helpers/i18n.helper';
+import { IfStringHelper } from './html-engine-helpers/if-string.helper';
+import { IndexableSignatureHelper } from './html-engine-helpers/indexable-signature.helper';
 import { IsInitialTabHelper } from './html-engine-helpers/is-initial-tab.helper';
+import { IsNotToggleHelper } from './html-engine-helpers/is-not-toggle.helper';
 import { IsTabEnabledHelper } from './html-engine-helpers/is-tab-enabled.helper';
-import { IfStringHelper } from './html-engine-helpers/if-string.helper';
-import { OrLengthHelper } from './html-engine-helpers/or-length.helper';
-import { FilterAngular2ModulesHelper } from './html-engine-helpers/filter-angular2-modules.helper';
-import { DebugHelper } from './html-engine-helpers/debug.helper';
-import { BreakLinesHelper } from './html-engine-helpers/break-lines.helper';
-import { CleanParagraphHelper } from './html-engine-helpers/clean-paragraph.helper';
-import { EscapeSimpleQuoteHelper } from './html-engine-helpers/escape-simple-quote.helper';
-import { BreakCommaHelper } from './html-engine-helpers/break-comma.helper';
-import { ModifKindHelper } from './html-engine-helpers/modif-kind-helper';
-import { ModifIconHelper } from './html-engine-helpers/modif-icon.helper';
-import { RelativeURLHelper } from './html-engine-helpers/relative-url.helper';
-import { JsdocReturnsCommentHelper } from './html-engine-helpers/jsdoc-returns-comment.helper';
 import { JsdocCodeExampleHelper } from './html-engine-helpers/jsdoc-code-example.helper';
+import { JsdocDefaultHelper } from './html-engine-helpers/jsdoc-default.helper';
 import { JsdocExampleHelper } from './html-engine-helpers/jsdoc-example.helper';
-import { JsdocParamsHelper } from './html-engine-helpers/jsdoc-params.helper';
 import { JsdocParamsValidHelper } from './html-engine-helpers/jsdoc-params-valid.helper';
-import { JsdocDefaultHelper } from './html-engine-helpers/jsdoc-default.helper';
+import { JsdocParamsHelper } from './html-engine-helpers/jsdoc-params.helper';
+import { JsdocReturnsCommentHelper } from './html-engine-helpers/jsdoc-returns-comment.helper';
 import { LinkTypeHelper } from './html-engine-helpers/link-type.helper';
-import { IndexableSignatureHelper } from './html-engine-helpers/indexable-signature.helper';
-import { ObjectHelper } from './html-engine-helpers/object.helper';
+import { ModifIconHelper } from './html-engine-helpers/modif-icon.helper';
+import { ModifKindHelper } from './html-engine-helpers/modif-kind-helper';
 import { ObjectLengthHelper } from './html-engine-helpers/object-length.helper';
-import { ParseDescriptionHelper } from './html-engine-helpers/parse-description.helper';
+import { ObjectHelper } from './html-engine-helpers/object.helper';
 import { OneParameterHasHelper } from './html-engine-helpers/one-parameter-has.helper';
-import { ElementAloneHelper } from './html-engine-helpers/element-alone.helper';
-import { HasOwnHelper } from './html-engine-helpers/has-own.helper';
+import { OrLengthHelper } from './html-engine-helpers/or-length.helper';
+import { OrHelper } from './html-engine-helpers/or.helper';
+import { ParseDescriptionHelper } from './html-engine-helpers/parse-description.helper';
+import { RelativeURLHelper } from './html-engine-helpers/relative-url.helper';
 import { ShortURLHelper } from './html-engine-helpers/short-url.helper';
-import { I18nHelper } from './html-engine-helpers/i18n.helper';
 
 export class HtmlEngineHelpers {
     public registerHelpers(bars): void {

diff --git a/src/app/engines/html.engine.ts b/src/app/engines/html.engine.ts
@@ -1,23 +1,20 @@
-import * as path from 'path';
 import * as Handlebars from 'handlebars';
+import * as path from 'path';
 
 import { logger } from '../../utils/logger';
-import { HtmlEngineHelpers } from './html.engine.helpers';
-import Configuration from '../configuration';
 import FileEngine from './file.engine';
+import { HtmlEngineHelpers } from './html.engine.helpers';
 
 export class HtmlEngine {
     private cache: { page: string } = {} as any;
     private compiledPage;
 
     private precompiledMenu;
-    private compiledMobileMenu;
-    private compiledMenu;
 
     private static instance: HtmlEngine;
     private constructor() {
         const helper = new HtmlEngineHelpers();
-        helper.registerHelpers(Handlebars, Configuration);
+        helper.registerHelpers(Handlebars);
     }
     public static getInstance() {
         if (!HtmlEngine.instance) {
@@ -79,7 +76,6 @@ export class HtmlEngine {
                 logger.warn(
                     'Template path specificed but does not exist...using default templates'
                 );
-                // new Error('Template path specified but does not exist');
             }
         }
 

diff --git a/src/app/engines/i18n.engine.ts b/src/app/engines/i18n.engine.ts
@@ -3,8 +3,8 @@ import i18next from 'i18next';
 import {
     TRANSLATION_EN_US,
     TRANSLATION_FR_FR,
-    TRANSLATION_ZH_CN,
-    TRANSLATION_PT_BR
+    TRANSLATION_PT_BR,
+    TRANSLATION_ZH_CN
 } from '../../locales';
 
 class I18nEngine {