Refactor JSON generation process to support a plugin architecture (#597)

* refactor JSON serialization from toObject() to serialization master plugin and child plugins, mimics 1:1 output of toObject() logic * add es6 core types (for Object.assign, arrays etc..) * add @depracated tag to all toObject() methods. It is essential that they are removed, if not the code will contain duplicate logic which is a risk over time. * flip the switch on serialization plugins * add some event data * fix typo in null check * support `TypeOperator` sertialization * fix wrong serialization of get/set/index signature this is a legacy bug that was taken from the old toObject implementation

Author: shlomiassaf

src/lib/application.ts

@@ -13,6 +13,7 @@ import { Minimatch, IMinimatch } from 'minimatch';
 
 import { Converter } from './converter/index';
 import { Renderer } from './output/renderer';
+import { Serializer } from './serialization';
 import { ProjectReflection } from './models/index';
 import { Logger, ConsoleLogger, CallbackLogger, PluginHost, writeFile } from './utils/index';
 
@@ -48,6 +49,11 @@ export class Application extends ChildableComponent<Application, AbstractCompone
  */
  renderer: Renderer;
 
+ /**
+ * The serializer used to generate JSON output.
+ */
+ serializer: Serializer;
+
  /**
  * The logger that should be used to output messages.
  */
@@ -92,6 +98,7 @@ export class Application extends ChildableComponent<Application, AbstractCompone
 
  this.logger = new ConsoleLogger();
  this.converter = this.addComponent<Converter>('converter', Converter);
+ this.serializer = this.addComponent<Serializer>('serializer', Serializer);
  this.renderer = this.addComponent<Renderer>('renderer', Renderer);
  this.plugins = this.addComponent('plugins', PluginHost);
  this.options = this.addComponent('options', Options);
@@ -221,7 +228,9 @@ export class Application extends ChildableComponent<Application, AbstractCompone
  }
 
  out = Path.resolve(out);
- writeFile(out, JSON.stringify(project.toObject(), null, '\t'), false);
+ const eventData = { outputDirectory: Path.dirname(out), outputFile: Path.basename(out) };
+ const ser = this.serializer.projectToObject(project, { begin: eventData, end: eventData });
+ writeFile(out, JSON.stringify(ser, null, '\t'), false);
  this.logger.success('JSON written to %s', out);
 
  return true;

src/lib/models/ReflectionCategory.ts

@@ -51,6 +51,7 @@ export class ReflectionCategory {
 
  /**
  * Return a raw object representation of this reflection category.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result = {

src/lib/models/ReflectionGroup.ts

@@ -89,6 +89,7 @@ export class ReflectionGroup {
 
  /**
  * Return a raw object representation of this reflection group.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result = {

src/lib/models/comments/comment.ts

@@ -99,6 +99,7 @@ export class Comment {
 
  /**
  * Return a raw object representation of this comment.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result: any = {};

src/lib/models/comments/tag.ts

@@ -30,6 +30,7 @@ export class CommentTag {
 
  /**
  * Return a raw object representation of this tag.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result: any = {

src/lib/models/reflections/abstract.ts

@@ -551,6 +551,7 @@ export abstract class Reflection {
 
  /**
  * Return a raw object representation of this reflection.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result: any = {

src/lib/models/reflections/container.ts

@@ -54,6 +54,7 @@ export class ContainerReflection extends Reflection {
 
  /**
  * Return a raw object representation of this reflection.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result = super.toObject();

src/lib/models/reflections/declaration.ts

@@ -181,6 +181,7 @@ export class DeclarationReflection extends ContainerReflection implements Defaul
 
  /**
  * Return a raw object representation of this reflection.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  let result = super.toObject();

src/lib/models/reflections/parameter.ts

@@ -27,6 +27,7 @@ export class ParameterReflection extends Reflection implements DefaultValueConta
 
  /**
  * Return a raw object representation of this reflection.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result = super.toObject();

src/lib/models/reflections/project.ts

@@ -126,6 +126,7 @@ export class ProjectReflection extends ContainerReflection {
 
  /**
  * Return a raw object representation of this reflection.
+ * @deprecated Use serializers instead
  */
  toObject(): any {
  const result = super.toObject();