Generates the CLI long option for a given script and option name.
The name of the script (e.g., 'flowr', 'analyze', etc.)
The name of the option for which to generate the long option string.
OptionalwithAlias: boolean
Whether to include the alias in the output. Default is false.
Optionalquote: boolean
Whether to wrap the option in backticks. Default is true.
Returns the code snippet for a code element as Markdown string.
The element to create a code snippet for, the name can be qualified with :: to specify the class.
Optionalfmt: Omit<FnElementInfo, "info" | "program">
Formatting options for the code snippet (see FnElementInfo)
Optionalfilter: ElementFilter
An optional filter to further specify the element to get the code for, in case multiple elements with the same name exist.
printCodeOfElement - for the underlying impl.
code(exampleFn.name, { dropLinesStart: 1, dropLinesEnd: 2 })
Creates a code snippet for the exampleFn function in the code base,
dropping the first and last two lines of the function definition.
If, for example, the function looks like this:
function exampleFn(a: number, b: number): number {
// This is an example
const result = a + b;
return result;
}
The resulting code snippet will be (auto-gobbled by default):
// This is an example
const result = a + b;
Returns the code snippet for a code file as markdown string.
The path to the file to create a code snippet for.
Optionalfmt: Omit<FnElementInfo, "info" | "program">
Formatting options for the code snippet (see FnElementInfo)
Returns the documentation for a code element as markdown string.
If you want to, e.g., prefix all of these lines with indentation or > for blockquotes,
use prefixLines.
The element to create documentation for, the name can be qualified with :: to specify the class.
Optionalfilter: Omit<ElementFilter, "file">
An optional filter to further specify the element to get the documentation for, in case multiple elements with the same name exist.
Returns the documentation for a member of a class as Markdown string. This is a convenience method around doc.
Optionalfilter: Omit<ElementFilter, "file">Returns the documentation for a type/element definition which is retrieved from an object reference. This is similar to GeneralDocContext#doc, but it uses an object reference to identify the element.
Optionalfilter: Omit<ElementFilter, "file">Generates an auto-generation header for the wiki page.
The name of the file being generated. Probably use module.filename.
The purpose of the file, e.g., 'wiki context for types'.
Returns the hierarchy (e.g., class inheritance) for a code element as markdown string, including their documentation and snippets.
The element to create a hierarchy for, the name can be qualified with :: to specify the class.
Optionalfmt: Omit<PrintHierarchyArguments, "info" | "root" | "program">
Formatting options for the hierarchy (see PrintHierarchyArguments)
Optionalfilter: ElementFilter
An optional filter to further specify the element to get the hierarchy for, in case multiple elements with the same name exist.
printHierarchy - for the underlying impl.
Generate a hyperlink to a code element in the wiki.
If you want to reference the member of a class, use ClassName::MemberName as element name.
For ease of use, you can also call linkM to create a link to a member.
The element to create a link for, the name can be qualified with :: to specify the class.
This causes the link to be usually printed as ClassName::ElementName. If you want to avoid showing
the class name, use ::: as separator. Please note that for elements with a sensible (.name),
you can also pass the function/constructor reference directly (e.g., link(MyClass)).
Optionalfmt: LinkFormat
Formatting options for the link (see LinkFormat)
Optionalfilter: ElementFilter
An optional filter to further specify the element to link to, in case multiple elements with the same name exist.
link(registerPluginMaker.name)
Creates a (markdown) link to the registerPluginMaker function in the code base
and, if available, attaches the TS documentation as tooltip.
By using the .name, the link text will be registerPluginMaker but respect, e.g., renaming refactorings done in the code base.
Generates a link to a code file in the code base.
The path to the code file.
OptionallineNumber: number
An optional line number to link to within the file.
Generates a link to a flowR configuration option, resolving its schema type and description as a hover tooltip.
The .-separated configuration path (autocompletes to valid config keys only).
Optionalquote: boolean
Whether to render the path as inline code. Default is false.
getConfigOption - for the underlying impl.
Generate a hyperlink to an enum member. Enums have no runtime prototype (linkM)
nor name (linkO), so pass the enum type as the explicit type argument -- the
member is then checked against its keys -- together with the enum's name.
Optionalfmt: LinkFormatOptionalfilter: ElementFilterGenerate a hyperlink to a type/element definition in the code base which is displayed using the file path as name
The element to create a link for, the name can be qualified with :: to specify the class.
Generate a hyperlink to a member of a class in the wiki. This is a convenience method around link.
Optionalfmt: LinkFormat & { hideClass?: boolean }Optionalfilter: ElementFilterGenerate a hyperlink to a type/element definition in the code base which is displayed using the type/element name as link text. This is similar to GeneralDocContext#link, but it uses the type/element name as link text, which is especially useful for types with long or complex names.
Optionalfmt: LinkFormatOptionalfilter: ElementFilterGenerates a wiki link to another wiki or general docs page.
The name of the wiki page to link to.
OptionallinkText: string
Optional text to display for the link. If not provided, the page name will be used.
Optionalsegment: string
An optional segment within the page to link to (e.g., a header anchor).
Generates a mermaid diagram for the given code element, returned as markdown string.
The element to create a mermaid diagram for, the name can be qualified with :: to specify the class.
Optionaloptions: MermaidClassDiagramArguments
Formatting options for the mermaid class diagram (see MermaidClassDiagramArguments)
Generates the REPL command string for a given command name.
The name of the REPL command.
Optionalquote: boolean
Whether to wrap the command in backticks. Default is true.
OptionalshowStar: boolean
Whether to show a [*] suffix for starred commands. Default is false.
getReplCommand - for the underlying impl.
Provides methods to generate links, code snippets, and documentation for code elements. These wrap around a collection of useful helpers originating from the doc utils. To create an instance, use makeDocContextForTypes (although if you are writing a wiki, you get such an instance).