Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
}
// Global = 0, ExternalModule = 1
if (
node.kind === ReflectionKind.Global ||
node.kind === ReflectionKind.ExternalModule
) {
let children = node.children;
if (children && children.length > 0) {
children.forEach(function(child) {
findConstructs(child, files, node);
});
}
} else {
if (
(node.kind === ReflectionKind.Class ||
node.kind === ReflectionKind.Interface ||
node.kind === ReflectionKind.TypeAlias ||
node.kind === ReflectionKind.ObjectLiteral ||
node.kind === ReflectionKind.Module ||
node.kind === ReflectionKind.Variable ||
node.kind === ReflectionKind.Enum ||
node.kind === ReflectionKind.Function) &&
node.flags.isExported &&
files.find(
filePath =>
node.sources != null &&
node.sources[0].fileName.split('/').pop() ===
filePath.split('/').pop()
)
) {
if (parent && parent.kind === ReflectionKind.Module) {
// Set the node name with its parent namespace
}
// Global = 0, ExternalModule = 1
if (
node.kind === ReflectionKind.Global ||
node.kind === ReflectionKind.ExternalModule
) {
let children = node.children;
if (children && children.length > 0) {
children.forEach(function(child) {
findConstructs(child, files, node);
});
}
} else {
if (
(node.kind === ReflectionKind.Class ||
node.kind === ReflectionKind.Interface ||
node.kind === ReflectionKind.TypeAlias ||
node.kind === ReflectionKind.ObjectLiteral ||
node.kind === ReflectionKind.Module ||
node.kind === ReflectionKind.Variable ||
node.kind === ReflectionKind.Enum ||
node.kind === ReflectionKind.Function) &&
node.flags.isExported &&
files.find(
filePath =>
node.sources[0].fileName.split('/').pop() ===
filePath.split('/').pop(),
)
) {
if (parent && parent.kind === ReflectionKind.Module) {
// Set the node name with its parent namespace
node.name = parent ? parent.name + '.' + node.name : node.name;
public read(rootPath: string): Reflections {
const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
const projectReflection = this.typedocApp.convert(expandedFiles);
// console.log(JSON.stringify(this.typedocApp.serializer.projectToObject(projectReflection)));
const externalModules = this.externalModulesWithoutTestsAndMocks(projectReflection);
const classReflections = this.reflections(externalModules, ReflectionKind.Class);
const interfaceReflections = this.reflections(externalModules, ReflectionKind.Interface);
const enumReflections = this.reflections(externalModules, ReflectionKind.Enum);
return {
classReflections,
interfaceReflections,
enumReflections
};
}
node.kind === ReflectionKind.TypeAlias
) {
processMarkdown(node);
this.constructs.push(new TSConstruct(node));
createAnchor(node);
let title = TSHelper.getNodeTitle(node);
this.sections.push({
title: title,
anchor: node.anchorId,
depth: 3,
});
// build sections for children
let children = node.children;
if (
(node.kind === ReflectionKind.Class ||
node.kind === ReflectionKind.Interface ||
node.kind === ReflectionKind.ObjectLiteral ||
node.kind === ReflectionKind.Module ||
node.kind === ReflectionKind.Enum) &&
children &&
children.length > 0
) {
children.forEach((child: Node) => {
if (
child.inheritedFrom ||
child.flags.isPrivate ||
child.flags.isProtected
) {
child.shouldDocument = false;
} else {
// This is needed in UI, good to keep the eligibility logic at one place
child.shouldDocument = true;
node.kind === ReflectionKind.TypeAlias
) {
processMarkdown(node);
this.constructs.push(new TSConstruct(node));
createAnchor(node);
let title = TSHelper.getNodeTitle(node);
this.sections.push({
title: title,
anchor: node.anchorId,
depth: 3,
});
// build sections for children
let children = node.children;
if (
(node.kind === ReflectionKind.Class ||
node.kind === ReflectionKind.Interface ||
node.kind === ReflectionKind.ObjectLiteral ||
node.kind === ReflectionKind.Module ||
node.kind === ReflectionKind.Enum) &&
children &&
children.length > 0
) {
children.forEach((child: Node) => {
if (
child.inheritedFrom ||
child.flags.isPrivate ||
child.flags.isProtected
) {
child.shouldDocument = false;
} else {
// This is needed in UI, good to keep the eligibility logic at one place
child.shouldDocument = true;
export default async function typedoc(config: ITypeDocConfig) {
const packages = await getDocumentablePackages();
const srcPaths = packages.map(name => path.join(PACKAGES_FOLDER, name, "src"));
const project = compileProject(srcPaths);
const interfaces = project.getReflectionsByKind(
ReflectionKind.Interface
) as DeclarationReflection[];
const props = interfaces.filter(intf => /^I.*(?!Default)Props/.test(intf.name));
const classComponents = project.getReflectionsByKind(ReflectionKind.Class);
const functionalComponents = project
.getReflectionsByKind(ReflectionKind.Function)
.filter(({ name }) => /^[A-Z]/.test(name) && !/Wrapper$/.test(name));
const components = classComponents.concat(functionalComponents) as DeclarationReflection[];
console.log("Creating component documentation...");
const tempDir = path.join(process.cwd(), "docs");
await fs.ensureDir(tempDir);
await fs.emptyDir(tempDir);
await Promise.all(
components.map(component => {
function getNavigationGroup(reflection: DeclarationReflection) {
if (reflection.kind === ReflectionKind.ExternalModule) {
return externalModulesNavigation;
}
if (reflection.kind === ReflectionKind.Module) {
return modulesNavigation;
}
if (reflection.kind === ReflectionKind.Class) {
return classesNavigation;
}
if (reflection.kind === ReflectionKind.Enum) {
return enumsNavigation;
}
if (reflection.kind === ReflectionKind.Interface) {
return interfacesNavigation;
}
return null;
}