Merge pull request #182 from SoftwareBrothers/handle-ts-types-definitions

feat: handle TS types definitions

Author: ariansobczak-rst

fixtures/interface.ts renamed to fixtures/typescript/interface.ts

@@ -8,7 +8,7 @@ export enum PropertyPlace {
 /**
  * JSON representation of a Property.
  */
-type PropertyJSON = {
+interface PropertyJSON {
  /**
  * If given property should be treated as a title
  */

fixtures/typescript/type.ts

@@ -0,0 +1,20 @@
+/**
+ * Example of union type definition
+ */
+type SomeCombinedType = string | number | 'Specific string' | SomeOtherType;
+
+
+/**
+ * Example of simple type definition
+ */
+type SomeOtherType = boolean;
+
+/**
+ * Example of generic type definition with T as parameter
+ */
+type SomeGenericType<T> = T | SomeOtherGenericType<T> | { property: T, other: string }
+
+/**
+ * Example of generic type definition with T as parameter
+ */
+type SomeOtherGenericType<T> = { children: T[] }

tmpl/type.tmpl

@@ -2,6 +2,6 @@
  var data = obj;
  var self = this;
  data.forEach(function(name, i) { ?>
-<span class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></span>
+<code class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></code>
 <?js if (i < data.length-1) { ?>|<?js } ?>
 <?js }); ?>

typescript/type-converter.js

@@ -163,6 +163,11 @@ module.exports = function typeConverter(src, filename = 'test.ts') {
  comment = appendComment(comment, `@typedef {object} ${name}`)
  return convertMembers(comment, statement.type, src)
  }
+ if (ts.isUnionTypeNode(statement.type) || ts.isSimpleInlineableExpression(statement.type)) {
+ let typeName = getTypeName(statement.type, src)
+ comment = appendComment(comment, `@typedef {${typeName}} ${name}`)
+ return convertMembers(comment, statement.type, src)
+ } 
  }
  if (ts.isInterfaceDeclaration(statement)) {
  comment = appendComment(comment, `@interface ${name}`)

typescript/type-converter.spec.js

@@ -1,10 +1,6 @@
-const fs = require('fs')
-const path = require('path')
 const { expect } = require('chai')
 const typeConverter = require('./type-converter')
 
-const src = fs.readFileSync(path.join(__dirname, '../fixtures/typescript/entity.ts'), 'utf-8')
-
 const interface1 = require('../fixtures/typescript/interface1')
 const interface2 = require('../fixtures/typescript/interface2')
 const interface3 = require('../fixtures/typescript/interface3')
@@ -98,8 +94,5 @@ describe('.typeConverter', function () {
  })
  })
 
-
- // it.only('parses test', function() {
- // console.log(typeConverter(src, '../fixtures/interface.ts'))
- // })
+ // TODO: Provide tests for typescript
 })