Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | 2x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 12x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 9x 9x 9x 2x 2x 2x 2x 2x | "use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.renderCode = exports.getExample = exports.isPrimitive = exports.isMethodLike = exports.getDocPath = exports.getFName = exports.getNearestName = exports.getTypeNode = exports.getFamilyName = exports.getComments = exports.getJsDocs = exports.getSignatureName = exports.getFullName = exports.getName = exports.isPrivate = void 0;
const ts_morph_1 = require("ts-morph");
const TS_1 = __importDefault(require("./TS"));
const SyntaxKindDelegator_1 = require("./SyntaxKindDelegator");
const SyntaxKindDelegator_types_1 = __importDefault(require("./SyntaxKindDelegator.types"));
const console_log_colors_1 = require("console-log-colors");
const typescript_1 = require("typescript");
const utils_1 = require("./utils");
/**
* Because there isnt a standard way to mark something private.
* @param node
* @returns
*/
const isPrivate = (node) => {
if (!node)
return true; //must be private its so private it doesnt exist.
//check if the node has a private modifier (typescript syntax sugar)
return (ts_morph_1.Node.isModifierable(node) && node.hasModifier(SyntaxKindDelegator_types_1.default.PrivateKeyword))
//check if there is a private tag in jsdocs
|| (ts_morph_1.Node.isJSDocable(node) && node.getJsDocs().some(d => d.getTags().some(t => t.getTagName().toLowerCase() === 'private')));
};
exports.isPrivate = isPrivate;
/**
* Check if a node has getName method
* @param node
* @returns
*/
const hasName = (node) => 'getName' in node
&& typeof node.getName === 'function'
&& !ts_morph_1.Node.isParameterDeclaration(node);
/**
* Get a nodes name if one is available
* @param node
* @returns
*/
const getName = (node) => (node && hasName(node)) ? (0, utils_1.escape)(node.getName())
: '';
exports.getName = getName;
/**
* Gets a / delimited list of names from source to current node
* @param node
* @returns
*/
const getFullName = (node, delim = ".") => {
const family = (0, exports.getFamilyName)(node, delim);
return [family, (0, exports.getName)(node)].filter(a => a).join(delim);
};
exports.getFullName = getFullName;
/**
* Gets the signature of a declaration.
* @param node
* @param delim
* @returns
*/
const getSignatureName = (node, delim = ".") => {
const family = (0, exports.getFamilyName)(node, delim);
return `${[family, (0, exports.getName)(node)].filter(a => a).join(delim)}`;
};
exports.getSignatureName = getSignatureName;
const getJsDocs = (node) => ts_morph_1.Node.isJSDocable(node) ? node.getJsDocs() : [];
exports.getJsDocs = getJsDocs;
const getComments = (node) => (ts_morph_1.Node.isJSDocable(node) ? node.getJsDocs() : []).map(j => j.getComment()).join('\n') + '\n';
exports.getComments = getComments;
/**
* Converts the ancestors into a family name.
* @param node
* @returns
*/
const getFamilyName = (node, delim = ".") => node.getAncestors().map(a => (0, exports.getName)(a)).filter(a => a).reverse().join(delim);
exports.getFamilyName = getFamilyName;
const ModMap = {
[SyntaxKindDelegator_types_1.default.TypeAliasDeclaration]: (node) => [node.getName(), '', []],
[SyntaxKindDelegator_types_1.default.PropertySignature]: (node, df) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node.getParent(), ModMap, df);
return [pre + '.' + node.getName(), post, []];
},
[SyntaxKindDelegator_types_1.default.TypeLiteral]: (node, df) => {
const parent = node.getParent();
const [pre, post, children] = (0, SyntaxKindDelegator_1.bySyntax)(parent, ModMap, df);
return [pre + (children.length > 1 ? '.' + children.findIndex(c => c === node) : ''), post, []];
},
[SyntaxKindDelegator_types_1.default.UnionType]: (node, df) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node.getParent(), ModMap, df);
return [pre, post, node.getTypeNodes()];
},
[SyntaxKindDelegator_types_1.default.TypeParameter]: (node, df) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node.getParent(), ModMap, df);
return [pre + '.' + node.getName(), post, []];
},
[SyntaxKindDelegator_types_1.default.Parameter]: (node, df) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node.getParent(), ModMap, df);
return [pre + '.' + node.getName(), post, []];
},
[SyntaxKindDelegator_types_1.default.FunctionType]: (node, df) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node.getParent(), ModMap, df);
return [pre, post, []];
}
};
const getTypeNode = (node) => ts_morph_1.Node.isTyped(node) ? node.getTypeNode()
//: (Node.isInitializerExpressionGetable(node) || Node.isInitializerExpressionable(node)) ? node.getInitializer()
: undefined;
exports.getTypeNode = getTypeNode;
/**
* In some cases the named node is the parent node of the evaluated node this just climbs the node tree until it finds a name
* @param node
*/
const getNearestName = (node) => {
let name = (0, exports.getName)(node);
while (node && !name) {
node = node.getParent();
name = (0, exports.getName)(node);
}
return name;
};
exports.getNearestName = getNearestName;
const getFName = (node) => {
const [pre, post] = (0, SyntaxKindDelegator_1.bySyntax)(node, ModMap, n => {
if (!n)
return ['', '', []];
TS_1.default.warn((0, console_log_colors_1.cyan)(n.getKindName()));
return ['', '', []];
});
const nm = pre + post;
if (nm) {
TS_1.default.success("FName", (0, console_log_colors_1.green)(nm));
return nm;
}
return (0, exports.getFullName)(node);
};
exports.getFName = getFName;
/**
* Gets the source of the node and returns a storybook formatted link to the documentation of said node if the node exists within the scope provided by the entry point.
* @param node
*/
const getDocPath = (node) => {
const src = node.getSourceFile().getFilePath();
const ref = TS_1.default.resolveUrl(src);
Eif (!ref)
return;
const fn = (0, exports.getFullName)(node, '');
return TS_1.default.resolveDocPath(ref) + (fn ? '#' + fn.toLowerCase() : '');
};
exports.getDocPath = getDocPath;
const isMethodLike = (node) => {
if (!node)
return false;
const k = node.getKind();
return new Set([
SyntaxKindDelegator_types_1.default.MethodSignature,
SyntaxKindDelegator_types_1.default.MethodDeclaration,
SyntaxKindDelegator_types_1.default.FunctionType
]).has(k);
};
exports.isMethodLike = isMethodLike;
/**
* Checks to see if the Node is primitive
*
* update: using Kind value is simpler response as I am not confirming a specific type.
* @param node
* @returns
*/
const isPrimitive = (node) => {
Iif (!node)
return false;
const k = node.getKind();
return new Set([
SyntaxKindDelegator_types_1.default.AnyKeyword,
SyntaxKindDelegator_types_1.default.StringKeyword,
SyntaxKindDelegator_types_1.default.StringLiteral,
SyntaxKindDelegator_types_1.default.NumberKeyword,
SyntaxKindDelegator_types_1.default.NumericLiteral,
SyntaxKindDelegator_types_1.default.BooleanKeyword,
SyntaxKindDelegator_types_1.default.TrueKeyword,
SyntaxKindDelegator_types_1.default.FalseKeyword,
SyntaxKindDelegator_types_1.default.BigIntKeyword,
SyntaxKindDelegator_types_1.default.BigIntLiteral,
SyntaxKindDelegator_types_1.default.LiteralType,
SyntaxKindDelegator_types_1.default.NullKeyword,
SyntaxKindDelegator_types_1.default.NeverKeyword,
SyntaxKindDelegator_types_1.default.VoidKeyword,
SyntaxKindDelegator_types_1.default.UndefinedKeyword,
SyntaxKindDelegator_types_1.default.UnknownKeyword,
SyntaxKindDelegator_types_1.default.ExportAssignment, //Just to ignore the warning it wont be used at this stage.
SyntaxKindDelegator_types_1.default.ImportDeclaration
]).has(k);
};
exports.isPrimitive = isPrimitive;
const getExample = (node) => {
const examples = (0, exports.getJsDocs)(node).flatMap(d => d.getTags().filter(t => t.getTagName() === "example").map(t => t.getComment()));
return examples.map(exports.renderCode).join('\n');
};
exports.getExample = getExample;
const renderCode = (code) => code ? `\`\`\`ts\n${(0, typescript_1.createPrinter)({ removeComments: false }).printFile((0, typescript_1.createSourceFile)("t.ts", code, typescript_1.ScriptTarget.Latest, false, typescript_1.ScriptKind.TS))}\n\`\`\`` : '';
exports.renderCode = renderCode;
|