docs-util: fix helper step settings (#10045)
This commit is contained in:
+3
@@ -45,6 +45,9 @@ const helperStepsOptions: FormattingOptionsType = {
|
|||||||
typeParameters: false,
|
typeParameters: false,
|
||||||
suffix: "- Helper Steps API Reference",
|
suffix: "- Helper Steps API Reference",
|
||||||
},
|
},
|
||||||
|
reflectionGroups: {
|
||||||
|
"Type Parameters": false,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -75,6 +75,7 @@ import workflowOutputHelper from "./resources/helpers/workflow-output"
|
|||||||
import workflowDiagramHelper from "./resources/helpers/workflow-diagram"
|
import workflowDiagramHelper from "./resources/helpers/workflow-diagram"
|
||||||
import workflowHooksHelper from "./resources/helpers/workflow-hooks"
|
import workflowHooksHelper from "./resources/helpers/workflow-hooks"
|
||||||
import ifMemberShowTitleHelper from "./resources/helpers/if-member-show-title"
|
import ifMemberShowTitleHelper from "./resources/helpers/if-member-show-title"
|
||||||
|
import signatureCommentHelper from "./resources/helpers/signature-comment"
|
||||||
import { MarkdownTheme } from "./theme"
|
import { MarkdownTheme } from "./theme"
|
||||||
|
|
||||||
const TEMPLATE_PATH = path.join(__dirname, "resources", "templates")
|
const TEMPLATE_PATH = path.join(__dirname, "resources", "templates")
|
||||||
@@ -178,4 +179,5 @@ export function registerHelpers(theme: MarkdownTheme) {
|
|||||||
workflowDiagramHelper(theme)
|
workflowDiagramHelper(theme)
|
||||||
workflowHooksHelper(theme)
|
workflowHooksHelper(theme)
|
||||||
ifMemberShowTitleHelper(theme)
|
ifMemberShowTitleHelper(theme)
|
||||||
|
signatureCommentHelper()
|
||||||
}
|
}
|
||||||
|
|||||||
+14
@@ -0,0 +1,14 @@
|
|||||||
|
import * as Handlebars from "handlebars"
|
||||||
|
import { SignatureReflection } from "typedoc"
|
||||||
|
|
||||||
|
export default function () {
|
||||||
|
Handlebars.registerHelper(
|
||||||
|
"signatureComment",
|
||||||
|
function (this: SignatureReflection) {
|
||||||
|
if (!this.comment && !this.parent.comment) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return Handlebars.helpers.comments(this.comment || this.parent.comment)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
+1
-1
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
{{#if (sectionEnabled "member_signature_comment")}}
|
{{#if (sectionEnabled "member_signature_comment")}}
|
||||||
|
|
||||||
{{> comment}}
|
{{{signatureComment}}}
|
||||||
|
|
||||||
{{/if}}
|
{{/if}}
|
||||||
|
|
||||||
|
|||||||
@@ -3,9 +3,16 @@ import { ArrayType, SignatureReflection, SomeType, UnionType } from "typedoc"
|
|||||||
const disallowedIntrinsicTypeNames = ["unknown", "void", "any", "never"]
|
const disallowedIntrinsicTypeNames = ["unknown", "void", "any", "never"]
|
||||||
|
|
||||||
export function isWorkflowStep(reflection: SignatureReflection): boolean {
|
export function isWorkflowStep(reflection: SignatureReflection): boolean {
|
||||||
return (
|
if (reflection.parent?.children?.some((child) => child.name === "__step__")) {
|
||||||
reflection.parent?.children?.some((child) => child.name === "__step__") ||
|
return true
|
||||||
false
|
}
|
||||||
|
if (reflection.type?.type !== "intersection") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return reflection.type.types.some(
|
||||||
|
(refType) =>
|
||||||
|
refType.type === "reference" &&
|
||||||
|
refType.name === "StepFunctionReturnConfig"
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user