Включить типы потоков в JSDoc

Question

Я читал некоторые вопросы по github и проектам, построенным поверх Flow, для создания "моста" между Flow и JSDoc или просто для генерации JSDoc из аннотации типов Flow.

Никто из них не ответил на эту "простую" потребность, которую я имею:
Q: Как включить типы потока в JSDoc?

Я не хочу избавляться от блоков комментариев JSDoc, потому что они предназначены не только для проверки типов, но также для документирования и объяснения кода другим или вашему будущему себе.

Что я хочу это:

// @flow
// This file should be parsed by flow   

// 1) Use all the advantages of flow
type MyObject = {
  foo: number,
  bar: boolean,
  baz: string,
}; 

// later..

// 2) Comment AND annotate FLOW TYPE using JSDoc, not the Flow syntax
/**
 * Make super complex thing
 * @param {MyObject} val an object of type MyObject
 * @returns {String} an interesting value
 */
function superComplexThingy(val) { 
  return val.baz  
}

Подводя итог, я хотел бы:

1. Используйте все преимущества потока (как определение типа выше)
2. Комментируйте и комментируйте ТИП FLOW, используя JSDoc, а не синтаксис Flow

Это возможно? Как?

Answer 1

Супер поздний ответ, но это не то, что поддерживается Flow, и, скорее всего, не будет поддерживаться. Если вы хотите написать свой собственный транспортер для преобразования некоторых комментариев jsdoc в типы потока, вы можете сделать это, но это займет много работы.

Некоторые пытались поработать над этим, но он не слишком активен: https://github.com/Kegsay/flow-jsdoc