mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
58 lines
1.2 KiB
JavaScript
58 lines
1.2 KiB
JavaScript
|
|
'use strict';
|
|
/* @flow */
|
|
|
|
var findTarget = require('./finders').findTarget,
|
|
flowDoctrine = require('../flow_doctrine'),
|
|
t = require('babel-types');
|
|
|
|
var constTypeMapping = {
|
|
'BooleanLiteral': {type: 'BooleanTypeAnnotation'},
|
|
'NumericLiteral': {type: 'NumberTypeAnnotation'},
|
|
'StringLiteral': {type: 'StringTypeAnnotation'}
|
|
};
|
|
|
|
/**
|
|
* Infers type tags by using Flow type annotations
|
|
*
|
|
* @name inferType
|
|
* @param {Object} comment parsed comment
|
|
* @returns {Object} comment with type tag inferred
|
|
*/
|
|
function inferType(comment/*: Comment */) {
|
|
if (comment.type) {
|
|
return comment;
|
|
}
|
|
|
|
var path = findTarget(comment.context.ast);
|
|
if (!path) {
|
|
return comment;
|
|
}
|
|
|
|
var n = path.node;
|
|
var type;
|
|
switch (n.type) {
|
|
case 'VariableDeclarator':
|
|
type = n.id.typeAnnotation;
|
|
if (!type && comment.kind === 'constant') {
|
|
type = constTypeMapping[n.init.type];
|
|
}
|
|
break;
|
|
case 'ClassProperty':
|
|
type = n.typeAnnotation;
|
|
break;
|
|
case 'TypeAlias':
|
|
type = n.right;
|
|
break;
|
|
}
|
|
if (type) {
|
|
if (t.isTypeAnnotation(type)) {
|
|
type = type.typeAnnotation;
|
|
}
|
|
comment.type = flowDoctrine(type);
|
|
}
|
|
return comment;
|
|
}
|
|
|
|
module.exports = inferType;
|