Class DocMaker<Target>Abstract
Type Parameters
- Target extends string
Hierarchy (View Summary)
Implements
Hierarchy-Diagram
Index
Constructors
Methods
Constructors
Protectedconstructor
- new DocMaker<Target extends string>(
    target: Target,
    filename: string,
    purpose: string,
    printHeader?: boolean,
): DocMaker<Target>ProtectedCreates a new WikiMaker instance.
Type Parameters
- Target extends string
Parameters
- target: Target
The target path where the wiki file will be generated.
- filename: string
The name of the file being generated. Probably use
module.filename. - purpose: string
The purpose of the file, e.g., 'wiki context for types'.
- printHeader: boolean = true
Whether to print the auto-generation header. Default is
true. Only mark thisfalseif you plan to add it yourself.
Returns DocMaker<Target>
Methods
Protecteddid
- didUpdate(
    path: PathLike,
    newText: string,
    oldText: string | undefined,
): WikiChangeTypeDetermines the type of change between the old and new text.
Parameters
- path: PathLike
- newText: string
- oldText: string | undefined
Returns WikiChangeType
get
Gets the name of the producer of this wiki file.
Returns string
get
Gets the target path where the wiki file will be generated.
Returns Target
get
Gets the set of subfiles written during the last
makecall.Returns Set<string>
make
Generates or updates the wiki file at the given target location.
Parameters
- args: DocMakerArgs & DocMakerOutputArgs
Returns Promise<boolean>
trueif the file was created or updated,falseif it was identical and not changed.
Protectednormalize
Normalizes the given wiki text for comparison.
Parameters
- text: string
Returns string
Protected Abstracttext
Generates the wiki text for the given arguments. The text will be automatically prefixed with metadata including filename and purpose.
Parameters
- args: DocMakerArgs
Returns AsyncOrSync<string>
Protectedwrite
Please note that for subfiles you have to always add your own header
Parameters
- path: PathLike
- data: string
Returns boolean
Settings
Member Visibility
On This Page
- src
- util
- collections
- mermaid
- simple-df
- text
- parallel.ts
- assert.ts
- diff.ts
- diff-graph.ts
- files.ts
- html-hover-over.ts
- json.ts
- log.ts
- logic.ts
- numbers.ts
- objects.ts
- os.ts
- prefix.ts
- quads.ts
- r-author.ts
- r-license.ts
- r-regex.ts
- r-value.ts
- r-version.ts
- random.ts
- range.ts
- schema.ts
- slice-direction.ts
- summarizer.ts
- version.ts
- abstract-interpretation
- data-frame
- domains
- absint-visitor.ts
- normalized-ast-fold.ts
- benchmark
- stats
- summarizer
- first-phase
- second-phase
- data.ts
- summarizer.ts
- slicer.ts
- stopwatch.ts
- cli
- common
- repl
- commands
- parser
- server
- core.ts
- execute.ts
- print-version.ts
- prompt.ts
- script-core
- benchmark-app.ts
- benchmark-helper-app.ts
- export-quads-app.ts
- flowr.ts
- flowr-main-options.ts
- run-script.ts
- slicer-app.ts
- statistics-app.ts
- statistics-helper-app.ts
- summarizer-app.ts
- wiki.ts
- control-flow
- core
- steps
- all
- core
- static-slicing
- pipeline
- create-pipeline.ts
- default-pipelines.ts
- createDataflowPipeline
- createNormalizePipeline
- createParsePipeline
- createSlicePipeline
- DEFAULT_DATAFLOW_PIPELINE
- DEFAULT_NORMALIZE_PIPELINE
- DEFAULT_PARSE_PIPELINE
- DEFAULT_SLICE_AND_RECONSTRUCT_PIPELINE
- DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- DEFAULT_SLICING_PIPELINE
- TREE_SITTER_DATAFLOW_PIPELINE
- TREE_SITTER_NORMALIZE_PIPELINE
- TREE_SITTER_PARSE_PIPELINE
- TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICING_PIPELINE
- invalid-pipeline-error.ts
- pipeline.ts
- pipeline-step.ts
- all
- pipeline-executor.ts
- dataflow
- environments
- eval
- resolve
- values
- intervals
- logical
- scalar
- sets
- string
- vectors
- general.ts
- r-value.ts
- fn
- graph
- call-graph.ts
- dataflowgraph-builder.ts
- df-helper.ts
- diff-dataflow-graph.ts
- edge.ts
- graph.ts
- graph-helper.ts
- quads.ts
- unknown-replacement.ts
- unknown-side-effect.ts
- vertex.ts
- <internal>
- DataflowGraphVertexArgument
- DataflowGraphVertexAstLink
- DataflowGraphVertexFunctionCall
- DataflowGraphVertexFunctionDefinition
- DataflowGraphVertexInfo
- DataflowGraphVertexUse
- DataflowGraphVertexValue
- DataflowGraphVertexVariableDefinition
- DataflowGraphVertices
- FunctionOriginInformation
- isFunctionCallVertex
- isFunctionDefinitionVertex
- isUseVertex
- isValueVertex
- isVariableDefinitionVertex
- ValidVertexTypeReverse
- ValidVertexTypes
- VertexType
- instrument
- internal
- process
- functions
- call
- argument
- built-in
- built-in-access.ts
- built-in-apply.ts
- built-in-assignment.ts
- built-in-eval.ts
- built-in-expression-list.ts
- built-in-for-loop.ts
- built-in-function-definition.ts
- built-in-get.ts
- built-in-if-then-else.ts
- built-in-library.ts
- built-in-list.ts
- built-in-local.ts
- built-in-pipe.ts
- built-in-quote.ts
- built-in-recall.ts
- built-in-register-hook.ts
- built-in-repeat-loop.ts
- built-in-replacement.ts
- built-in-rm.ts
- built-in-s-seven-dispatch.ts
- built-in-s-seven-new-generic.ts
- built-in-s-three-dispatch.ts
- built-in-source.ts
- built-in-special-bin-op.ts
- built-in-stop-if-not.ts
- built-in-try-catch.ts
- built-in-vector.ts
- built-in-while-loop.ts
- common.ts
- default-call-handling.ts
- known-call-handling.ts
- named-call-handling.ts
- unnamed-call-handling.ts
- process-argument.ts
- process-parameter.ts
- call
- process-named-call.ts
- process-symbol.ts
- process-uninteresting-leaf.ts
- process-value.ts
- functions
- linker.ts
- process
- origin
- cluster.ts
- extractor.ts
- hooks.ts
- info.ts
- addNonDefaultExitPoints
- alwaysExits
- ControlDependency
- DataflowCfgInformation
- DataflowInformation
- DataflowInformation
- diffControlDependencies
- diffControlDependency
- doesExitPointPropagateCalls
- ExitPoint
- ExitPointType
- filterOutLoopExitPoints
- happensInEveryBranch
- happensInEveryBranchSet
- negateControlDependency
- overwriteExitPoints
- logger.ts
- processor.ts
- documentation
- data
- dfg
- faq
- interface
- query
- server
- doc-util
- doc-auto-gen.ts
- doc-benchmarks.ts
- doc-cfg.ts
- doc-cli-option.ts
- doc-code.ts
- doc-dfg.ts
- doc-docker.ts
- doc-env.ts
- doc-escape.ts
- doc-files.ts
- doc-functions.ts
- doc-general.ts
- doc-issue.ts
- doc-normalized-ast.ts
- doc-query.ts
- doc-repl.ts
- doc-search.ts
- doc-server-message.ts
- doc-structure.ts
- doc-types.ts
- dropGenericsFromTypeName
- FnElementInfo
- getDocumentationForType
- GetDocumentationForTypeFilters
- getStartLineOfTypeScriptNode
- getTypePathLink
- GetTypesAsMermaidOption
- getTypeScriptSourceFiles
- getTypesFromFolder
- MermaidClassDiagramArguments
- mermaidHide
- printCodeOfElement
- printHierarchy
- PrintHierarchyArguments
- removeCommentSymbolsFromTypeScriptComment
- shortLink
- shortLinkFile
- TypeElementInSource
- TypeElementKind
- TypeReport
- visualizeMermaidClassDiagram
- wiki-mk
- doc-capabilities.ts
- doc-readme.ts
- issue-linting-rule.ts
- wiki-absint.ts
- wiki-analyzer.ts
- wiki-cfg.ts
- wiki-core.ts
- wiki-dataflow-graph.ts
- wiki-engine.ts
- wiki-faq.ts
- wiki-interface.ts
- wiki-linter.ts
- wiki-linting-and-testing.ts
- wiki-normalized-ast.ts
- wiki-onboarding.ts
- wiki-overview.ts
- wiki-query.ts
- wiki-search.ts
- wiki-setup.ts
- data
- linter
- rules
- linter-executor.ts
- linter-format.ts
- linter-rules.ts
- linter-tags.ts
- project
- cache
- context
- plugins
- file-plugins
- files
- notebooks
- flowr-analyzer-description-file-plugin.ts
- flowr-analyzer-file-plugin.ts
- flowr-analyzer-license-file-plugin.ts
- flowr-analyzer-namespace-files-plugin.ts
- flowr-analyzer-news-file-plugin.ts
- flowr-analyzer-test-file-plugin.ts
- flowr-analyzer-vignette-file-plugin.ts
- loading-order-plugins
- package-version-plugins
- project-discovery
- flowr-analyzer-plugin.ts
- flowr-analyzer-plugin-defaults.ts
- plugin-registry.ts
- file-plugins
- cfg-kind.ts
- flowr-analyzer.ts
- flowr-analyzer-builder.ts
- queries
- catalog
- call-context-query
- call-graph-query
- cluster-query
- config-query
- control-flow-query
- dataflow-lens-query
- dataflow-query
- dependencies-query
- df-shape-query
- does-call-query
- files-query
- happens-before-query
- id-map-query
- input-sources-query
- inspect-exceptions-query
- inspect-higher-order-query
- inspect-recursion-query
- linter-query
- location-map-query
- normalized-ast-query
- origin-query
- project-query
- provenance-query
- resolve-value-query
- search-query
- static-slice-query
- virtual-query
- base-query-format.ts
- query.ts
- AnyQuerySchema
- CompoundQuerySchema
- executeQueries
- executeQueriesOfSameType
- genericWrapReplFailIfNoRequest
- ParsedQueryLine
- Queries
- QueriesSchema
- Query
- QueryArgumentsWithType
- QueryExecutor
- QueryResult
- QueryResults
- QueryResultsWithoutMeta
- SupportedQueries
- SupportedQueriesSchema
- SupportedQuery
- SupportedQueryTypes
- VirtualQuerySchema
- query-print.ts
- two-layer-collector.ts
- catalog
- r-bridge
- data
- lang-4.x
- ast
- model
- nodes
- info
- r-access.ts
- r-argument.ts
- r-binary-op.ts
- r-break.ts
- r-comment.ts
- r-expression-list.ts
- r-for-loop.ts
- r-function-call.ts
- r-function-definition.ts
- r-if-then-else.ts
- r-line-directive.ts
- r-logical.ts
- r-next.ts
- r-number.ts
- r-parameter.ts
- r-pipe.ts
- r-project.ts
- r-repeat-loop.ts
- r-string.ts
- r-symbol.ts
- r-unary-op.ts
- r-while-loop.ts
- processing
- model.ts
- operators.ts
- type.ts
- versions.ts
- nodes
- parser
- json
- main
- internal
- control
- expression
- functions
- loops
- operators
- other
- structure
- values
- normalize-access.ts
- normalize-meta.ts
- normalizer-data.ts
- internal
- model
- tree-sitter
- convert-values.ts
- ast
- roxygen2
- documentation-provider.ts
- roxygen-ast.ts
- <internal>
- isKnownRoxygenText
- KnownRoxygenTags
- RoxygenBlock
- RoxygenCrossrefTag
- RoxygenDatasetDocumentationTag
- RoxygenDocType
- RoxygenFormattingTag
- RoxygenFunctionDocumentationTag
- RoxygenNamespaceTag
- RoxygenOtherTag
- RoxygenReusingDocumentationTag
- RoxygenTag
- RoxygenTagAlias
- RoxygenTagAuthor
- RoxygenTagBackref
- RoxygenTagBase
- RoxygenTagConcept
- RoxygenTagDescribeIn
- RoxygenTagDescription
- RoxygenTagDetails
- RoxygenTagEval
- RoxygenTagEvalNamespace
- RoxygenTagEvalRd
- RoxygenTagExample
- RoxygenTagExamples
- RoxygenTagExamplesIf
- RoxygenTagExport
- RoxygenTagExportClass
- RoxygenTagExportMethod
- RoxygenTagExportPattern
- RoxygenTagExportS3Method
- RoxygenTagFamily
- RoxygenTagField
- RoxygenTagFormat
- RoxygenTagImport
- RoxygenTagImportClassesFrom
- RoxygenTagImportFrom
- RoxygenTagImportMethodsFrom
- RoxygenTagIncludeRmd
- RoxygenTagInherit
- RoxygenTagInheritDotParams
- RoxygenTagInheritParams
- RoxygenTagInheritSection
- RoxygenTagKeywords
- RoxygenTagMarkdown
- RoxygenTagMethod
- RoxygenTagName
- RoxygenTagNoMarkdown
- RoxygenTagNoRd
- RoxygenTagOrder
- RoxygenTagParam
- RoxygenTagRawNamespace
- RoxygenTagRawRd
- RoxygenTagRdName
- RoxygenTagReferences
- RoxygenTagReturn
- RoxygenTagSection
- RoxygenTagSeeAlso
- RoxygenTagSlot
- RoxygenTagSource
- RoxygenTagTemplate
- RoxygenTagTemplateVar
- RoxygenTagText
- RoxygenTagTitle
- RoxygenTagUsage
- RoxygenTagUseDynLib
- RoxygenUnknownTag
- roxygen-parse.ts
- init.ts
- parser.ts
- retriever.ts
- shell.ts
- shell-executor.ts
- reconstruct
- search
- search-executor
- search-enrichers.ts
- CallTargetsContent
- CfgInformationArguments
- CfgInformationElementContent
- CfgInformationSearchContent
- enrichElement
- Enrichment
- enrichmentContent
- EnrichmentData
- EnrichmentElementArguments
- EnrichmentElementContent
- Enrichments
- EnrichmentSearchArguments
- EnrichmentSearchContent
- LastCallContent
- QueryDataElementContent
- QueryDataSearchContent
- search-generators.ts
- search-mappers.ts
- search-transformer.ts
- search-enrichers.ts
- search-optimizer
- flowr-search.ts
- flowr-search-builder.ts
- flowr-search-executor.ts
- flowr-search-filters.ts
- flowr-search-printer.ts
- flowr-search-traverse.ts
- search-executor
- slicing
- criterion
- static
- statistics
- features
- supported
- assignments
- comments
- control-flow
- data-access
- defined-functions
- expression-list
- loops
- used-functions
- used-packages
- values
- variables
- common-syntax-probability.ts
- feature.ts
- post-processing.ts
- supported
- output
- summarizer
- first-phase
- post-process
- second-phase
- auto-detect.ts
- summarizer.ts
- meta-statistics.ts
- statistics.ts
- features
- config.ts
- engines.ts
- util
- test
- functionality
- _helper
- controlflow
- dataflow
- ast-builder.ts
- label.ts
- linter.ts
- log.ts
- net.ts
- network.ts
- pointer-analysis.ts
- provider.ts
- query.ts
- repl.ts
- search.ts
- shell.ts
- <internal>
- assertAst
- assertDataflow
- assertDecoratedAst
- assertOutput
- assertReconstructed
- assertSliced
- assertSlicedF
- defaultTestConfiguration
- mapProblematicNodesToIds
- retrieveNormalizedAst
- sameForSteps
- skipTestBecauseConfigNotMet
- TestCaseFailType
- TestConfiguration
- TestConfigurationWithOutput
- testWithShell
- withShell
- withTreeSitter
- _helper
- functionality
Abstract base class for generating wiki files. Please make sure to register your WikiMaker implementation in the CLI wiki tool to have it executed:
src/cli/wiki.ts.If this wiki page produces multiple pages ("sub files"), you can use
writeSubFileinside thetextmethod to write those additional files.