Merge pull request #50 from IgniteUI/source-file-extraction

expose option enabling warnings
IgniteUI · Feb 25, 2020 · 6ccd791 · 6ccd791
2 parents 7c12184 + 85fbe9a
commit 6ccd791
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/components/render-component.ts b/components/render-component.ts
@@ -11,6 +11,8 @@ import { LogLevel } from 'typedoc/dist/lib/utils';
 
 @Component({ name: 'render-component'})
 export class RenderComponenet extends RendererComponent {
+    private warns: boolean;
+
     fileOperations: FileOperations;
     /**
      * Contains data per every processed Object like (Class, Inteface, Enum) 
@@ -44,6 +46,7 @@ export class RenderComponenet extends RendererComponent {
         const reflections = event.project.reflections;
         const options = this.application.options.getRawValues();
         const localizeOpt = options[Constants.RENDER_OPTION];
+        this.warns = options[Constants.WARNS];
         if (localizeOpt) {
             this.mainDirOfJsons = localizeOpt;
             this.globalFuncsData = this.fileOperations.getFileData(this.mainDirOfJsons, Constants.GLOBAL_FUNCS_FILE_NAME, 'json');
@@ -165,7 +168,9 @@ export class RenderComponenet extends RendererComponent {
             tag.tagName = tagFromJson[Constants.COMMENT].tagName;
             tag.text = this.parser.joinByCharacter(tagFromJson[Constants.COMMENT].text, '\n');
           } catch (e) {
-            this.application.logger.log(`Could not find ${tag.tagName} tag of ${reflection.parent.name} in ${reflection.parent.parent.name}`, LogLevel.Warn);
+            if (this.warns) {
+              this.application.logger.log(`Could not find ${tag.tagName} tag of ${reflection.parent.name} in ${reflection.parent.parent.name}`, LogLevel.Warn);
+            }
           }
         });
       }
@@ -176,7 +181,9 @@ export class RenderComponenet extends RendererComponent {
           try {
             param.comment.text = this.parser.joinByCharacter(paramFromJson[Constants.COMMENT].text, '\n');
           } catch(e) {
-            this.application.logger.log(`Could not find ${param.name} parameter of ${reflection.parent.name} in ${reflection.parent.parent.name}`, LogLevel.Warn);
+            if (this.warns) {
+              this.application.logger.log(`Could not find ${param.name} parameter of ${reflection.parent.name} in ${reflection.parent.parent.name}`, LogLevel.Warn);
+            }
           }
         });
       }

diff --git a/utils/constants.ts b/utils/constants.ts
@@ -7,6 +7,7 @@ export class Constants {
     static readonly PARAMS = 'parameters';
     static readonly RETURNS = 'returns';
     static readonly TAGS = 'tags';
+    static readonly WARNS = 'warns';
     static readonly TAG_NAME = 'tagName';
     static readonly COMMENT = 'comment';
     static readonly TEXT = 'text';
@@ -20,6 +21,7 @@ export class Constants {
     static readonly SHORT_CONVERT_OPTION = 'gen-json';
     static readonly SHORT_RENDER_OPTION = 'gen-from-json';
     static readonly INCLUDE_TAGS_OPTION = 'tags';
+    static readonly INCLUDE_WARNS_OPTION = 'warns';
     static readonly INCLUDE_PARAMS_OPTION = 'params';
     static readonly LOCALIZE_OPTION = 'localize'
     static readonly TEMPLATE_STRINGS_OPTION = 'templateStrings';

diff --git a/utils/options.ts b/utils/options.ts
@@ -14,29 +14,36 @@ export function pluginOptions(options: Options) {
       name: Constants.RENDER_OPTION,
       short: Constants.SHORT_RENDER_OPTION,
       help: 'Specify from where to get the loclized json data.'
-  })
+  });
 
   options.addDeclaration({
       name: Constants.INCLUDE_TAGS_OPTION,
       help: 'Specify whether to include tags per comment.',
       type: ParameterType.Boolean,
-      defaultValue: true
-  })        
+      defaultValue: false
+  });       
 
   options.addDeclaration({
       name: Constants.INCLUDE_PARAMS_OPTION,
       help: 'Specify whether to include params per comment.',
       type: ParameterType.Boolean,
-      defaultValue: true
-  })
+      defaultValue: false
+  });
+
+  options.addDeclaration({
+      name: Constants.INCLUDE_WARNS_OPTION,
+      help: 'Specify whether to throw warnings of missed tags and parameters into the json\'s.',
+      type: ParameterType.Boolean,
+      defaultValue: false
+  });
 
   options.addDeclaration({
       name: Constants.LOCALIZE_OPTION,
       help: 'Specify your localization for instance (jp)'
-  })
+  });
 
   options.addDeclaration({
       name: Constants.TEMPLATE_STRINGS_OPTION,
       help: 'Path to the json file which contains your localized template strings'
-  })
+  });
 }