vue-docgen-api
Version:
Toolbox to extract information from Vue component files for documentation generation purposes.
152 lines (151 loc) • 8.09 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var bt = __importStar(require("@babel/types"));
var recast_1 = require("recast");
var tsUtils_1 = require("./utils/tsUtils");
var getDocblock_1 = __importDefault(require("../utils/getDocblock"));
var getDoclets_1 = __importDefault(require("../utils/getDoclets"));
var transformTagsIntoObject_1 = __importDefault(require("../utils/transformTagsIntoObject"));
/**
* Extract information from an setup-style VueJs 3 component
* about what props can be used with this component
* @param {NodePath} astPath
* @param {Array<NodePath>} componentDefinitions
* @param {string} originalFilePath
*/
exports.default = (0, tsUtils_1.defineHandler)(function setupSlotHandler(documentation, componentDefinition, astPath, opt) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
(0, recast_1.visit)(astPath.program, {
visitCallExpression: function (nodePath) {
if (nodePath.node.callee.type === 'Identifier' &&
nodePath.node.callee.name === 'defineSlots' &&
nodePath.node.typeParameters) {
var typeParamsPath = nodePath.get('typeParameters', 'params', 0);
if (bt.isTSTypeLiteral(typeParamsPath.node)) {
// if the slots are defined as a literal type
getSlotsFromLiteralType(documentation, typeParamsPath.get('members'));
}
else if (bt.isTSTypeReference(typeParamsPath.node) &&
bt.isIdentifier(typeParamsPath.node.typeName)) {
// its a reference to an interface or type
var typeName = typeParamsPath.node.typeName.name; // extract the identifier
// find it's definition in the file
var definitionPath = (0, tsUtils_1.getTypeDefinitionFromIdentifier)(astPath, typeName, opt);
// use the same process to exact info
if (definitionPath) {
getSlotsFromLiteralType(documentation, definitionPath);
}
}
}
return false;
}
});
return [2 /*return*/];
});
});
});
function getSlotsFromLiteralType(documentation, members) {
members.each(function (propPath) {
var slotName = propPath.get('key').node.name;
var slotDescriptor = documentation.getSlotDescriptor(slotName);
slotDescriptor.name = slotName;
parseDocBlock(slotDescriptor, propPath);
if (bt.isTSMethodSignature(propPath.node)) {
var p = propPath.get('parameters', 0, 'typeAnnotation', 'typeAnnotation');
if (bt.isTSTypeLiteral(p.node)) {
var bindingDescriptors_1 = [];
p.get('members').each(function (paramPath) {
var _a, _b;
var paramName = (_b = (_a = paramPath.get('key')) === null || _a === void 0 ? void 0 : _a.value) === null || _b === void 0 ? void 0 : _b.name;
var docBlock = (0, getDocblock_1.default)(paramPath);
var jsDoc = docBlock
? (0, getDoclets_1.default)(docBlock)
: { description: '', tags: [] };
bindingDescriptors_1.push({
name: paramName,
title: 'binding',
description: jsDoc.description
});
});
if (bindingDescriptors_1.length) {
slotDescriptor.scoped = true;
slotDescriptor.bindings = bindingDescriptors_1;
}
}
}
});
}
function parseDocBlock(descriptor, path) {
var docBlock = (0, getDocblock_1.default)(path);
var jsDoc = docBlock ? (0, getDoclets_1.default)(docBlock) : { description: '', tags: [] };
var jsDocTags = jsDoc.tags ? jsDoc.tags : [];
if (jsDoc.description) {
descriptor.description = jsDoc.description;
}
if (jsDocTags.length) {
descriptor.tags = (0, transformTagsIntoObject_1.default)(jsDocTags);
}
}